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

#include <itkShiftScaleInPlaceImageFilter.h>

Inheritance diagram for itk::ShiftScaleInPlaceImageFilter< TInputImage >:

Collaboration diagram for itk::ShiftScaleInPlaceImageFilter< TInputImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::IndexType	InputImageIndexType
typedef TInputImage::OffsetType	InputImageOffsetType
typedef TInputImage::PixelType	InputImagePixelType
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::SizeType	InputImageSizeType
typedef TInputImage::IndexType	OutputImageIndexType
typedef TInputImage::OffsetType	OutputImageOffsetType
typedef TInputImage::PixelType	OutputImagePixelType
typedef TInputImage::Pointer	OutputImagePointer
typedef TInputImage::RegionType	OutputImageRegionType
typedef TInputImage::SizeType	OutputImageSizeType
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < OutputImagePixelType > ::RealType	RealType
typedef ShiftScaleInPlaceImageFilter	Self
typedef InPlaceImageFilter < TInputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::AdditiveOperators< InputImagePixelType, RealType, RealType >) InputPlusRealTypeCheck
	typedef (Concept::HasNumericTraits< InputImagePixelType >) InputHasNumericTraitsCheck
	typedef (Concept::MultiplyOperator< RealType >) RealTypeMultiplyOperatorCheck

virtual void	SetShift (RealType _arg)
virtual RealType	GetShift () const

virtual void	SetScale (RealType _arg)
virtual RealType	GetScale () const

virtual long	GetUnderflowCount () const
virtual long	GetOverflowCount () const
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Protected Member Functions
void	AfterThreadedGenerateData ()
void	BeforeThreadedGenerateData ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

	ShiftScaleInPlaceImageFilter ()
	~ShiftScaleInPlaceImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
Private Member Functions
void	operator= (const Self &)
	ShiftScaleInPlaceImageFilter (const Self &)
Private Attributes
long	m_OverflowCount
RealType	m_Scale
RealType	m_Shift
Array< long >	m_ThreadOverflow
Array< long >	m_ThreadUnderflow
long	m_UnderflowCount

Detailed Description

template<class TInputImage>
class itk::ShiftScaleInPlaceImageFilter< TInputImage >

Shift and scale the pixels in an image.

ShiftScaleInPlaceImageFilter 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 precison 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.

ShiftScaleInPlaceImageFilter overwrites the input image to form the output image. If you do not want the input data destroyed, use the ShiftScaleImageFilter instead.

See also:: ShiftScaleImageFilter; InPlaceImageFilter

Definition at line 46 of file itkShiftScaleInPlaceImageFilter.h.

Member Typedef Documentation

template<class TInputImage >

typedef SmartPointer< const Self > itk::ShiftScaleInPlaceImageFilter< TInputImage >::ConstPointer

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 54 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::IndexType itk::ShiftScaleInPlaceImageFilter< TInputImage >::InputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 72 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::OffsetType itk::ShiftScaleInPlaceImageFilter< TInputImage >::InputImageOffsetType

Definition at line 74 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::PixelType itk::ShiftScaleInPlaceImageFilter< TInputImage >::InputImagePixelType

Typedef to describe the type of pixel.

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 68 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::Pointer itk::ShiftScaleInPlaceImageFilter< TInputImage >::InputImagePointer

Typedef to describe the pointer to the input/output.

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 64 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::RegionType itk::ShiftScaleInPlaceImageFilter< TInputImage >::InputImageRegionType

Typedef to describe the output and input image region types.

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 57 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::SizeType itk::ShiftScaleInPlaceImageFilter< TInputImage >::InputImageSizeType

Definition at line 73 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::IndexType itk::ShiftScaleInPlaceImageFilter< TInputImage >::OutputImageIndexType

Definition at line 75 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::OffsetType itk::ShiftScaleInPlaceImageFilter< TInputImage >::OutputImageOffsetType

Definition at line 77 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::PixelType itk::ShiftScaleInPlaceImageFilter< TInputImage >::OutputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 69 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::Pointer itk::ShiftScaleInPlaceImageFilter< TInputImage >::OutputImagePointer

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 65 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::RegionType itk::ShiftScaleInPlaceImageFilter< TInputImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 61 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef TInputImage::SizeType itk::ShiftScaleInPlaceImageFilter< TInputImage >::OutputImageSizeType

Definition at line 76 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef SmartPointer< Self > itk::ShiftScaleInPlaceImageFilter< TInputImage >::Pointer

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 53 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef NumericTraits< OutputImagePixelType >::RealType itk::ShiftScaleInPlaceImageFilter< TInputImage >::RealType

Type to use form computations.

Definition at line 80 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef ShiftScaleInPlaceImageFilter itk::ShiftScaleInPlaceImageFilter< TInputImage >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 51 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

typedef InPlaceImageFilter< TInputImage > itk::ShiftScaleInPlaceImageFilter< TInputImage >::Superclass

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

