#include <itkHistogram.h>

Inheritance diagram for itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >:

Collaboration diagram for itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >:

Detailed Description

template<typename TMeasurement = float, typename TFrequencyContainer = DenseFrequencyContainer2>
class itk::Statistics::Histogram< TMeasurement, TFrequencyContainer >

This class stores measurement vectors in the context of n-dimensional histogram.

Histogram represents an ND histogram. Histogram bins can be regularly or irregularly spaced. The storage for the histogram is managed via the FrequencyContainer specified by the template argument. The default frequency container is a DenseFrequencyContainer. A SparseFrequencyContainer can be used as an alternative.

Frequencies of a bin (SetFrequency(), IncreaseFrequency()) can be specified by measurement, index, or instance identifier.

Measurements can be queried by bin index or instance identifier. In this case, the measurement returned is the centroid of the histogram bin.

The Initialize() method is used to specify the number of bins for each dimension of the histogram. An overloaded version also allows for regularly spaced bins to defined. To define irregularly sized bins, use the SetBinMin()/SetBinMax() methods.

If you do not know the length of the measurement vector at compile time, you should use the VariableDimensionHistogram class, instead of the Histogram class.

If you know the length of the measurement vector at compile time, it can conveniently be obtained from MeasurementVectorTraits. For instance, instantiate a histogram as below:

using HistogramType = Histogram< THistogramMeasurement, typename TFrequencyContainer >;

See Also: Sample, DenseFrequencyContainer, SparseFrequencyContainer, VariableDimensionHistogram

Wiki Examples:

Examples:: Examples/Statistics/Histogram.cxx, Examples/Statistics/ImageHistogram1.cxx, Examples/Statistics/SampleToHistogramFilter.cxx, SphinxExamples/src/Numerics/Statistics/HistogramCreationAndBinAccess/Code.cxx, WikiExamples/Statistics/Histogram.cxx, and WikiExamples/Statistics/SampleToHistogramFilter.cxx.

Definition at line 77 of file itkHistogram.h.

Classes
class	ConstIterator

class	Iterator

Public Types
using	AbsoluteFrequencyType = typename FrequencyContainerType::AbsoluteFrequencyType

using	ArrayType = Array< TMeasurement >

using	BinMaxContainerType = std::vector< BinMaxVectorType >

using	BinMaxVectorType = std::vector< MeasurementType >

using	BinMinContainerType = std::vector< BinMinVectorType >

using	BinMinVectorType = std::vector< MeasurementType >

using	ConstPointer = SmartPointer< const Self >

using	FrequencyContainerPointer = typename FrequencyContainerType::Pointer

using	FrequencyContainerType = TFrequencyContainer

using	IndexType = Array< ::itk::IndexValueType >

using	IndexValueType = typename IndexType::ValueType

using	InstanceIdentifier = typename Superclass::InstanceIdentifier

using	MeasurementType = TMeasurement

using	MeasurementVectorSizeType = typename Superclass::MeasurementVectorSizeType

using	MeasurementVectorType = typename Superclass::MeasurementVectorType

using	Pointer = SmartPointer< Self >

using	RelativeFrequencyType = typename FrequencyContainerType::RelativeFrequencyType

using	Self = Histogram

using	SizeType = Array< ::itk::SizeValueType >

using	SizeValueType = typename SizeType::ValueType

using	Superclass = Sample< ArrayType >

using	TotalAbsoluteFrequencyType = typename FrequencyContainerType::TotalAbsoluteFrequencyType

using	TotalRelativeFrequencyType = typename FrequencyContainerType::TotalRelativeFrequencyType

using	ValueType = MeasurementVectorType

Public Types inherited from itk::Statistics::Sample< Array< TMeasurement > >
using	AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType

using	ConstPointer = SmartPointer< const Self >

using	InstanceIdentifier = typename MeasurementVectorTraits::InstanceIdentifier

using	MeasurementType = typename MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType

using	MeasurementVectorSizeType = unsigned int

using	MeasurementVectorType = Array< TMeasurement >

using	Pointer = SmartPointer< Self >

using	Self = Sample

using	Superclass = DataObject

using	TotalAbsoluteFrequencyType = NumericTraits< AbsoluteFrequencyType >::AccumulateType

Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

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

ConstIterator	Begin () const

virtual ::itk::LightObject::Pointer	CreateAnother () const

Iterator	End ()

ConstIterator	End () const

