itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer > Class Template Reference

This class is similar to the Histogram class. It however allows you to specify the histogram dimension at run time. (and is therefore not templated over the size of a measurement vector). Users who know that the length of a measurement vector will be fixed, for instance joint statistics on pixel values of 2 images, (where the dimension will be 2), etc should use the Histogram class instead. More...

#include <itkVariableDimensionHistogram.h>

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

[legend]Collaboration diagram for itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >:

[legend]List of all members.

Public Types
typedef VariableDimensionHistogram	Self
typedef Sample< Array< TMeasurement > >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TMeasurement	MeasurementType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::InstanceIdentifier	InstanceIdentifier
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef MeasurementVectorType	ValueType
typedef TFrequencyContainer	FrequencyContainerType
typedef FrequencyContainerType::Pointer	FrequencyContainerPointer
typedef FrequencyContainerType::FrequencyType	FrequencyType
typedef FrequencyContainerType::TotalFrequencyType	TotalFrequencyType
typedef itk::Array< long >	IndexType
typedef IndexType::ValueType	IndexValueType
typedef itk::Array< long >	SizeType
typedef SizeType::ValueType	SizeValueType
typedef std::vector< MeasurementType >	BinMinVectorType
typedef std::vector< MeasurementType >	BinMaxVectorType
typedef std::vector< BinMinVectorType >	BinMinContainerType
typedef std::vector< BinMaxVectorType >	BinMaxContainerType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	Initialize (const SizeType &size)
void	Initialize (const SizeType &size, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound)
void	SetToZero ()
bool	GetIndex (const MeasurementVectorType &measurement, IndexType &index) const
const IndexType &	GetIndex (const InstanceIdentifier &id) const
virtual bool	GetClipBinsAtEnds ()
virtual void	SetClipBinsAtEnds (bool _arg)
bool	IsIndexOutOfBounds (const IndexType &index) const
InstanceIdentifier	GetInstanceIdentifier (const IndexType &index) const
unsigned int	Size () const
SizeType	GetSize () const
SizeValueType	GetSize (const unsigned int dimension) const
const MeasurementType &	GetBinMin (const unsigned int dimension, const unsigned long nbin) const
const MeasurementType &	GetBinMax (const unsigned int dimension, const unsigned long nbin) const
void	SetBinMin (const unsigned int dimension, const unsigned long nbin, const MeasurementType min)
void	SetBinMax (const unsigned int dimension, unsigned long nbin, const MeasurementType max)
const MeasurementType &	GetBinMinFromValue (const unsigned int dimension, const float value) const
const MeasurementType &	GetBinMaxFromValue (const unsigned int dimension, const float value) const
const BinMinVectorType &	GetDimensionMins (const unsigned int dimension) const
const BinMaxVectorType &	GetDimensionMaxs (const unsigned int dimension) const
const BinMinContainerType &	GetMins () const
const BinMaxContainerType &	GetMaxs () const
MeasurementVectorType &	GetHistogramMinFromValue (const MeasurementVectorType &measurement)
MeasurementVectorType &	GetHistogramMaxFromValue (const MeasurementVectorType &measurement)
MeasurementVectorType &	GetHistogramMinFromIndex (const IndexType &index)
MeasurementVectorType &	GetHistogramMaxFromIndex (const IndexType &index)
FrequencyType	GetFrequency (const InstanceIdentifier &id) const
FrequencyType	GetFrequency (const IndexType &index) const
void	SetFrequency (const FrequencyType value)
bool	SetFrequency (const InstanceIdentifier &id, const FrequencyType value)
bool	SetFrequency (const IndexType &index, const FrequencyType value)
bool	SetFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
bool	IncreaseFrequency (const InstanceIdentifier &id, const FrequencyType value)
bool	IncreaseFrequency (const IndexType &index, const FrequencyType value)
bool	IncreaseFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
const MeasurementVectorType &	GetMeasurementVector (const InstanceIdentifier &id) const
const MeasurementVectorType &	GetMeasurementVector (const IndexType &index) const
MeasurementType	GetMeasurement (const unsigned long n, const unsigned int dimension) const
TotalFrequencyType	GetTotalFrequency () const
FrequencyType	GetFrequency (const unsigned long n, const unsigned int dimension) const
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
double	Quantile (const unsigned int dimension, const double &p) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	VariableDimensionHistogram ()
virtual	~VariableDimensionHistogram ()
void	SetMeasurementVectorSize (const MeasurementVectorSizeType)
Protected Attributes
SizeType	m_Size

