ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage > Class Template Reference

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

#include <itkNormalizeToConstantImageFilter.h>

Inheritance diagram for itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef InputImageType::IndexType IndexType
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef NumericTraits
< InputImagePixelType >
::RealType 
RealType
typedef InputImageType::RegionType RegionType
typedef
NormalizeToConstantImageFilter 
Self
typedef InputImageType::SizeType SizeType
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
 typedef (Concept::HasPixelTraits< InputImagePixelType >) InputHasPixelTraitsCheck
 typedef (Concept::HasNumericTraits< InputImagePixelType >) InputHasNumericTraitsCheck
virtual void SetConstant (RealType _arg)
virtual RealType GetConstant () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
static const unsigned int ImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void GenerateData ()
void GenerateInputRequestedRegion ()
 NormalizeToConstantImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~NormalizeToConstantImageFilter ()

Private Member Functions

 NormalizeToConstantImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

RealType m_Constant

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >

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. http://hdl.handle.net/10380/3154

Author:
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also:
NormalizeImageFilter
StatisticsImageFilter
DivideImageFilter
Wiki Examples:

Definition at line 55 of file itkNormalizeToConstantImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer<const Self> itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::IndexType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 77 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::ConstPointer itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::InputImageConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::InputImagePixelType
template<class TInputImage , class TOutputImage >
typedef InputImageType::Pointer itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage >
typedef TInputImage itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 68 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::ConstPointer itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

Definition at line 74 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 73 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 69 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer<Self> itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef NumericTraits<InputImagePixelType>::RealType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::RealType

Definition at line 80 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 76 of file itkNormalizeToConstantImageFilter.h.

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

Standard class typedefs.

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

Definition at line 60 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 78 of file itkNormalizeToConstantImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

template<class TInputImage , class TOutputImage >
virtual itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::~NormalizeToConstantImageFilter ( ) [inline, protected, virtual]

Definition at line 114 of file itkNormalizeToConstantImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::NormalizeToConstantImageFilter< 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 >
void itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

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

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

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

Set/get the normalization constant.

template<class TInputImage , class TOutputImage >
virtual const char* itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

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

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

Standard New method.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >
void itk::NormalizeToConstantImageFilter< 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::NormalizeToConstantImageFilter< 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::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::SetConstant ( RealType  _arg) [virtual]

Set/get the normalization constant.

template<class TInputImage , class TOutputImage >
itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< InputImagePixelType )

This class requires InputHasNumericTraitsCheck in the form of (Concept::HasNumericTraits<InputImagePixelType>)

template<class TInputImage , class TOutputImage >
itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasPixelTraits< InputImagePixelType )

Begin concept checking This class requires InputHasPixelTraitsCheck in the form of (Concept::HasPixelTraits<InputImagePixelType>)


Member Data Documentation

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

ImageDimension constants

Definition at line 88 of file itkNormalizeToConstantImageFilter.h.

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

ImageDimension constants

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

Definition at line 84 of file itkNormalizeToConstantImageFilter.h.

template<class TInputImage , class TOutputImage >
RealType itk::NormalizeToConstantImageFilter< TInputImage, TOutputImage >::m_Constant [private]

Definition at line 126 of file itkNormalizeToConstantImageFilter.h.

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

ImageDimension constants

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

Definition at line 86 of file itkNormalizeToConstantImageFilter.h.


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