ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::HistogramToImageFilter< THistogram, TImage, TFunction > Class Template Reference

This class takes a histogram as an input and returns an image of type specified by the functor. More...

#include <itkHistogramToImageFilter.h>

Inheritance diagram for itk::HistogramToImageFilter< THistogram, TImage, TFunction >:
Collaboration diagram for itk::HistogramToImageFilter< THistogram, TImage, TFunction >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TFunction FunctorType
typedef HistogramType::SizeType HistogramSizeType
typedef THistogram HistogramType
typedef
itk::ImageRegionIteratorWithIndex
< OutputImageType
ImageIteratorType
typedef
HistogramType::MeasurementVectorType 
MeasurementVectorType
typedef Superclass::Pointer OutputImagePointer
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef TImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef SmartPointer< SelfPointer
typedef OutputImageType::PointType PointType
typedef HistogramToImageFilter Self
typedef OutputImageType::SizeType SizeType
typedef
OutputImageType::SpacingType 
SpacingType
typedef ImageSource< TImage > Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const HistogramTypeGetInput (void)
virtual const char * GetNameOfClass () const
virtual void SetInput (const HistogramType *histogram)
void SetTotalFrequency (SizeValueType n)
void SetFunctor (const FunctorType &functor)
FunctorTypeGetFunctor ()
const FunctorTypeGetFunctor () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = OutputImageType::ImageDimension

Protected Member Functions

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

Protected Attributes

FunctorType m_Functor

Private Member Functions

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

Detailed Description

template<class THistogram, class TImage, class TFunction>
class itk::HistogramToImageFilter< THistogram, TImage, TFunction >

This class takes a histogram as an input and returns an image of type specified by the functor.

The dimension of the image is equal to the size of each measurement vector of the histogram. The size in the image along each dimension will be equal to the number of bins along each dimension of the histogram.

The filter may be used in registration methods to plot the joint histogram after every iteration. A functor is used since it is customary to plot p log p where p is the probability of each measurement vector p is given by Number of occurances of the measurement vector / total number of occurances of all measurement vectors.

See also:
HistogramToProbabilityImageFilter, HistogramToLogProbabilityImageFilter, HistogramToIntensityImageFilter, HistogramToEntropyImageFilter

Definition at line 50 of file itkHistogramToImageFilter.h.


Member Typedef Documentation

template<class THistogram, class TImage, class TFunction>
typedef SmartPointer< const Self > itk::HistogramToImageFilter< THistogram, TImage, TFunction >::ConstPointer
template<class THistogram, class TImage, class TFunction>
typedef TFunction itk::HistogramToImageFilter< THistogram, TImage, TFunction >::FunctorType

Standard class typedefs.

Definition at line 56 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef HistogramType::SizeType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::HistogramSizeType

Definition at line 83 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef THistogram itk::HistogramToImageFilter< THistogram, TImage, TFunction >::HistogramType

Some convenient typedefs.

Definition at line 81 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef itk::ImageRegionIteratorWithIndex< OutputImageType > itk::HistogramToImageFilter< THistogram, TImage, TFunction >::ImageIteratorType

Definition at line 69 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef HistogramType::MeasurementVectorType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::MeasurementVectorType

Definition at line 82 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef Superclass::Pointer itk::HistogramToImageFilter< THistogram, TImage, TFunction >::OutputImagePointer

Reimplemented from itk::ImageSource< TImage >.

Definition at line 63 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef Superclass::OutputImageRegionType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 75 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef TImage itk::HistogramToImageFilter< THistogram, TImage, TFunction >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 62 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef OutputImageType::PixelType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::OutputPixelType

Definition at line 66 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef SmartPointer< Self > itk::HistogramToImageFilter< THistogram, TImage, TFunction >::Pointer
template<class THistogram, class TImage, class TFunction>
typedef OutputImageType::PointType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::PointType

Definition at line 65 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef HistogramToImageFilter itk::HistogramToImageFilter< THistogram, TImage, TFunction >::Self
template<class THistogram, class TImage, class TFunction>
typedef OutputImageType::SizeType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::SizeType

Definition at line 84 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef OutputImageType::SpacingType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::SpacingType

Definition at line 64 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
typedef ImageSource< TImage > itk::HistogramToImageFilter< THistogram, TImage, TFunction >::Superclass

Constructor & Destructor Documentation

template<class THistogram, class TImage, class TFunction>
itk::HistogramToImageFilter< THistogram, TImage, TFunction >::HistogramToImageFilter ( ) [protected]
template<class THistogram, class TImage, class TFunction>
itk::HistogramToImageFilter< THistogram, TImage, TFunction >::~HistogramToImageFilter ( ) [protected]
template<class THistogram, class TImage, class TFunction>
itk::HistogramToImageFilter< THistogram, TImage, TFunction >::HistogramToImageFilter ( const Self ) [private]

Member Function Documentation

template<class THistogram, class TImage, class TFunction>
virtual::itk::LightObject::Pointer itk::HistogramToImageFilter< THistogram, TImage, TFunction >::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.

Reimplemented in itk::HistogramToEntropyImageFilter< THistogram, TImage >, itk::HistogramToIntensityImageFilter< THistogram, TImage >, itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >, and itk::HistogramToProbabilityImageFilter< THistogram, TImage >.

template<class THistogram, class TImage, class TFunction>
virtual void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GenerateData ( void  ) [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< TImage >.

template<class THistogram, class TImage, class TFunction>
virtual void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GenerateOutputInformation ( ) [protected, virtual]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<class THistogram, class TImage, class TFunction>
const FunctorType& itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GetFunctor ( ) const [inline]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 113 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
FunctorType& itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GetFunctor ( ) [inline]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 112 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
const HistogramType* itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GetInput ( void  )
template<class THistogram, class TImage, class TFunction>
virtual const char* itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GetNameOfClass ( ) const [virtual]
template<class THistogram, class TImage, class TFunction>
static Pointer itk::HistogramToImageFilter< THistogram, TImage, TFunction >::New ( ) [static]
template<class THistogram, class TImage, class TFunction>
void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::operator= ( const Self ) [private]
template<class THistogram, class TImage, class TFunction>
virtual void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::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::ProcessObject.

template<class THistogram, class TImage, class TFunction>
void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::SetFunctor ( const FunctorType functor) [inline]

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate).

Definition at line 101 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
virtual void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::SetInput ( const HistogramType histogram) [virtual]
template<class THistogram, class TImage, class TFunction>
void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::SetTotalFrequency ( SizeValueType  n)

Member Data Documentation

template<class THistogram, class TImage, class TFunction>
const unsigned int itk::HistogramToImageFilter< THistogram, TImage, TFunction >::ImageDimension = OutputImageType::ImageDimension [static]

Determine the image dimension.

Definition at line 87 of file itkHistogramToImageFilter.h.

template<class THistogram, class TImage, class TFunction>
FunctorType itk::HistogramToImageFilter< THistogram, TImage, TFunction >::m_Functor [protected]

Definition at line 126 of file itkHistogramToImageFilter.h.


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