Definition at line 52 of file itkShiftScaleInPlaceImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage >

itk::ShiftScaleInPlaceImageFilter< TInputImage >::ShiftScaleInPlaceImageFilter ( ) [protected]

End concept checking

template<class TInputImage >

itk::ShiftScaleInPlaceImageFilter< TInputImage >::~ShiftScaleInPlaceImageFilter ( ) [protected]

End concept checking

template<class TInputImage >

itk::ShiftScaleInPlaceImageFilter< TInputImage >::ShiftScaleInPlaceImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TInputImage >

void itk::ShiftScaleInPlaceImageFilter< TInputImage >::AfterThreadedGenerateData ( ) [protected, virtual]

Tally data accumulated in threads.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage >

void itk::ShiftScaleInPlaceImageFilter< TInputImage >::BeforeThreadedGenerateData ( ) [protected, virtual]

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage >

virtual::itk::LightObject::Pointer itk::ShiftScaleInPlaceImageFilter< TInputImage >::CreateAnother ( void ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage >

virtual const char* itk::ShiftScaleInPlaceImageFilter< TInputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

template<class TInputImage >

virtual long itk::ShiftScaleInPlaceImageFilter< TInputImage >::GetOverflowCount ( ) const [virtual]

Get the number of pixels that underflowed and overflowed.

template<class TInputImage >

virtual RealType itk::ShiftScaleInPlaceImageFilter< TInputImage >::GetScale ( ) const [virtual]

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

template<class TInputImage >

virtual RealType itk::ShiftScaleInPlaceImageFilter< TInputImage >::GetShift ( ) const [virtual]

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

template<class TInputImage >

virtual long itk::ShiftScaleInPlaceImageFilter< TInputImage >::GetUnderflowCount ( ) const [virtual]

Get the number of pixels that underflowed and overflowed.

template<class TInputImage >

static Pointer itk::ShiftScaleInPlaceImageFilter< TInputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage >

void itk::ShiftScaleInPlaceImageFilter< TInputImage >::operator= ( const Self & ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

template<class TInputImage >

void itk::ShiftScaleInPlaceImageFilter< TInputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

End concept checking

Reimplemented from itk::InPlaceImageFilter< TInputImage >.

template<class TInputImage >

virtual void itk::ShiftScaleInPlaceImageFilter< TInputImage >::SetScale ( RealType _arg ) [virtual]

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

template<class TInputImage >

virtual void itk::ShiftScaleInPlaceImageFilter< TInputImage >::SetShift ( RealType _arg ) [virtual]

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

template<class TInputImage >

void itk::ShiftScaleInPlaceImageFilter< TInputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		`[protected]`

Multi-thread version GenerateData.

template<class TInputImage >

itk::ShiftScaleInPlaceImageFilter< TInputImage >::typedef ( Concept::HasNumericTraits< InputImagePixelType > )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< InputImagePixelType > )

template<class TInputImage >

itk::ShiftScaleInPlaceImageFilter< TInputImage >::typedef ( Concept::MultiplyOperator< RealType > )

This class requires RealTypeMultiplyOperatorCheck in the form of ( Concept::MultiplyOperator< RealType > )

template<class TInputImage >

itk::ShiftScaleInPlaceImageFilter< TInputImage >::typedef ( Concept::AdditiveOperators< InputImagePixelType, RealType, RealType > )

This class requires InputPlusRealTypeCheck in the form of ( Concept::AdditiveOperators< InputImagePixelType, RealType, RealType > )

Member Data Documentation

template<class TInputImage >

const unsigned int itk::ShiftScaleInPlaceImageFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension [static]

Image related typedefs.

Definition at line 84 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

long itk::ShiftScaleInPlaceImageFilter< TInputImage >::m_OverflowCount [private]

Definition at line 142 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

RealType itk::ShiftScaleInPlaceImageFilter< TInputImage >::m_Scale [private]

Definition at line 139 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

RealType itk::ShiftScaleInPlaceImageFilter< TInputImage >::m_Shift [private]

Definition at line 138 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

Array< long > itk::ShiftScaleInPlaceImageFilter< TInputImage >::m_ThreadOverflow [private]

Definition at line 145 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

Array< long > itk::ShiftScaleInPlaceImageFilter< TInputImage >::m_ThreadUnderflow [private]

Definition at line 144 of file itkShiftScaleInPlaceImageFilter.h.

template<class TInputImage >

long itk::ShiftScaleInPlaceImageFilter< TInputImage >::m_UnderflowCount [private]

Definition at line 141 of file itkShiftScaleInPlaceImageFilter.h.

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

itkShiftScaleInPlaceImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<class TInputImage> class itk::ShiftScaleInPlaceImageFilter< TInputImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage>
class itk::ShiftScaleInPlaceImageFilter< TInputImage >