const MeasurementType &	GetBinMax (unsigned int dimension, InstanceIdentifier nbin) const

const MeasurementType &	GetBinMaxFromValue (unsigned int dimension, float value) const

const MeasurementType &	GetBinMin (unsigned int dimension, InstanceIdentifier nbin) const

const MeasurementType &	GetBinMinFromValue (unsigned int dimension, float value) const

virtual bool	GetClipBinsAtEnds () const

const BinMaxVectorType &	GetDimensionMaxs (unsigned int dimension) const

const BinMinVectorType &	GetDimensionMins (unsigned int dimension) const

AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const override

AbsoluteFrequencyType	GetFrequency (const IndexType &index) const

AbsoluteFrequencyType	GetFrequency (InstanceIdentifier n, unsigned int dimension) const

const MeasurementVectorType &	GetHistogramMaxFromIndex (const IndexType &index) const

const MeasurementVectorType &	GetHistogramMinFromIndex (const IndexType &index) const

bool	GetIndex (const MeasurementVectorType &measurement, IndexType &index) const

const IndexType &	GetIndex (InstanceIdentifier id) const

InstanceIdentifier	GetInstanceIdentifier (const IndexType &index) const

const BinMaxContainerType &	GetMaxs () const

MeasurementType	GetMeasurement (InstanceIdentifier n, unsigned int dimension) const

const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const override

const MeasurementVectorType &	GetMeasurementVector (const IndexType &index) const

const BinMinContainerType &	GetMins () const

virtual const char *	GetNameOfClass () const

const SizeType &	GetSize () const

SizeValueType	GetSize (unsigned int dimension) const

TotalAbsoluteFrequencyType	GetTotalFrequency () const override

void	Graft (const DataObject *) override

bool	IncreaseFrequency (InstanceIdentifier id, AbsoluteFrequencyType value)

bool	IncreaseFrequencyOfIndex (const IndexType &index, AbsoluteFrequencyType value)

bool	IncreaseFrequencyOfMeasurement (const MeasurementVectorType &measurement, AbsoluteFrequencyType value)

void	Initialize (const SizeType &size)

void	Initialize (const SizeType &size, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound)

bool	IsIndexOutOfBounds (const IndexType &index) const

double	Mean (unsigned int dimension) const

void	SetBinMax (unsigned int dimension, InstanceIdentifier nbin, MeasurementType max)

void	SetBinMin (unsigned int dimension, InstanceIdentifier nbin, MeasurementType min)

virtual void	SetClipBinsAtEnds (bool _arg)

void	SetFrequency (AbsoluteFrequencyType value)

bool	SetFrequency (InstanceIdentifier id, AbsoluteFrequencyType value)

bool	SetFrequencyOfIndex (const IndexType &index, AbsoluteFrequencyType value)

bool	SetFrequencyOfMeasurement (const MeasurementVectorType &measurement, AbsoluteFrequencyType value)

void	SetToZero ()

InstanceIdentifier	Size () const override


double	Quantile (unsigned int dimension, double p) const

Public Member Functions inherited from itk::Statistics::Sample< Array< TMeasurement > >
virtual AbsoluteFrequencyType	GetFrequency (InstanceIdentifier id) const =0

virtual const MeasurementVectorType &	GetMeasurementVector (InstanceIdentifier id) const =0

virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const

void	Graft (const DataObject *thatObject) override

virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType s)

Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)

virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

virtual void	SetRequestedRegion (const DataObject *)

virtual void	SetRequestedRegionToLargestPossibleRegion ()

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

virtual bool	VerifyRequestedRegion ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

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 noexceptoverride

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::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

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

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

	~Histogram () override=default

Protected Member Functions inherited from itk::Statistics::Sample< Array< TMeasurement > >
void	PrintSelf (std::ostream &os, Indent indent) const override

	Sample ()

	~Sample () override=default

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

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

Protected Attributes
SizeType	m_Size

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

Private Types
using	OffsetTableType = std::vector< InstanceIdentifier >

Private Member Functions
void	Initialize () override

Private Attributes
bool	m_ClipBinsAtEnds {true}

FrequencyContainerPointer	m_FrequencyContainer

std::vector< std::vector < MeasurementType > >	m_Max

std::vector< std::vector < MeasurementType > >	m_Min

unsigned int	m_NumberOfInstances {0}

OffsetTableType	m_OffsetTable

IndexType	m_TempIndex

MeasurementVectorType	m_TempMeasurementVector