itk::Statistics::SampleToHistogramFilter< TSample, THistogram > Class Template Reference

#include <itkSampleToHistogramFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef HistogramType::MeasurementType	HistogramMeasurementType
typedef HistogramType::MeasurementVectorType	HistogramMeasurementVectorType
typedef HistogramType::SizeType	HistogramSizeType
typedef THistogram	HistogramType
typedef SimpleDataObjectDecorator < bool >	InputBooleanObjectType
typedef SimpleDataObjectDecorator < HistogramMeasurementType >	InputHistogramMeasurementObjectType
typedef SimpleDataObjectDecorator < HistogramMeasurementVectorType >	InputHistogramMeasurementVectorObjectType
typedef SimpleDataObjectDecorator < HistogramSizeType >	InputHistogramSizeObjectType
typedef MeasurementVectorType::ValueType	MeasurementType
typedef SampleType::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef TSample	SampleType
typedef SampleToHistogramFilter	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const SampleType *	GetInput () const
virtual const char *	GetNameOfClass () const
const HistogramType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
	itkSetGetDecoratedInputMacro (HistogramSize, HistogramSizeType)
	itkSetGetDecoratedInputMacro (MarginalScale, HistogramMeasurementType)
	itkSetGetDecoratedInputMacro (AutoMinimumMaximum, bool)
virtual void	SetInput (const SampleType *sample)
	itkSetGetDecoratedInputMacro (HistogramBinMinimum, HistogramMeasurementVectorType)
	itkSetGetDecoratedInputMacro (HistogramBinMaximum, HistogramMeasurementVectorType)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
	SampleToHistogramFilter ()
virtual	~SampleToHistogramFilter ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	SampleToHistogramFilter (const Self &)
HistogramMeasurementType	SafeAssign (MeasurementType from) const
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime

---

Detailed Description

template<class TSample, class 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

Wiki Examples:

• All Examples

• Create a histogram from a list of sample measurements

Definition at line 55 of file itkSampleToHistogramFilter.h.

---

Member Typedef Documentation

template<class TSample , class THistogram >

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

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef Superclass::DataObjectPointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::DataObjectPointer

Type for the data object output

Reimplemented from itk::ProcessObject.

Definition at line 80 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::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

Reimplemented from itk::ProcessObject.

Definition at line 148 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef HistogramType::MeasurementType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramMeasurementType

Definition at line 76 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef HistogramType::MeasurementVectorType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramMeasurementVectorType

Definition at line 77 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef HistogramType::SizeType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramSizeType

Definition at line 75 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef THistogram itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramType

Definition at line 72 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

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

Type of DataObjects to use for AutoMinimumMaximum input

Definition at line 106 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

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

Type of DataObjects to use for Marginal Scale inputs

Definition at line 98 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

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

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

Definition at line 103 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

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

Type of DataObjects to use for Size inputs

Definition at line 94 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef MeasurementVectorType::ValueType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MeasurementType

Definition at line 74 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef SampleType::MeasurementVectorType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MeasurementVectorType

Definition at line 73 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

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

Reimplemented from itk::ProcessObject.

Definition at line 61 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef TSample itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleType

MeasurementVector typedef support

Definition at line 68 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef SampleToHistogramFilter itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Self

Standard class typedefs

Reimplemented from itk::ProcessObject.

Definition at line 59 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

typedef ProcessObject itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 60 of file itkSampleToHistogramFilter.h.

---

Constructor & Destructor Documentation

template<class TSample , class THistogram >

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

protected

template<class TSample , class THistogram >

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

protectedvirtual

template<class TSample , class THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleToHistogramFilter ( const Self &  )

private

---

Member Function Documentation

template<class TSample , class THistogram >

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

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

protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >

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

virtual

template<class TSample , class THistogram >

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

virtual

Run-time type information (and related methods)

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >

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

(

)

const

Get the output Histogram

template<class TSample , class THistogram >

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

virtual

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

template<class TSample , class THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro	(	HistogramSize	,
		HistogramSizeType
	)

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

template<class TSample , class THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro	(	MarginalScale	,
		HistogramMeasurementType
	)

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

template<class TSample , class THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro	(	HistogramBinMinimum	,
		HistogramMeasurementVectorType
	)

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

template<class TSample , class THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro	(	HistogramBinMaximum	,
		HistogramMeasurementVectorType
	)

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

template<class TSample , class THistogram >

itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro	(	AutoMinimumMaximum	,
		bool
	)

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

template<class TSample , class THistogram >

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

protectedvirtual

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.

template<class TSample , class THistogram >

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

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TSample , class THistogram >

void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::operator= ( const Self &  )

private

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >

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

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >

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

inlineprivate

SafeAssign – avoid numeric overflow/underflow

Definition at line 161 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >

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

virtual

Set/Get the input sample

---

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

• itkSampleToHistogramFilter.h