---

Detailed Description

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer>
class itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >

This class is similar to the Histogram class. It however allows you to specify the histogram dimension at run time. (and is therefore not templated over the size of a measurement vector). Users who know that the length of a measurement vector will be fixed, for instance joint statistics on pixel values of 2 images, (where the dimension will be 2), etc should use the Histogram class instead.

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

VariableDimensionHistogram 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 in the centroid of the histogram bin.

The Initialize() method is used to specified 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.

See also:

Histogram, Sample, DenseFrequencyContainer, SparseFrequencyContainer

Definition at line 71 of file itkVariableDimensionHistogram.h.

---

Member Typedef Documentation

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef std::vector< BinMaxVectorType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMaxContainerType

Definition at line 117 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMaxs().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef std::vector< MeasurementType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMaxVectorType

Definition at line 115 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetDimensionMaxs().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef std::vector< BinMinVectorType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMinContainerType

Definition at line 116 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMins().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef std::vector< MeasurementType > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMinVectorType

bin min max value storage types Definition at line 114 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetDimensionMins().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef SmartPointer<const Self> itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::ConstPointer

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 80 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef FrequencyContainerType::Pointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyContainerPointer

Definition at line 99 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef TFrequencyContainer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyContainerType

frequency container typedef Definition at line 98 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef FrequencyContainerType::FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType

Frequency value and TotalFrequency type from superclass Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 102 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency(), itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency(), and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef itk::Array< long > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IndexType

Index typedef support. An index is used to access pixel values. Definition at line 106 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef IndexType::ValueType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IndexValueType

Definition at line 107 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef Superclass::InstanceIdentifier itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass. Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 93 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency(), itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency(), and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef TMeasurement itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType

type of an element of a measurement vector Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 89 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMax(), itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMin(), itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetBinMax(), and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetBinMin().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef Superclass::MeasurementVectorSizeType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorSizeType

Typedef for the length of each measurement vector Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 94 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::~VariableDimensionHistogram().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef Superclass::MeasurementVectorType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorType

Common sample class typedefs Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 92 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef SmartPointer<Self> itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Pointer

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 79 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef VariableDimensionHistogram itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Self

Standard typedefs Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 77 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::ConstIterator::ConstIterator(), and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Iterator::Iterator().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef itk::Array< long > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeType

size array type Definition at line 110 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetSize(), and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::~VariableDimensionHistogram().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef SizeType::ValueType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeValueType

Definition at line 111 of file itkVariableDimensionHistogram.h. Referenced by itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetSize().

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef Sample< Array< TMeasurement > > itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Superclass

Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 78 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef FrequencyContainerType::TotalFrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::TotalFrequencyType

Total frequency type Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 103 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> typedef MeasurementVectorType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::ValueType

Definition at line 95 of file itkVariableDimensionHistogram.h.

---

Constructor & Destructor Documentation

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::VariableDimensionHistogram (   )  [protected]

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> virtual itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::~VariableDimensionHistogram (   )  [inline, protected, virtual]

Definition at line 482 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementVectorSizeType, and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeType.

---

Member Function Documentation

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> ConstIterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Begin (  void   )  const [inline]

Definition at line 468 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> Iterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Begin (  void   )  [inline]

Definition at line 457 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> ConstIterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::End (  void   )  const [inline]

Definition at line 474 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> Iterator itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::End (  void   )  [inline]

Definition at line 463 of file itkVariableDimensionHistogram.h.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMax (  const unsigned int  dimension, const unsigned long  nbin )  const [inline]

