SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ShiftScaleImageFilter Class Reference

Shift and scale the pixels in an image. More...

#include <sitkShiftScaleImageFilter.h>

+ Inheritance diagram for itk::simple::ShiftScaleImageFilter:
+ Collaboration diagram for itk::simple::ShiftScaleImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = ShiftScaleImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
std::string GetName () const
 
int64_t GetOverflowCount () const
 
double GetScale () const
 
double GetShift () const
 
int64_t GetUnderflowCount () const
 
SelfSetScale (double Scale)
 
SelfSetShift (double Shift)
 
 ShiftScaleImageFilter ()
 
std::string ToString () const
 
virtual ~ShiftScaleImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 
template<class TImageType >
Image ExecuteInternalVectorImage (const Image &image)
 

Private Attributes

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
int64_t m_OverflowCount {0u}
 
double m_Scale {1.0}
 
double m_Shift {0}
 
int64_t m_UnderflowCount {0u}
 

Friends

struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >
 
struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Shift and scale the pixels in an image.

ShiftScaleImageFilter shifts the input pixel by Shift (default 0.0) and then scales the pixel by Scale (default 1.0). All computations are performed in the precision of the input pixel's RealType. Before assigning the computed value to the output pixel, the value is clamped at the NonpositiveMin and max of the pixel type.

See also
itk::simple::ShiftScale for the procedural interface
itk::ShiftScaleImageFilter for the Doxygen on the original ITK class.

Definition at line 42 of file sitkShiftScaleImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::ShiftScaleImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )
private

Setup for member function dispatching

Definition at line 108 of file sitkShiftScaleImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 54 of file sitkShiftScaleImageFilter.h.

◆ Self

Definition at line 44 of file sitkShiftScaleImageFilter.h.

Constructor & Destructor Documentation

◆ ~ShiftScaleImageFilter()

virtual itk::simple::ShiftScaleImageFilter::~ShiftScaleImageFilter ( )
virtual

Destructor

◆ ShiftScaleImageFilter()

itk::simple::ShiftScaleImageFilter::ShiftScaleImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::ShiftScaleImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::ShiftScaleImageFilter::ExecuteInternal ( const Image image1)
private

◆ ExecuteInternalVectorImage()

template<class TImageType >
Image itk::simple::ShiftScaleImageFilter::ExecuteInternalVectorImage ( const Image image)
private

Dispatched methods which calls ExecuteInteral on each component

◆ GetName()

std::string itk::simple::ShiftScaleImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 94 of file sitkShiftScaleImageFilter.h.

◆ GetOverflowCount()

int64_t itk::simple::ShiftScaleImageFilter::GetOverflowCount ( ) const
inline

Get the number of pixels that underflowed and overflowed.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 90 of file sitkShiftScaleImageFilter.h.

◆ GetScale()

double itk::simple::ShiftScaleImageFilter::GetScale ( ) const
inline

Set/Get the amount to Scale each Pixel. The Scale is applied after the Shift.

Definition at line 75 of file sitkShiftScaleImageFilter.h.

◆ GetShift()

double itk::simple::ShiftScaleImageFilter::GetShift ( ) const
inline

Set/Get the amount to Shift each Pixel. The shift is followed by a Scale.

Definition at line 65 of file sitkShiftScaleImageFilter.h.

◆ GetUnderflowCount()

int64_t itk::simple::ShiftScaleImageFilter::GetUnderflowCount ( ) const
inline

Get the number of pixels that underflowed and overflowed.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 82 of file sitkShiftScaleImageFilter.h.

◆ SetScale()

Self& itk::simple::ShiftScaleImageFilter::SetScale ( double  Scale)
inline

Set/Get the amount to Scale each Pixel. The Scale is applied after the Shift.

Definition at line 70 of file sitkShiftScaleImageFilter.h.

◆ SetShift()

Self& itk::simple::ShiftScaleImageFilter::SetShift ( double  Shift)
inline

Set/Get the amount to Shift each Pixel. The shift is followed by a Scale.

Definition at line 60 of file sitkShiftScaleImageFilter.h.

◆ ToString()

std::string itk::simple::ShiftScaleImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

Definition at line 114 of file sitkShiftScaleImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 113 of file sitkShiftScaleImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ShiftScaleImageFilter::m_MemberFactory
private

Definition at line 115 of file sitkShiftScaleImageFilter.h.

◆ m_OverflowCount

int64_t itk::simple::ShiftScaleImageFilter::m_OverflowCount {0u}
private

Definition at line 125 of file sitkShiftScaleImageFilter.h.

◆ m_Scale

double itk::simple::ShiftScaleImageFilter::m_Scale {1.0}
private

Definition at line 120 of file sitkShiftScaleImageFilter.h.

◆ m_Shift

double itk::simple::ShiftScaleImageFilter::m_Shift {0}
private

Definition at line 118 of file sitkShiftScaleImageFilter.h.

◆ m_UnderflowCount

int64_t itk::simple::ShiftScaleImageFilter::m_UnderflowCount {0u}
private

Definition at line 123 of file sitkShiftScaleImageFilter.h.


The documentation for this class was generated from the following file: