itk::ShiftScaleInPlaceImageFilter< TInputImage > Class Template Reference
[Intensity Image Filters]

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

#include <itkShiftScaleInPlaceImageFilter.h>

Inheritance diagram for itk::ShiftScaleInPlaceImageFilter< TInputImage >:

[legend]Collaboration diagram for itk::ShiftScaleInPlaceImageFilter< TInputImage >:

[legend]List of all members.

Public Types
typedef ShiftScaleInPlaceImageFilter	Self
typedef InPlaceImageFilter< TInputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::RegionType	OutputImageRegionType
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage::Pointer	OutputImagePointer
typedef TInputImage::PixelType	InputImagePixelType
typedef TInputImage::PixelType	OutputImagePixelType
typedef TInputImage::IndexType	InputImageIndexType
typedef TInputImage::SizeType	InputImageSizeType
typedef TInputImage::OffsetType	InputImageOffsetType
typedef TInputImage::IndexType	OutputImageIndexType
typedef TInputImage::SizeType	OutputImageSizeType
typedef TInputImage::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
	ShiftScaleInPlaceImageFilter ()
	~ShiftScaleInPlaceImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	BeforeThreadedGenerateData ()
void	AfterThreadedGenerateData ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

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 45 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 53 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 71 of file itkShiftScaleInPlaceImageFilter.h.

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

Definition at line 73 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 67 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 63 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 59 of file itkShiftScaleInPlaceImageFilter.h.

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

Definition at line 72 of file itkShiftScaleInPlaceImageFilter.h.

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

Definition at line 74 of file itkShiftScaleInPlaceImageFilter.h.

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

Definition at line 76 of file itkShiftScaleInPlaceImageFilter.h.

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

Reimplemented from itk::InPlaceImageFilter< TInputImage >. Definition at line 68 of file itkShiftScaleInPlaceImageFilter.h.

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

Reimplemented from itk::InPlaceImageFilter< TInputImage >. Definition at line 64 of file itkShiftScaleInPlaceImageFilter.h.

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

Superclass typedefs. Reimplemented from itk::InPlaceImageFilter< TInputImage >. Definition at line 60 of file itkShiftScaleInPlaceImageFilter.h.

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

Definition at line 75 of file itkShiftScaleInPlaceImageFilter.h.

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

Reimplemented from itk::InPlaceImageFilter< TInputImage >. Definition at line 52 of file itkShiftScaleInPlaceImageFilter.h.

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

Type to use form computations. Definition at line 79 of file itkShiftScaleInPlaceImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::InPlaceImageFilter< TInputImage >. Definition at line 50 of file itkShiftScaleInPlaceImageFilter.h.

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

Reimplemented from itk::InPlaceImageFilter< TInputImage >. Definition at line 51 of file itkShiftScaleInPlaceImageFilter.h.

---

Constructor & Destructor Documentation

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

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

---

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

Get the number of pixels that underflowed and overflowed.

template<class TInputImage> virtual RealType itk::ShiftScaleInPlaceImageFilter< TInputImage >::GetScale (   )  [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 (   )  [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 (   )  [virtual]

Get the number of pixels that underflowed and overflowed.

template<class TInputImage> itk::ShiftScaleInPlaceImageFilter< TInputImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Image related typedefs.

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

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage> void itk::ShiftScaleInPlaceImageFilter< TInputImage >::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::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, int  threadId )  [protected, virtual]

Multi-thread version GenerateData. Reimplemented from itk::ImageSource< TInputImage >.

---

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

• itkShiftScaleInPlaceImageFilter.h

---