SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::RescaleIntensityImageFilter Class Reference

Applies a linear transformation to the intensity levels of the input Image . More...

#include <sitkRescaleIntensityImageFilter.h>

+ Inheritance diagram for itk::simple::RescaleIntensityImageFilter:
+ Collaboration diagram for itk::simple::RescaleIntensityImageFilter:

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
typedef RescaleIntensityImageFilter 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 outputMinimum, double outputMaximum)
std::string GetName () const
double GetOutputMaximum () const
double GetOutputMinimum () const
 RescaleIntensityImageFilter ()
SelfSetOutputMaximum (double OutputMaximum)
SelfSetOutputMinimum (double OutputMinimum)
std::string ToString () const
 ~RescaleIntensityImageFilter ()
- 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
double m_OutputMaximum
double m_OutputMinimum


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::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) throw ()
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::EventObjectGetITKEventObject (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

Applies a linear transformation to the intensity levels of the input Image .

RescaleIntensityImageFilter applies pixel-wise a linear transformation to the intensity values of input image pixels. The linear transformation is defined by the user in terms of the minimum and maximum values that the output image should have.

The following equation gives the mapping of the intensity values

\[ outputPixel = ( inputPixel - inputMin) \cdot \frac{(outputMax - outputMin )}{(inputMax - inputMin)} + outputMin \]

All computations are performed in the precision of the input pixel's RealType. Before assigning the computed value to the output pixel.

NOTE: In this filter the minimum and maximum values of the input image are computed internally using the MinimumMaximumImageCalculator . Users are not supposed to set those values in this filter. If you need a filter where you can set the minimum and maximum values of the input, please use the IntensityWindowingImageFilter . If you want a filter that can use a user-defined linear transformation for the intensity, then please use the ShiftScaleImageFilter .

See also
Wiki Examples:

Definition at line 59 of file sitkRescaleIntensityImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 109 of file sitkRescaleIntensityImageFilter.h.

Define the pixels types supported by this filter

Definition at line 71 of file sitkRescaleIntensityImageFilter.h.

Definition at line 61 of file sitkRescaleIntensityImageFilter.h.

Constructor & Destructor Documentation

itk::simple::RescaleIntensityImageFilter::RescaleIntensityImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::RescaleIntensityImageFilter::~RescaleIntensityImageFilter ( )


Member Function Documentation

Image itk::simple::RescaleIntensityImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::RescaleIntensityImageFilter::Execute ( const Image image1,
double  outputMinimum,
double  outputMaximum 

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::RescaleIntensityImageFilter::ExecuteInternal ( const Image image1)
template<class TImageType >
Image itk::simple::RescaleIntensityImageFilter::ExecuteInternalVectorImage ( const Image image)

Dispatched methods which calls ExecuteInteral on each component

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 91 of file sitkRescaleIntensityImageFilter.h.

double itk::simple::RescaleIntensityImageFilter::GetOutputMaximum ( ) const

Definition at line 89 of file sitkRescaleIntensityImageFilter.h.

double itk::simple::RescaleIntensityImageFilter::GetOutputMinimum ( ) const

Definition at line 81 of file sitkRescaleIntensityImageFilter.h.

Self& itk::simple::RescaleIntensityImageFilter::SetOutputMaximum ( double  OutputMaximum)

Definition at line 85 of file sitkRescaleIntensityImageFilter.h.

Self& itk::simple::RescaleIntensityImageFilter::SetOutputMinimum ( double  OutputMinimum)

Definition at line 77 of file sitkRescaleIntensityImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 116 of file sitkRescaleIntensityImageFilter.h.

Definition at line 115 of file sitkRescaleIntensityImageFilter.h.

Member Data Documentation

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

Definition at line 117 of file sitkRescaleIntensityImageFilter.h.

double itk::simple::RescaleIntensityImageFilter::m_OutputMaximum

Definition at line 123 of file sitkRescaleIntensityImageFilter.h.

double itk::simple::RescaleIntensityImageFilter::m_OutputMinimum

Definition at line 121 of file sitkRescaleIntensityImageFilter.h.

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