ITK  4.4.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 | List of all members
itk::HistogramToImageFilter< THistogram, TImage, TFunction > Class Template Reference

#include <itkHistogramToImageFilter.h>

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

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 occurrences of the measurement vector / total number of occurrences of all measurement vectors.

See Also
HistogramToProbabilityImageFilter, HistogramToLogProbabilityImageFilter, HistogramToIntensityImageFilter, HistogramToEntropyImageFilter

Definition at line 50 of file itkHistogramToImageFilter.h.

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 Types inherited from itk::ImageSource< TImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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
 
- Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput (void)
 
const OutputImageTypeGetOutput (void) const
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData ()
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float amount)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TImage >
static const unsigned int OutputImageDimension
 

Protected Member Functions

virtual void GenerateData ()
 
virtual void GenerateOutputInformation ()
 
 HistogramToImageFilter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
 ~HistogramToImageFilter ()
 
- Protected Member Functions inherited from itk::ImageSource< TImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

FunctorType m_Functor
 

Private Member Functions

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

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Static Protected Member Functions inherited from itk::ImageSource< TImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Member Typedef Documentation

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

Definition at line 60 of file itkHistogramToImageFilter.h.

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

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.

Definition at line 75 of file itkHistogramToImageFilter.h.

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

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

Definition at line 59 of file itkHistogramToImageFilter.h.

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

Definition at line 57 of file itkHistogramToImageFilter.h.

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

Definition at line 58 of file itkHistogramToImageFilter.h.

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.

template<class THistogram, class TImage, class TFunction>
virtual void itk::HistogramToImageFilter< THistogram, TImage, TFunction >::GenerateData ( void  )
protectedvirtual

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 ( )
protectedvirtual

Generate the information describing 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>
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 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>
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

Method for creation through the object factory.

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
protectedvirtual

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: