#include <itkSampleToHistogramFilter.h>

Inheritance diagram for itk::Statistics::SampleToHistogramFilter< TSample, THistogram >:

Collaboration diagram for itk::Statistics::SampleToHistogramFilter< TSample, THistogram >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	HistogramMeasurementType = typename HistogramType::MeasurementType

using	HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

using	HistogramSizeType = typename HistogramType::SizeType

using	HistogramType = THistogram

using	InputBooleanObjectType = SimpleDataObjectDecorator< bool >

using	InputHistogramMeasurementObjectType = SimpleDataObjectDecorator< HistogramMeasurementType >

using	InputHistogramMeasurementVectorObjectType = SimpleDataObjectDecorator< HistogramMeasurementVectorType >

using	InputHistogramSizeObjectType = SimpleDataObjectDecorator< HistogramSizeType >

using	MeasurementType = typename MeasurementVectorType::ValueType

using	MeasurementVectorType = typename SampleType::MeasurementVectorType

using	Pointer = SmartPointer< Self >

using	SampleType = TSample

using	Self = SampleToHistogramFilter

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 HistogramSizeType &	GetHistogramSize () const

virtual const SimpleDataObjectDecorator< HistogramSizeType > *	GetHistogramSizeInput () const

virtual const SampleType *	GetInput () const

virtual const HistogramMeasurementType &	GetMarginalScale () const

virtual const SimpleDataObjectDecorator< HistogramMeasurementType > *	GetMarginalScaleInput () const

virtual const char *	GetNameOfClass () const

const HistogramType *	GetOutput () const

virtual void	SetHistogramSize (const HistogramSizeType &_arg)

virtual void	SetHistogramSize (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)

virtual void	SetHistogramSizeInput (const SimpleDataObjectDecorator< HistogramSizeType > *_arg)

virtual void	SetInput (const SampleType *sample)

virtual void	SetMarginalScale (const HistogramMeasurementType &_arg)

virtual void	SetMarginalScale (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)

virtual void	SetMarginalScaleInput (const SimpleDataObjectDecorator< HistogramMeasurementType > *_arg)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

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

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

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)

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

MultiThreaderType *	GetMultiThreader () 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

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

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)

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

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

virtual void	SetHistogramBinMinimumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual void	SetHistogramBinMinimum (const HistogramMeasurementVectorType &_arg)

virtual void	SetHistogramBinMinimum (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *	GetHistogramBinMinimumInput () const

virtual const HistogramMeasurementVectorType &	GetHistogramBinMinimum () const

virtual void	SetHistogramBinMaximumInput (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual void	SetHistogramBinMaximum (const HistogramMeasurementVectorType &_arg)

virtual void	SetHistogramBinMaximum (const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *_arg)

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType > *	GetHistogramBinMaximumInput () const

virtual const HistogramMeasurementVectorType &	GetHistogramBinMaximum () const

virtual void	SetAutoMinimumMaximumInput (const SimpleDataObjectDecorator< bool > *_arg)

virtual void	SetAutoMinimumMaximum (const bool &_arg)

virtual void	SetAutoMinimumMaximum (const SimpleDataObjectDecorator< bool > *_arg)

virtual const SimpleDataObjectDecorator< bool > *	GetAutoMinimumMaximumInput () const

virtual const bool &	GetAutoMinimumMaximum () const

virtual void	GraftOutput (DataObject *graft)

	SampleToHistogramFilter ()

	~SampleToHistogramFilter () override=default

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

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

void	GenerateData () override

HistogramMeasurementType	SafeAssign (MeasurementType from) const

Additional Inherited Members
Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, 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)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () 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)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () 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	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

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 TSample, typename THistogram>
class itk::Statistics::SampleToHistogramFilter< TSample, THistogram >

Computes the Histogram corresponding to a Sample.

This filter produces as output the histogram corresponding to the values of a Sample.

See also: Sample, Histogram

