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

#include <itkHistogramToLogProbabilityImageFilter.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = HistogramToLogProbabilityImageFilter
 
using Superclass = HistogramToImageFilter< THistogram, TImage, Function::HistogramLogProbabilityFunction< SizeValueType, typename TImage::PixelType > >
 
- Public Types inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramLogProbabilityFunction< SizeValueType, TImage::PixelType > >
using ConstPointer = SmartPointer< const Self >
 
using FunctorType = Function::HistogramLogProbabilityFunction< SizeValueType, TImage::PixelType >
 
using HistogramSizeType = typename HistogramType::SizeType
 
using HistogramType = THistogram
 
using ImageIteratorType = itk::ImageRegionIteratorWithIndex< OutputImageType >
 
using MeasurementVectorType = typename HistogramType::MeasurementVectorType
 
using OutputImagePointer = typename Superclass::Pointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TImage
 
using OutputPixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename OutputImageType::PointType
 
using Self = HistogramToImageFilter
 
using SizeType = typename OutputImageType::SizeType
 
using SpacingType = typename OutputImageType::SpacingType
 
using Superclass = ImageSource< TImage >
 
- Public Types inherited from itk::ImageSource< TImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramLogProbabilityFunction< SizeValueType, TImage::PixelType > >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const HistogramTypeGetInput ()
 
virtual void SetInput (const HistogramType *histogram)
 
void SetFunctor (const FunctorType &functor)
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
void SetTotalFrequency (SizeValueType n)
 
- Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual void ResetPipeline ()
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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::HistogramLogProbabilityFunction< 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

 HistogramToLogProbabilityImageFilter ()=default
 
 ~HistogramToLogProbabilityImageFilter () override=default
 
- Protected Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramLogProbabilityFunction< SizeValueType, TImage::PixelType > >
 HistogramToImageFilter ()
 
 ~HistogramToImageFilter () override=default
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::ImageSource< TImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 

Additional Inherited Members

- Static Public Attributes inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramLogProbabilityFunction< SizeValueType, TImage::PixelType > >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TImage >
static constexpr unsigned int OutputImageDimension
 
- Static Protected Member Functions inherited from itk::ImageSource< TImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramLogProbabilityFunction< SizeValueType, TImage::PixelType > >
FunctorType m_Functor
 
- Protected Attributes inherited from itk::ImageSource< TImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

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

\[ f(I) = \log_2( \frac{q_I}{\sum_{i \in I} q_I} ) \]

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

This is the log of the frequency of a measurement vector by the sum of all frequencies.

The output image is of type double.

This is useful in plotting the joint histograms during registration.

See also
HistogramToImageFilter, HistogramToProbabilityImageFilter, HistogramToIntensityImageFilter, HistogramToEntropyImageFilter

Definition at line 96 of file itkHistogramToLogProbabilityImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 114 of file itkHistogramToLogProbabilityImageFilter.h.

◆ Pointer

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

Definition at line 113 of file itkHistogramToLogProbabilityImageFilter.h.

◆ Self

template<typename THistogram , typename TImage = Image<double, 3>>
using itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::Self = HistogramToLogProbabilityImageFilter

Standard class type aliases.

Definition at line 105 of file itkHistogramToLogProbabilityImageFilter.h.

◆ Superclass

template<typename THistogram , typename TImage = Image<double, 3>>
using itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::Superclass = HistogramToImageFilter<THistogram, TImage, Function::HistogramLogProbabilityFunction<SizeValueType, typename TImage::PixelType> >

Standard "Superclass" type alias.

Definition at line 111 of file itkHistogramToLogProbabilityImageFilter.h.

Constructor & Destructor Documentation

◆ HistogramToLogProbabilityImageFilter()

template<typename THistogram , typename TImage = Image<double, 3>>
itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::HistogramToLogProbabilityImageFilter ( )
protecteddefault

◆ ~HistogramToLogProbabilityImageFilter()

template<typename THistogram , typename TImage = Image<double, 3>>
itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::~HistogramToLogProbabilityImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename THistogram , typename TImage = Image<double, 3>>
virtual::itk::LightObject::Pointer itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::CreateAnother ( ) 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.

◆ GetNameOfClass()

template<typename THistogram , typename TImage = Image<double, 3>>
virtual const char* itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::GetNameOfClass ( ) const
virtual

◆ New()

template<typename THistogram , typename TImage = Image<double, 3>>
static Pointer itk::HistogramToLogProbabilityImageFilter< THistogram, TImage >::New ( )
static

Method for creation through the object factory.


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