ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions
itk::HistogramToEntropyImageFilter< THistogram, TImage > Class Template Reference

#include <itkHistogramToEntropyImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef
HistogramToEntropyImageFilter 
Self
typedef HistogramToImageFilter
< THistogram, TImage,
Function::HistogramEntropyFunction
< SizeValueType, typename
TImage::PixelType > > 
Superclass
- Public Types inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
typedef
Function::HistogramEntropyFunction
< SizeValueType,
TImage::PixelType > 
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 OutputImageType::PointType PointType
typedef OutputImageType::SizeType SizeType
typedef
OutputImageType::SpacingType 
SpacingType
- Public Types inherited from itk::ImageSource< TImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef OutputImageType::PixelType OutputImagePixelType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
const HistogramTypeGetInput (void)
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 unsigned long 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
- Protected Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
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 ()
 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)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) 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)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
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 SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyInputInformation ()
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
virtual void PushBackInput (const DataObject *input)
virtual void PopBackInput ()
virtual void PushFrontInput (const DataObject *input)
virtual void PopFrontInput ()
- 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 ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
static Pointer New ()
 HistogramToEntropyImageFilter ()
virtual ~HistogramToEntropyImageFilter ()
 HistogramToEntropyImageFilter (const Self &)
void operator= (const Self &)

Additional Inherited Members

- Static Public Attributes inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
static const unsigned int ImageDimension
- Static Public Attributes inherited from itk::ImageSource< TImage >
static const unsigned int OutputImageDimension
- Protected Attributes inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
FunctorType m_Functor

Detailed Description

template<class THistogram, class TImage = Image< double, 3>>
class itk::HistogramToEntropyImageFilter< THistogram, TImage >

The class takes a histogram as an input and gives the entropy image as the output. A pixel, at position I, in the output image is given by.

\[ f(I) = -p \log_2 p \]

where

\[ p = \frac{q_I}{\sum_{i \in I} q_I} \]

where $q_I$ is the frequency of measurement vector, I.

$p$ is the frequency of a measurement vector by the sum of all frequencies = Probability of the the measurement vector

The output image is of type double.

This is useful in plotting the joint histograms during registration.

See also:
HistogramToImageFilter, HistogramToLogProbabilityImageFilter, HistogramToIntensityImageFilter, HistogramToProbabilityImageFilter

Definition at line 102 of file itkHistogramToEntropyImageFilter.h.


Member Typedef Documentation

template<class THistogram , class TImage = Image< double, 3>>
typedef SmartPointer< const Self > itk::HistogramToEntropyImageFilter< THistogram, TImage >::ConstPointer
template<class THistogram , class TImage = Image< double, 3>>
typedef SmartPointer< Self > itk::HistogramToEntropyImageFilter< THistogram, TImage >::Pointer
template<class THistogram , class TImage = Image< double, 3>>
typedef HistogramToEntropyImageFilter itk::HistogramToEntropyImageFilter< THistogram, TImage >::Self
template<class THistogram , class TImage = Image< double, 3>>
typedef HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, typename TImage::PixelType > > itk::HistogramToEntropyImageFilter< THistogram, TImage >::Superclass

Constructor & Destructor Documentation

template<class THistogram , class TImage = Image< double, 3>>
itk::HistogramToEntropyImageFilter< THistogram, TImage >::HistogramToEntropyImageFilter ( )
inlineprotected

Method for creation through the object factory.

Definition at line 125 of file itkHistogramToEntropyImageFilter.h.

template<class THistogram , class TImage = Image< double, 3>>
virtual itk::HistogramToEntropyImageFilter< THistogram, TImage >::~HistogramToEntropyImageFilter ( )
inlineprotectedvirtual

Method for creation through the object factory.

Definition at line 126 of file itkHistogramToEntropyImageFilter.h.

template<class THistogram , class TImage = Image< double, 3>>
itk::HistogramToEntropyImageFilter< THistogram, TImage >::HistogramToEntropyImageFilter ( const Self )
private

Method for creation through the object factory.


Member Function Documentation

template<class THistogram , class TImage = Image< double, 3>>
virtual::itk::LightObject::Pointer itk::HistogramToEntropyImageFilter< THistogram, TImage >::CreateAnother ( void  ) const
virtual
template<class THistogram , class TImage = Image< double, 3>>
virtual const char* itk::HistogramToEntropyImageFilter< THistogram, TImage >::GetNameOfClass ( ) const
virtual
template<class THistogram , class TImage = Image< double, 3>>
static Pointer itk::HistogramToEntropyImageFilter< THistogram, TImage >::New ( )
static
template<class THistogram , class TImage = Image< double, 3>>
void itk::HistogramToEntropyImageFilter< THistogram, TImage >::operator= ( const Self )
private

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