#include <itkHistogramToProbabilityImageFilter.h>

Detailed Description

template<typename THistogram, typename TImage = Image<float, 3>>
class itk::HistogramToProbabilityImageFilter< THistogram, TImage >

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

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

where \(q_I\) is the frequency of measurement vector, I.

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

The output image is of type float.

This is useful in plotting the joint histograms during registration.

See also: HistogramToImageFilter, HistogramToLogProbabilityImageFilter, HistogramToIntensityImageFilter, HistogramToEntropyImageFilter

Definition at line 89 of file itkHistogramToProbabilityImageFilter.h.

Inheritance diagram for itk::HistogramToProbabilityImageFilter< THistogram, TImage >:

Collaboration diagram for itk::HistogramToProbabilityImageFilter< THistogram, TImage >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = HistogramToProbabilityImageFilter

using	Superclass

Public Types inherited from itk::HistogramToImageFilter< THistogram, TImage, TFunction >
using	ConstPointer = SmartPointer<const Self>

using	FunctorType = TFunction

using	HistogramSizeType = typename HistogramType::SizeType

using	HistogramType = THistogram

using	ImageIteratorType = itk::ImageRegionIteratorWithIndex<OutputImageType>

using	MeasurementVectorType = typename HistogramType::MeasurementVectorType

using	OutputImagePointer = typename Superclass::Pointer

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

using	DataObjectIdentifierType

using	DataObjectPointer

using	DataObjectPointerArraySizeType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	Pointer

using	Self

using	Superclass

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, TFunction >
const HistogramType *	GetInput ()

void	SetFunctor (const FunctorType &functor)

virtual void	SetInput (const HistogramType *input)

void	SetTotalFrequency (SizeValueType n)

FunctorType &	GetFunctor ()

const FunctorType &	GetFunctor () const

Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (DataObject *graft)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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 void	EnlargeOutputRequestedRegion (DataObject *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

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 ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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) const

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
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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, TFunction >
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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	HistogramToProbabilityImageFilter ()=default

	~HistogramToProbabilityImageFilter () override=default

Protected Member Functions inherited from itk::HistogramToImageFilter< THistogram, TImage, TFunction >
void	GenerateData () override

void	GenerateOutputInformation () override

	HistogramToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~HistogramToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

	ImageSource ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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, TFunction >
static constexpr unsigned int	ImageDimension = OutputImageType::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TImage >
static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Protected Member Functions inherited from itk::ImageSource< TImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::HistogramToImageFilter< THistogram, TImage, TFunction >
FunctorType	m_Functor {}

Protected Attributes inherited from itk::ImageSource< TImage >
bool	m_DynamicMultiThreading

bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename THistogram, typename TImage = Image<float, 3>>

using itk::HistogramToProbabilityImageFilter< THistogram, TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 107 of file itkHistogramToProbabilityImageFilter.h.

◆ Pointer

template<typename THistogram, typename TImage = Image<float, 3>>

using itk::HistogramToProbabilityImageFilter< THistogram, TImage >::Pointer = SmartPointer<Self>

Definition at line 106 of file itkHistogramToProbabilityImageFilter.h.

◆ Self

template<typename THistogram, typename TImage = Image<float, 3>>

using itk::HistogramToProbabilityImageFilter< THistogram, TImage >::Self = HistogramToProbabilityImageFilter

Standard class type aliases.

Definition at line 98 of file itkHistogramToProbabilityImageFilter.h.

◆ Superclass

template<typename THistogram, typename TImage = Image<float, 3>>

using itk::HistogramToProbabilityImageFilter< THistogram, TImage >::Superclass

Initial value:

 
    HistogramToImageFilter<THistogram,
                           TImage,
                           Function::HistogramProbabilityFunction<SizeValueType, typename TImage::PixelType>>

Standard "Superclass" type alias.

Definition at line 101 of file itkHistogramToProbabilityImageFilter.h.

Constructor & Destructor Documentation

◆ HistogramToProbabilityImageFilter()

template<typename THistogram, typename TImage = Image<float, 3>>

itk::HistogramToProbabilityImageFilter< THistogram, TImage >::HistogramToProbabilityImageFilter ( )

protecteddefault

Referenced by GetNameOfClass().

◆ ~HistogramToProbabilityImageFilter()

template<typename THistogram, typename TImage = Image<float, 3>>

itk::HistogramToProbabilityImageFilter< THistogram, TImage >::~HistogramToProbabilityImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename THistogram, typename TImage = Image<float, 3>>

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