ITK Sphinx Examples:

All ITK Sphinx Examples

Create Histogram From List Of Measurements

Examples: Examples/Statistics/ImageHistogram1.cxx, Examples/Statistics/SampleToHistogramFilter.cxx, and SphinxExamples/src/Numerics/Statistics/CreateHistogramFromListOfMeasurements/Code.cxx.

Definition at line 68 of file itkSampleToHistogramFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::ConstPointer = SmartPointer<const Self>

Definition at line 77 of file itkSampleToHistogramFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

protected

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

Definition at line 167 of file itkSampleToHistogramFilter.h.

◆ HistogramMeasurementType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramMeasurementType = typename HistogramType::MeasurementType

Definition at line 91 of file itkSampleToHistogramFilter.h.

◆ HistogramMeasurementVectorType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

Definition at line 92 of file itkSampleToHistogramFilter.h.

◆ HistogramSizeType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramSizeType = typename HistogramType::SizeType

Definition at line 90 of file itkSampleToHistogramFilter.h.

◆ HistogramType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramType = THistogram

Definition at line 87 of file itkSampleToHistogramFilter.h.

◆ InputBooleanObjectType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputBooleanObjectType = SimpleDataObjectDecorator<bool>

Type of DataObjects to use for AutoMinimumMaximum input

Definition at line 121 of file itkSampleToHistogramFilter.h.

◆ InputHistogramMeasurementObjectType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputHistogramMeasurementObjectType = SimpleDataObjectDecorator<HistogramMeasurementType>

Type of DataObjects to use for Marginal Scale inputs

Definition at line 114 of file itkSampleToHistogramFilter.h.

◆ InputHistogramMeasurementVectorObjectType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputHistogramMeasurementVectorObjectType = SimpleDataObjectDecorator<HistogramMeasurementVectorType>

Type of DataObjects to use for Minimum and Maximums values of the histogram bins.

Definition at line 118 of file itkSampleToHistogramFilter.h.

◆ InputHistogramSizeObjectType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputHistogramSizeObjectType = SimpleDataObjectDecorator<HistogramSizeType>

Type of DataObjects to use for Size inputs

Definition at line 111 of file itkSampleToHistogramFilter.h.

◆ MeasurementType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MeasurementType = typename MeasurementVectorType::ValueType

Definition at line 89 of file itkSampleToHistogramFilter.h.

◆ MeasurementVectorType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MeasurementVectorType = typename SampleType::MeasurementVectorType

Definition at line 88 of file itkSampleToHistogramFilter.h.

◆ Pointer

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Pointer = SmartPointer<Self>

Definition at line 76 of file itkSampleToHistogramFilter.h.

◆ SampleType

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleType = TSample

MeasurementVector type alias support

Definition at line 86 of file itkSampleToHistogramFilter.h.

◆ Self

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Self = SampleToHistogramFilter

Standard class type aliases

Definition at line 74 of file itkSampleToHistogramFilter.h.

◆ Superclass

template<typename TSample , typename THistogram >

using itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Superclass = ProcessObject

Definition at line 75 of file itkSampleToHistogramFilter.h.

Constructor & Destructor Documentation

◆ SampleToHistogramFilter()

template<typename TSample , typename THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleToHistogramFilter ( )

protected

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ ~SampleToHistogramFilter()

template<typename TSample , typename THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::~SampleToHistogramFilter ( )

overrideprotecteddefault

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

Member Function Documentation

◆ CreateAnother()

template<typename TSample , typename THistogram >

virtual::itk::LightObject::Pointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::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.

◆ GenerateData()

template<typename TSample , typename THistogram >

void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GenerateData ( )

overrideprotectedvirtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

Reimplemented from itk::ProcessObject.

◆ GetAutoMinimumMaximum()

template<typename TSample , typename THistogram >

virtual const bool& itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetAutoMinimumMaximum ( ) const

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ GetAutoMinimumMaximumInput()