Get the maximum value of nth bin of dimension d Definition at line 181 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMaxFromValue (  const unsigned int  dimension, const float  value )  const

Get the maximum of the bin along dimension d corresponding to a particular measurement.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMin (  const unsigned int  dimension, const unsigned long  nbin )  const [inline]

Get the minimum value of nth bin of dimension d Definition at line 176 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const MeasurementType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetBinMinFromValue (  const unsigned int  dimension, const float  value )  const

Get the minimum of the bin along dimension d corresponding to a particular measurement.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> virtual bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetClipBinsAtEnds (   )  [virtual]

Is set to false if the bins at edges of the histogram extend to +/- infinity.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const BinMaxVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetDimensionMaxs (  const unsigned int  dimension  )  const [inline]

Get the vector of maximums along a dimension Definition at line 210 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMaxVectorType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const BinMinVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetDimensionMins (  const unsigned int  dimension  )  const [inline]

Get the vector of bin minimums along a dimension Definition at line 206 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMinVectorType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency (  const unsigned long  n, const unsigned int  dimension )  const

Get the frequency of a dimension's nth element.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency (  const IndexType &  index  )  const

Get the frequency of an index

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> FrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetFrequency (  const InstanceIdentifier &  id  )  const [inline, virtual]

Get the frequency of an instance indentifier Implements itk::Statistics::Sample< Array< TMeasurement > >. Definition at line 236 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType, and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> MeasurementVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMaxFromIndex (  const IndexType &  index  )

Get the maximums of the bin corresponding to a particular index

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> MeasurementVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMaxFromValue (  const MeasurementVectorType &  measurement  )

Get the maximums of the bin corresponding to a particular measurement

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> MeasurementVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMinFromIndex (  const IndexType &  index  )

Get the minimums of the bin corresponding to a particular index

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> MeasurementVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetHistogramMinFromValue (  const MeasurementVectorType &  measurement  )

Get the minimums of the bin corresponding to a particular measurement

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const IndexType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetIndex (  const InstanceIdentifier &  id  )  const

Get the index that is uniquely labelled by an instance identifier The corresponding id is the offset of the index This method uses ImageBase::ComputeIndex() method

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetIndex (  const MeasurementVectorType &  measurement, IndexType &  index )  const

Get the index of histogram corresponding to the specified measurement value. Returns true if index is valid and false if the measurement is outside the histogram

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> InstanceIdentifier itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetInstanceIdentifier (  const IndexType &  index  )  const

Get the instance identifier of the bin that is indexed by the index. The corresponding instance identifier is the offset of the index This method uses ImageBase::ComputeIndex() method

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const BinMaxContainerType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMaxs (   )  const [inline]

Method the maximums of the bins Definition at line 218 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMaxContainerType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> MeasurementType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMeasurement (  const unsigned long  n, const unsigned int  dimension )  const

Get the measurement a bin along a specified dimension. This is the midpoint of the bin along that dimension.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const MeasurementVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMeasurementVector (  const IndexType &  index  )  const

Get the measurement of an index. This is the centroid of the bin.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const MeasurementVectorType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMeasurementVector (  const InstanceIdentifier &  id  )  const [virtual]

Get the measurement of an instance identifier. This is the centroid of the bin. Implements itk::Statistics::Sample< Array< TMeasurement > >.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> const BinMinContainerType& itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetMins (   )  const [inline]

Get the minimums of the bins Definition at line 214 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::BinMinContainerType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> virtual const char* itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> SizeValueType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetSize (  const unsigned int  dimension  )  const [inline]

Get the size of histogram along a specified dimension Definition at line 170 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeValueType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> SizeType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetSize (  void   )  const [inline]

Get the size (N-dimensional) of the histogram Definition at line 166 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SizeType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> TotalFrequencyType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::GetTotalFrequency (   )  const [virtual]

Get the total frequency in the histogram Implements itk::Statistics::Sample< Array< TMeasurement > >.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency (  const MeasurementVectorType &  measurement, const FrequencyType  value )

