ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::HistogramToEntropyImageFilter< THistogram, TImage > Class Template Reference

#include <itkHistogramToEntropyImageFilter.h>

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

Detailed Description

template<typename THistogram, typename 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
Examples:
RegistrationITKv3/ImageRegistrationHistogramPlotter.cxx, and RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx.

Definition at line 102 of file itkHistogramToEntropyImageFilter.h.

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 SmartPointer< const SelfConstPointer
 
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 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
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
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) ITK_OVERRIDE
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
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 () const
 
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 Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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 ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 HistogramToEntropyImageFilter ()
 
virtual ~HistogramToEntropyImageFilter ()
 
- 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 ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, 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 () const
 
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 () const
 
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 ()
 

Private Member Functions

 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 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)
 
- Protected Attributes inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, TImage::PixelType > >
FunctorType m_Functor
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<typename THistogram , typename TImage = Image< double, 3>>
typedef SmartPointer< const Self > itk::HistogramToEntropyImageFilter< THistogram, TImage >::ConstPointer

Definition at line 117 of file itkHistogramToEntropyImageFilter.h.

template<typename THistogram , typename TImage = Image< double, 3>>
typedef SmartPointer< Self > itk::HistogramToEntropyImageFilter< THistogram, TImage >::Pointer

Definition at line 116 of file itkHistogramToEntropyImageFilter.h.

template<typename THistogram , typename TImage = Image< double, 3>>
typedef HistogramToEntropyImageFilter itk::HistogramToEntropyImageFilter< THistogram, TImage >::Self

Standard class typedefs.

Definition at line 109 of file itkHistogramToEntropyImageFilter.h.

template<typename THistogram , typename TImage = Image< double, 3>>
typedef HistogramToImageFilter< THistogram, TImage, Function::HistogramEntropyFunction< SizeValueType, typename TImage::PixelType > > itk::HistogramToEntropyImageFilter< THistogram, TImage >::Superclass

Standard "Superclass" typedef.

Definition at line 114 of file itkHistogramToEntropyImageFilter.h.

Constructor & Destructor Documentation

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

Definition at line 126 of file itkHistogramToEntropyImageFilter.h.

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

Definition at line 127 of file itkHistogramToEntropyImageFilter.h.

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

Member Function Documentation

template<typename THistogram , typename TImage = Image< double, 3>>
virtual::itk::LightObject::Pointer itk::HistogramToEntropyImageFilter< THistogram, TImage >::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<typename THistogram , typename TImage = Image< double, 3>>
virtual const char* itk::HistogramToEntropyImageFilter< THistogram, TImage >::GetNameOfClass ( ) const
virtual
template<typename THistogram , typename TImage = Image< double, 3>>
static Pointer itk::HistogramToEntropyImageFilter< THistogram, TImage >::New ( )
static

Method for creation through the object factory.

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

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