Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer > Class Template Reference

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

#include <itkHistogram.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef Histogram Self
typedef Sample< FixedArray<
TMeasurement, VMeasurementVectorSize > > 		Superclass
typedef SmartPointer< Self > Pointer
typedef SmartPointer< const
Self > 		ConstPointer
typedef TMeasurement MeasurementType
typedef Superclass::MeasurementVectorType MeasurementVectorType
typedef Superclass::InstanceIdentifier InstanceIdentifier
typedef MeasurementVectorType ValueType
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
typedef TFrequencyContainer FrequencyContainerType
typedef FrequencyContainerType::Pointer FrequencyContainerPointer
typedef FrequencyContainerType::FrequencyType FrequencyType
typedef FrequencyContainerType::TotalFrequencyType TotalFrequencyType
typedef itk::Index< VMeasurementVectorSize > IndexType
typedef IndexType::IndexValueType IndexValueType
typedef itk::Size< VMeasurementVectorSize > SizeType
typedef SizeType::SizeValueType 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
 itkStaticConstMacro (MeasurementVectorSize, unsigned int, VMeasurementVectorSize)
void Initialize (const SizeType &size)
void Initialize (const SizeType &size, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound)
void SetToZero ()
const IndexType & GetIndex (const MeasurementVectorType &measurement) const
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 & 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
virtual void SetMeasurementVectorSize (const MeasurementVectorSizeType s)
MeasurementVectorSizeType GetMeasurementVectorSize () 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
 Histogram ()
virtual ~Histogram ()

Protected Attributes

SizeType m_Size

Detailed Description

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
class itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 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.

If you do not know the length of the measurement vector at compile time, you can set the second template parameter to 0. This can conveniently be obtained from MeasurementVectorTraits. For instance, instantiate a histogram as below:

 typedef Histogram< THistogramMeasurement, typename 
      MeasurementVectorTraits< MeasurementVectorType >::MeasurementVectorLength,
      TFrequencyContainer > HistogramType;

See also:
Sample, DenseFrequencyContainer, SparseFrequencyContainer

Definition at line 82 of file itkHistogram.h.

Member Typedef Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< BinMaxVectorType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMaxContainerType
 

Definition at line 134 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< MeasurementType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMaxVectorType
 

Definition at line 132 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< BinMinVectorType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMinContainerType
 

Definition at line 133 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef std::vector< MeasurementType > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::BinMinVectorType
 

bin min max value storage types

Definition at line 131 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef SmartPointer<const Self> itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::ConstPointer
 

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 92 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::Pointer itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::FrequencyContainerPointer
 

Definition at line 116 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef TFrequencyContainer itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::FrequencyContainerType
 

frequency container typedef

Definition at line 115 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::FrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::FrequencyType
 

Frequency and TotalFrequency value type from superclass

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 119 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef itk::Index< VMeasurementVectorSize > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IndexType
 

Index typedef support. An index is used to access pixel values.

Definition at line 123 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef IndexType::IndexValueType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IndexValueType
 

Definition at line 124 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::InstanceIdentifier itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::InstanceIdentifier
 

InstanceIdentifier typedef. This identifier is a unique sequential id for each measurement vector in a Sample subclass.

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 110 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef TMeasurement itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::MeasurementType
 

type of an element of a measurement vector

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 106 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::MeasurementVectorSizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::MeasurementVectorSizeType
 

Typedef for the length of each measurement vector

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 112 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Superclass::MeasurementVectorType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::MeasurementVectorType
 

Common sample class typedefs

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 109 of file itkHistogram.h.

Referenced by itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::ConstIterator::GetInstanceIdentifier(), and itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Iterator::GetInstanceIdentifier().

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef SmartPointer<Self> itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Pointer
 

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 91 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Histogram itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Self
 

Standard typedefs

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 89 of file itkHistogram.h.

Referenced by itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::ConstIterator::ConstIterator(), and itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Iterator::Iterator().

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef itk::Size< VMeasurementVectorSize > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SizeType
 

size array type

