Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::ShiftScaleImageFilter< TInputImage, TOutputImage > Class Template Reference
[Intensity Image Filters]

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

#include <itkShiftScaleImageFilter.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::ShiftScaleImageFilter< TInputImage, TOutputImage >:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

Public Types

typedef ShiftScaleImageFilter Self
typedef ImageToImageFilter<
TInputImage, TOutputImage > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TInputImage::RegionType InputImageRegionType
typedef TOutputImage::RegionType OutputImageRegionType
typedef TInputImage::Pointer InputImagePointer
typedef TOutputImage::Pointer OutputImagePointer
typedef TInputImage::PixelType InputImagePixelType
typedef TOutputImage::PixelType OutputImagePixelType
typedef TInputImage::IndexType InputImageIndexType
typedef TInputImage::SizeType InputImageSizeType
typedef TInputImage::OffsetType InputImageOffsetType
typedef TOutputImage::IndexType OutputImageIndexType
typedef TOutputImage::SizeType OutputImageSizeType
typedef TOutputImage::OffsetType OutputImageOffsetType
typedef NumericTraits< OutputImagePixelType
>::RealType 
RealType

Public Member Functions

 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual const char * GetNameOfClass () const
virtual void SetShift (RealType _arg)
virtual RealType GetShift ()
virtual void SetScale (RealType _arg)
virtual RealType GetScale ()
virtual long GetUnderflowCount ()
virtual long GetOverflowCount ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 ShiftScaleImageFilter ()
 ~ShiftScaleImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void BeforeThreadedGenerateData ()
void AfterThreadedGenerateData ()

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 38 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 46 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 64 of file itkShiftScaleImageFilter.h.

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

Definition at line 66 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 60 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 56 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 52 of file itkShiftScaleImageFilter.h.

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

Definition at line 65 of file itkShiftScaleImageFilter.h.

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

Definition at line 67 of file itkShiftScaleImageFilter.h.

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

Definition at line 69 of file itkShiftScaleImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 61 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 57 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 53 of file itkShiftScaleImageFilter.h.

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

Definition at line 68 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 45 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 72 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 43 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 44 of file itkShiftScaleImageFilter.h.


Constructor & Destructor Documentation

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

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


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 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  )  [virtual]
 

Get the number of pixels that underflowed and overflowed.

template<class TInputImage, class TOutputImage>
virtual RealType itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::GetScale  )  [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  )  [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  )  [virtual]
 

Get the number of pixels that underflowed and overflowed.

template<class TInputImage, class TOutputImage>
itk::ShiftScaleImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ImageDimension  ,
unsigned  int,
TInputImage::ImageDimension 
 

Image related typedefs.

template<class TInputImage, class TOutputImage>
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 >::PrintSelf std::ostream &  os,
Indent  indent
const [protected, virtual]
 

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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,
int  threadId
[protected, virtual]
 

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.


The documentation for this class was generated from the following file:
Generated at Thu May 25 02:19:45 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000