SimpleITK  1.3.0.dev57
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::NormalizeToConstantImageFilter Class Reference

Scales image pixel intensities to make the sum of all pixels equal a user-defined constant. More...

#include <sitkNormalizeToConstantImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
typedef NormalizeToConstantImageFilter 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 constant)
double GetConstant () const
std::string GetName () const
 NormalizeToConstantImageFilter ()
SelfSetConstant (double Constant)
std::string ToString () const
virtual ~NormalizeToConstantImageFilter ()
- 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

double m_Constant
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory


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) SITK_NOEXCEPT
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

Scales image pixel intensities to make the sum of all pixels equal a user-defined constant.

The default value of the constant is 1. It can be changed with SetConstant() .

This transform is especially useful for normalizing a convolution kernel.

This code was contributed in the Insight Journal paper: "FFT based convolution" by Lehmann G.

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also
itk::simple::NormalizeToConstant for the procedural interface
itk::NormalizeToConstantImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkNormalizeToConstantImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 98 of file sitkNormalizeToConstantImageFilter.h.

Define the pixels types supported by this filter

Definition at line 67 of file sitkNormalizeToConstantImageFilter.h.

Definition at line 57 of file sitkNormalizeToConstantImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::NormalizeToConstantImageFilter::~NormalizeToConstantImageFilter ( )


itk::simple::NormalizeToConstantImageFilter::NormalizeToConstantImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::NormalizeToConstantImageFilter::Execute ( const Image image1,
double  constant 

Execute the filter on the input image with the given parameters

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

Dispatched methods which calls ExecuteInteral on each component

double itk::simple::NormalizeToConstantImageFilter::GetConstant ( ) const

Set/get the normalization constant.

Definition at line 79 of file sitkNormalizeToConstantImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 81 of file sitkNormalizeToConstantImageFilter.h.

Self& itk::simple::NormalizeToConstantImageFilter::SetConstant ( double  Constant)

Set/get the normalization constant.

Definition at line 74 of file sitkNormalizeToConstantImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 104 of file sitkNormalizeToConstantImageFilter.h.

Definition at line 103 of file sitkNormalizeToConstantImageFilter.h.

Member Data Documentation

double itk::simple::NormalizeToConstantImageFilter::m_Constant

Definition at line 108 of file sitkNormalizeToConstantImageFilter.h.

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

Definition at line 105 of file sitkNormalizeToConstantImageFilter.h.

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