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
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef ShiftScaleImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, double shift, double scale)
std::string	GetName () const
int64_t	GetOverflowCount () const
double	GetScale () const
double	GetShift () const
int64_t	GetUnderflowCount () const
Self &	SetScale (double Scale)
Self &	SetShift (double Shift)
	ShiftScaleImageFilter ()
std::string	ToString () const
virtual	~ShiftScaleImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
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

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

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

Private Attributes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
int64_t	m_OverflowCount
double	m_Scale
double	m_Shift
int64_t	m_UnderflowCount

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
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...
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)
static const itk::EventObject &	GetITKEventObject (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 computattions 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

typedef Image(Self::* itk::simple::ShiftScaleImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 111 of file sitkShiftScaleImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::ShiftScaleImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 54 of file sitkShiftScaleImageFilter.h.

typedef ShiftScaleImageFilter itk::simple::ShiftScaleImageFilter::Self

Definition at line 44 of file sitkShiftScaleImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::ShiftScaleImageFilter::ShiftScaleImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::ShiftScaleImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::ShiftScaleImageFilter::Execute	(	const Image &	image1,
		double	shift,
		double	scale
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::ShiftScaleImageFilter::ExecuteInternal ( const Image &  image1 )

private

template<class TImageType >

Image itk::simple::ShiftScaleImageFilter::ExecuteInternalVectorImage ( const Image &  image )

private

Dispatched methods which calls ExecuteInteral on each component

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 94 of file sitkShiftScaleImageFilter.h.

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 91 of file sitkShiftScaleImageFilter.h.

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 76 of file sitkShiftScaleImageFilter.h.

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 66 of file sitkShiftScaleImageFilter.h.

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 83 of file sitkShiftScaleImageFilter.h.

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 71 of file sitkShiftScaleImageFilter.h.

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 61 of file sitkShiftScaleImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

friend

Definition at line 117 of file sitkShiftScaleImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 116 of file sitkShiftScaleImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ShiftScaleImageFilter::m_MemberFactory

private

Definition at line 118 of file sitkShiftScaleImageFilter.h.

int64_t itk::simple::ShiftScaleImageFilter::m_OverflowCount

private

Definition at line 126 of file sitkShiftScaleImageFilter.h.

double itk::simple::ShiftScaleImageFilter::m_Scale

private

Definition at line 122 of file sitkShiftScaleImageFilter.h.

double itk::simple::ShiftScaleImageFilter::m_Shift

private

Definition at line 121 of file sitkShiftScaleImageFilter.h.

int64_t itk::simple::ShiftScaleImageFilter::m_UnderflowCount

private

Definition at line 124 of file sitkShiftScaleImageFilter.h.

---

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

• sitkShiftScaleImageFilter.h