Definition at line 127 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef SizeType::SizeValueType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SizeValueType
 

Definition at line 128 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef Sample< FixedArray< TMeasurement, VMeasurementVectorSize > > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Superclass
 

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 90 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef FrequencyContainerType::TotalFrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::TotalFrequencyType
 

Total frequency type

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 120 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
typedef MeasurementVectorType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::ValueType
 

Definition at line 111 of file itkHistogram.h.

Constructor & Destructor Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Histogram (   )  [protected]
 

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::~Histogram (   )  [inline, protected, virtual]
 

Definition at line 514 of file itkHistogram.h.

Member Function Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
ConstIterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Begin (  void   )  const [inline]
 

Definition at line 486 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
Iterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Begin (  void   )  [inline]
 

Definition at line 475 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
ConstIterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::End (  void   )  const [inline]
 

Definition at line 492 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
Iterator itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::End (  void   )  [inline]
 

Definition at line 481 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 203 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 198 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetClipBinsAtEnds (   )  [virtual]
 

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

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

Get the vector of maximums along a dimension

Definition at line 232 of file itkHistogram.h.

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

Get the vector of bin minimums along a dimension

Definition at line 228 of file itkHistogram.h.

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

Get the frequency of a dimension's nth element.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
FrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetFrequency (  const IndexType &  index  )  const
 

Get the frequency of an index

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

Get the frequency of an instance indentifier

Implements itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 259 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetHistogramMaxFromIndex (  const IndexType &  index  ) 
 

Get the maximums of the bin corresponding to a particular index

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetHistogramMinFromIndex (  const IndexType &  index  ) 
 

Get the minimums of the bin corresponding to a particular index

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const IndexType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const IndexType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetIndex (  const MeasurementVectorType &  measurement  )  const
 

Get the index of a measurement value from the histogram.

Deprecated:
Use GetIndex(const MeasurementVectorType & measurement, IndexType & index ) const instead.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
InstanceIdentifier itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const BinMaxContainerType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMaxs (   )  const [inline]
 

Method the maximums of the bins

Definition at line 240 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMeasurementVector (  const IndexType &  index  )  const
 

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const MeasurementVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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< FixedArray< TMeasurement, VMeasurementVectorSize > >.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
MeasurementVectorSizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMeasurementVectorSize (   )  const [inline, virtual]
 

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 506 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
const BinMinContainerType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMins (   )  const [inline]
 

Get the minimums of the bins

Definition at line 236 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual const char* itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetNameOfClass (   )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

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

Get the size of histogram along a specified dimension

Definition at line 192 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
SizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetSize (  void   )  const [inline]
 

Get the size (N-dimensional) of the histogram

Definition at line 188 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
TotalFrequencyType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetTotalFrequency (   )  const [virtual]
 

Get the total frequency in the histogram

Implements itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 287 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::itkStaticConstMacro (  MeasurementVectorSize  ,
unsigned  int,
VMeasurementVectorSize 
) 
 

Dimension of a measurement vector

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
Pointer itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::New (   )  [static]
 

standard New() method support

Reimplemented from itk::Object.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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< FixedArray< TMeasurement, VMeasurementVectorSize > >.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
double itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 213 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 208 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetClipBinsAtEnds (  bool  _arg  )  [virtual]
 

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

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, 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 270 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetFrequency (  const FrequencyType  value  ) 
 

Set all the bins in the histogram to a specified frequency

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
virtual void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetMeasurementVectorSize (  const MeasurementVectorSizeType  s  )  [inline, virtual]
 

Set/Get macros for the length of the measurement vector

Reimplemented from itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Definition at line 497 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetToZero (   ) 
 

Initialize the values of the histogram bins to zero

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

Returns the number of instances (bins or cells) in this container

Implements itk::Statistics::Sample< FixedArray< TMeasurement, VMeasurementVectorSize > >.

Member Data Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer>
SizeType itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::m_Size [protected]
 

Definition at line 517 of file itkHistogram.h.

The documentation for this class was generated from the following file:
Generated at Thu May 25 03:05:36 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000