template<typename TSample , typename THistogram >

virtual const SimpleDataObjectDecorator< bool >* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetAutoMinimumMaximumInput ( ) const

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ GetHistogramBinMaximum()

template<typename TSample , typename THistogram >

virtual const HistogramMeasurementVectorType& itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetHistogramBinMaximum ( ) const

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ GetHistogramBinMaximumInput()

template<typename TSample , typename THistogram >

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetHistogramBinMaximumInput ( ) const

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ GetHistogramBinMinimum()

template<typename TSample , typename THistogram >

virtual const HistogramMeasurementVectorType& itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetHistogramBinMinimum ( ) const

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ GetHistogramBinMinimumInput()

template<typename TSample , typename THistogram >

virtual const SimpleDataObjectDecorator< HistogramMeasurementVectorType >* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetHistogramBinMinimumInput ( ) const

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ GetHistogramSize()

template<typename TSample , typename THistogram >

virtual const HistogramSizeType& itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetHistogramSize ( ) const

virtual

◆ GetHistogramSizeInput()

template<typename TSample , typename THistogram >

virtual const SimpleDataObjectDecorator< HistogramSizeType >* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetHistogramSizeInput ( ) const

virtual

◆ GetInput()

template<typename TSample , typename THistogram >

virtual const SampleType* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetInput ( ) const

virtual

◆ GetMarginalScale()

template<typename TSample , typename THistogram >

virtual const HistogramMeasurementType& itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetMarginalScale ( ) const

virtual

◆ GetMarginalScaleInput()

template<typename TSample , typename THistogram >

virtual const SimpleDataObjectDecorator< HistogramMeasurementType >* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetMarginalScaleInput ( ) const

virtual

◆ GetNameOfClass()

template<typename TSample , typename THistogram >

virtual const char* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::ProcessObject.

◆ GetOutput()

template<typename TSample , typename THistogram >

const HistogramType* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetOutput ( ) const

Get the output Histogram

◆ GraftOutput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GraftOutput ( DataObject * graft )

virtual

Method that facilitates the use of this filter in the internal pipeline of another filter.

◆ MakeOutput()

template<typename TSample , typename THistogram >

DataObjectPointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MakeOutput ( DataObjectPointerArraySizeType idx )

overrideprotectedvirtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TSample , typename THistogram >

static Pointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TSample , typename THistogram >

void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

Reimplemented from itk::ProcessObject.

◆ SafeAssign()

template<typename TSample , typename THistogram >

HistogramMeasurementType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SafeAssign ( MeasurementType from ) const

inlineprivate

SafeAssign – avoid numeric overflow/underflow

Definition at line 180 of file itkSampleToHistogramFilter.h.

References itk::NumericTraits< T >::max(), and itk::NumericTraits< T >::min().

