ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::ShiftScaleImageFilter< TInputImage, TOutputImage > Class Template Reference
Intensity Image Filters | Module ITKImageIntensity

#include <itkShiftScaleImageFilter.h>

+ Inheritance diagram for itk::ShiftScaleImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::ShiftScaleImageFilter< TInputImage, TOutputImage >:

List of all members.

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 TOutputImage::IndexType OutputImageIndexType
typedef TOutputImage::OffsetType OutputImageOffsetType
typedef TOutputImage::PixelType OutputImagePixelType
typedef TOutputImage::Pointer OutputImagePointer
typedef TOutputImage::RegionType OutputImageRegionType
typedef TOutputImage::SizeType OutputImageSizeType
typedef SmartPointer< Self > Pointer
typedef NumericTraits
< OutputImagePixelType >
::RealType 		RealType
typedef ShiftScaleImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
 typedef (Concept::HasNumericTraits< OutputImagePixelType >) OutputHasNumericTraitsCheck
 typedef (Concept::AdditiveOperators< InputImagePixelType, RealType, RealType >) InputPlusRealTypeCheck
 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)
 ShiftScaleImageFilter ()
 ~ShiftScaleImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Private Member Functions

void operator= (const Self &)
 ShiftScaleImageFilter (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 TOutputImage>
class itk::ShiftScaleImageFilter< TInputImage, TOutputImage >

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

Definition at line 39 of file itkShiftScaleImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef SmartPointer< const Self > itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 47 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::IndexType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::InputImageIndexType

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

Definition at line 65 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::OffsetType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::InputImageOffsetType

Definition at line 67 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::PixelType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Typedef to describe the type of pixel.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 61 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::Pointer itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::InputImagePointer

Typedef to describe the pointer to the input/output.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 57 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::RegionType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Typedef to describe the output and input image region types.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 50 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::SizeType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Definition at line 66 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::IndexType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Definition at line 68 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::OffsetType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::OutputImageOffsetType

Definition at line 70 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::PixelType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::Pointer itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 58 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::RegionType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 54 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::SizeType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Definition at line 69 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef SmartPointer< Self > itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 46 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef NumericTraits< OutputImagePixelType >::RealType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::RealType

Type to use form computations.

Definition at line 73 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef ShiftScaleImageFilter itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 44 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 45 of file itkShiftScaleImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::ShiftScaleImageFilter ( ) [protected]

End concept checking

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::~ShiftScaleImageFilter ( ) [protected]

End concept checking

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::ShiftScaleImageFilter ( const Self &  ) [private]

Member Function Documentation

template<class TInputImage, class TOutputImage>
void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( ) [protected, virtual]

Tally accumulated in threads.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>
void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( ) [protected, virtual]

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual::itk::LightObject::Pointer itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::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, class TOutputImage>
virtual const char* itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual long itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::GetOverflowCount ( ) const [virtual]

Get the number of pixels that underflowed and overflowed.

template<class TInputImage, class TOutputImage>
virtual RealType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::GetScale ( ) const [virtual]

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

template<class TInputImage, class TOutputImage>
virtual RealType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::GetShift ( ) const [virtual]

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

template<class TInputImage, class TOutputImage>
virtual long itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::GetUnderflowCount ( ) const [virtual]

Get the number of pixels that underflowed and overflowed.

template<class TInputImage, class TOutputImage>
static Pointer itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage>
void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

End concept checking

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::SetScale ( RealType  _arg) [virtual]

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

template<class TInputImage, class TOutputImage>
virtual void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::SetShift ( RealType  _arg) [virtual]

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

template<class TInputImage, class TOutputImage>
void itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< OutputImagePixelType >  )

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

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::typedef ( Concept::AdditiveOperators< InputImagePixelType, RealType, RealType >  )

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

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::typedef ( Concept::MultiplyOperator< RealType >  )

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

Member Data Documentation

template<class TInputImage, class TOutputImage>
const unsigned int itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

Image related typedefs.

Definition at line 77 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
long itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::m_OverflowCount [private]

Definition at line 135 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
RealType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::m_Scale [private]

Definition at line 132 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
RealType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::m_Shift [private]

Definition at line 131 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
Array< long > itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::m_ThreadOverflow [private]

Definition at line 138 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
Array< long > itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::m_ThreadUnderflow [private]

Definition at line 137 of file itkShiftScaleImageFilter.h.

template<class TInputImage, class TOutputImage>
long itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::m_UnderflowCount [private]

Definition at line 134 of file itkShiftScaleImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 01:37:49 for ITK by doxygen 1.7.6.1