Increase the frequency of a measurement. Frequency is increased by the specified value. Returns false if the measurement is outside the bounds of the histogram.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency (  const IndexType &  index, const FrequencyType  value )

Increase the frequency of an index. Frequency is increased by the specified value. Returns false if the bin is out of bounds.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IncreaseFrequency (  const InstanceIdentifier &  id, const FrequencyType  value )  [inline]

Increase the frequency of an instance identifier. Frequency is increased by the specified value. Returns false if the bin is out of bounds. Definition at line 264 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType, and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Initialize (  const SizeType &  size, MeasurementVectorType &  lowerBound, MeasurementVectorType &  upperBound )

Initialize the histogram using equal size bins. To assign bin's min and max values along each dimension use SetBinMin() and SetBinMax() functions.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Initialize (  const SizeType &  size  )

Initialize the histogram, generating the offset table and preparing the frequency container. Subclasses should call this method in their Initialize() method.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::IsIndexOutOfBounds (  const IndexType &  index  )  const

Returns true if the given index is out of bound meaning one of index is not between [0, last index]

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> Pointer itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::New (   )  [static]

standard New() method support Reimplemented from itk::Object.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::Statistics::Sample< Array< TMeasurement > >.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> double itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Quantile (  const unsigned int  dimension, const double &  p )  const

Get the pth percentile value for a dimension. Let assume n = the index of the bin where the p-th percentile value is, min = min value of the dimension of the bin, max = max value of the dimension of the bin, interval = max - min , pp = cumlated proportion until n-1 bin ; and pb = frequency of the bin / total frequency of the dimension. If p is less than 0.5, the percentile value = min + ((p - pp ) / pb) * interval If p is greater than or equal to 0.5 the percentile value = max - ((pp - p) / pb) * interval

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetBinMax (  const unsigned int  dimension, unsigned long  nbin, const MeasurementType  max )  [inline]

Set the maximum value of nth bin of dimension d Definition at line 191 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetBinMin (  const unsigned int  dimension, const unsigned long  nbin, const MeasurementType  min )  [inline]

Set the minimum value of nth bin of dimension d Definition at line 186 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::MeasurementType.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> virtual void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetClipBinsAtEnds (  bool  _arg  )  [virtual]

Set to false to have the bins at edges of the histogram extend to +/- infinity.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency (  const MeasurementVectorType &  measurement, const FrequencyType  value )

Set the frequency of a measurement. Returns false if the bin is out of bounds.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency (  const IndexType &  index, const FrequencyType  value )

Set the frequency of an index. Returns false if the bin is out of bounds.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> bool itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency (  const InstanceIdentifier &  id, const FrequencyType  value )  [inline]

Set the frequency of an instance identifier. Returns false if the bin is out of bounds. Definition at line 247 of file itkVariableDimensionHistogram.h. References itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::FrequencyType, and itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::InstanceIdentifier.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetFrequency (  const FrequencyType  value  )

Set all the bins in the histogram to a specified frequency

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetMeasurementVectorSize (  const  MeasurementVectorSizeType  )  [protected, virtual]

Set the length of each measurement vector = dimension of the histogram. The method will destructively set the size of all other parameters of the histogram. This method should be called only from the Initialize() method. Reimplemented from itk::Statistics::Sample< Array< TMeasurement > >.

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> void itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::SetToZero (   )

Initialize the values of the histogram bins to zero

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> unsigned int itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::Size (   )  const [virtual]

Returns the number of instances (bins or cells) in this container Implements itk::Statistics::Sample< Array< TMeasurement > >.

---

Member Data Documentation

template<class TMeasurement = float, class TFrequencyContainer = DenseFrequencyContainer> SizeType itk::Statistics::VariableDimensionHistogram< TMeasurement, TFrequencyContainer >::m_Size [protected]

Definition at line 490 of file itkVariableDimensionHistogram.h.

---

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

• itkVariableDimensionHistogram.h

---