◆ SetAutoMinimumMaximum() [1/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetAutoMinimumMaximum ( const bool & _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetAutoMinimumMaximum() [2/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetAutoMinimumMaximum ( const SimpleDataObjectDecorator< bool > * _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetAutoMinimumMaximumInput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetAutoMinimumMaximumInput ( const SimpleDataObjectDecorator< bool > * _arg )

virtual

Methods for setting and getting the boolean flag that defines whether the minimum and maximum of the histogram are going to be computed automatically from the values of the sample.

Warning: If the flag is set to false, it is required to set HistogramBinMinimum and HistogramBinMaximum.

◆ SetHistogramBinMaximum() [1/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramBinMaximum ( const HistogramMeasurementVectorType & _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetHistogramBinMaximum() [2/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramBinMaximum ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetHistogramBinMaximumInput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramBinMaximumInput ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetHistogramBinMinimum() [1/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramBinMinimum ( const HistogramMeasurementVectorType & _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetHistogramBinMinimum() [2/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramBinMinimum ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg )

virtual

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also: ProcessObject

◆ SetHistogramBinMinimumInput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramBinMinimumInput ( const SimpleDataObjectDecorator< HistogramMeasurementVectorType > * _arg )

virtual

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

Warning: To use those values you need to set the AutoMinimumMaximum flag to false.

◆ SetHistogramSize() [1/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramSize ( const HistogramSizeType & _arg )

virtual

◆ SetHistogramSize() [2/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramSize ( const SimpleDataObjectDecorator< HistogramSizeType > * _arg )

virtual

◆ SetHistogramSizeInput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetHistogramSizeInput ( const SimpleDataObjectDecorator< HistogramSizeType > * _arg )

virtual

Methods for setting and getting the histogram size. The histogram size is encapsulated inside a decorator class. For this reason, it is possible to set and get the decorator class, but it is only possible to set the histogram size by value. This macro declares the methods SetHistogramSize(), SetHistogramSizeInput(), GetHistogramSizeInput().

◆ SetInput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetInput ( const SampleType * sample )

virtual

Set/Get the input sample

◆ SetMarginalScale() [1/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetMarginalScale ( const HistogramMeasurementType & _arg )

virtual

◆ SetMarginalScale() [2/2]

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetMarginalScale ( const SimpleDataObjectDecorator< HistogramMeasurementType > * _arg )

virtual

◆ SetMarginalScaleInput()

template<typename TSample , typename THistogram >

virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetMarginalScaleInput ( const SimpleDataObjectDecorator< HistogramMeasurementType > * _arg )

virtual

Methods for setting and getting the Marginal scale value. The marginal scale is used when the type of the measurement vector components are of integer type.

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

itkSampleToHistogramFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<typename TSample, typename THistogram> class itk::Statistics::SampleToHistogramFilter< TSample, THistogram >

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointerArraySizeType

◆ HistogramMeasurementType

◆ HistogramMeasurementVectorType

◆ HistogramSizeType

◆ HistogramType

◆ InputBooleanObjectType

◆ InputHistogramMeasurementObjectType

◆ InputHistogramMeasurementVectorObjectType

◆ InputHistogramSizeObjectType

◆ MeasurementType

◆ MeasurementVectorType

◆ Pointer

◆ SampleType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ SampleToHistogramFilter()

◆ ~SampleToHistogramFilter()

Member Function Documentation

◆ CreateAnother()

◆ GenerateData()

◆ GetAutoMinimumMaximum()

◆ GetAutoMinimumMaximumInput()

◆ GetHistogramBinMaximum()

◆ GetHistogramBinMaximumInput()

◆ GetHistogramBinMinimum()

◆ GetHistogramBinMinimumInput()

◆ GetHistogramSize()

◆ GetHistogramSizeInput()

◆ GetInput()

◆ GetMarginalScale()

◆ GetMarginalScaleInput()

◆ GetNameOfClass()

◆ GetOutput()

◆ GraftOutput()

◆ MakeOutput()

◆ New()

◆ PrintSelf()

◆ SafeAssign()

◆ SetAutoMinimumMaximum() [1/2]

◆ SetAutoMinimumMaximum() [2/2]

◆ SetAutoMinimumMaximumInput()

◆ SetHistogramBinMaximum() [1/2]

◆ SetHistogramBinMaximum() [2/2]

◆ SetHistogramBinMaximumInput()

◆ SetHistogramBinMinimum() [1/2]

◆ SetHistogramBinMinimum() [2/2]

◆ SetHistogramBinMinimumInput()

◆ SetHistogramSize() [1/2]

◆ SetHistogramSize() [2/2]

◆ SetHistogramSizeInput()

◆ SetInput()

◆ SetMarginalScale() [1/2]

◆ SetMarginalScale() [2/2]

◆ SetMarginalScaleInput()

template<typename TSample, typename THistogram>
class itk::Statistics::SampleToHistogramFilter< TSample, THistogram >