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:

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 TMeasurement MeasurementType
typedef Superclass::MeasurementVectorType MeasurementVectorType
typedef Superclass::InstanceIdentifier InstanceIdentifier
typedef MeasurementVectorType ValueType
typedef TFrequencyContainer FrequencyContainerType
typedef FrequencyContainerType::Pointer FrequencyContainerPointer
typedef FrequencyContainerType::FrequencyType FrequencyType
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 Methods

virtual const char * GetClassName () const
 itkStaticConstMacro (MeasurementVectorSize, unsigned int, VMeasurementVectorSize)
void Initialize (const SizeType &size)
void Initialize (const SizeType &size, MeasurementVectorType lowerBound, MeasurementVectorType upperBound)
IndexType & GetIndex (const MeasurementVectorType &measurement)
IndexType & GetIndex (const InstanceIdentifier &id)
bool IsIndexOutOfBound (const IndexType &index) const
InstanceIdentifier GetInstanceIdentifier (const IndexType &index) const
unsigned int GetNumberOfInstances () const
unsigned int Size () const
unsigned int Size (const unsigned int &dimension) const
SizeType GetSize () const
SizeValueType GetSize (const unsigned int dimension) const
MeasurementType & GetBinMin (const unsigned int dimension, const unsigned long nbin)
MeasurementType & GetBinMax (const unsigned int dimension, const unsigned long nbin)
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)
MeasurementType & GetBinMinFromValue (const unsigned int dimension, const float value) const
MeasurementType & GetBinMaxFromValue (const unsigned int dimension, const float value) const
BinMinVectorType & GetDimensionMins (const unsigned int dimension) const
BinMaxVectorType & GetDimensionMaxs (const unsigned int dimension) const
BinMinContainerType & GetMins () 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)
void SetFrequency (const InstanceIdentifier &id, const FrequencyType value)
void SetFrequency (const IndexType &index, const FrequencyType value)
void SetFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
void IncreaseFrequency (const InstanceIdentifier &id, const FrequencyType value)
void IncreaseFrequency (const IndexType &index, const FrequencyType value)
void IncreaseFrequency (const MeasurementVectorType &measurement, const FrequencyType value)
MeasurementVectorType & GetMeasurementVector (const InstanceIdentifier &id)
MeasurementVectorType & GetMeasurementVector (const IndexType &index)
MeasurementType & GetMeasurement (const unsigned long n, const unsigned int dimension) const
FrequencyType GetFrequency (const unsigned long n, const unsigned int dimension) const
FrequencyType GetTotalFrequency (const unsigned int &dimension) const
Iterator Begin ()
Iterator End ()
double Quantile (const unsigned int dimension, const double &p)

Static Public Methods

Pointer New ()

Protected Methods

 Histogram ()
virtual ~Histogram ()
void PrintSelf (std::ostream &os, Indent indent) const

Protected Attributes

SizeType m_Size
std::vector< std::vector<
MeasurementType > > 		m_Min
std::vector< std::vector<
MeasurementType > > 		m_Max

Friends

class Iterator

Detailed Description

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

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

Users can set arbitrary value for each bins min max value for each dimension (variable interval). Each dimension of the histogram represents each dimension of measurement vectors. For example, an Image with each pixel having a gray level intensity value and a gradient magnitude can be imported to this class. Then the resulting Histogram has two dimensions, intensity and gradient magnitude.

Before any operation, users have to call Initialize(SizeType) method to prepare the indexing mechanism and the internal frequency container. After this, users want to set range of each bin using SetBinMin(dimension, n) and SetBinMax(dimension, n) methods.

The first two template arguments are same as those of Sample. The last one, "TFrequencyContainter", is the type of the internal frequency container. If you think your Histogram is dense, in other words, almost every bin is used, then use default. If you expect that a very little portion of bins will be used, replace it with SparseFrequencyContainer class

Since this class is n-dimensional, it supports data access methods using ITK Index type in addition to the methods using "InstanceIdentifiers".

See also:
Sample, DenseFrequencyContainer, SparseFrequencyContainer

Definition at line 65 of file itkHistogram.h.

Member Typedef Documentation

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

Definition at line 111 of file itkHistogram.h.

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

Definition at line 109 of file itkHistogram.h.

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

Definition at line 110 of file itkHistogram.h.

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

bin min max value storage types

Definition at line 108 of file itkHistogram.h.

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

Definition at line 94 of file itkHistogram.h.

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

frequency container typedef

Definition at line 93 of file itkHistogram.h.

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

Frequency value type from superclass

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

Definition at line 97 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
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 100 of file itkHistogram.h.

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

Definition at line 101 of file itkHistogram.h.

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

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

Definition at line 89 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
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 85 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
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 88 of file itkHistogram.h.

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

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

Definition at line 72 of file itkHistogram.h.

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

Standard typedefs

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

Definition at line 70 of file itkHistogram.h.

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

size array type

Definition at line 104 of file itkHistogram.h.

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

Definition at line 105 of file itkHistogram.h.

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

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

Definition at line 71 of file itkHistogram.h.

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

Definition at line 90 of file itkHistogram.h.

Constructor & Destructor Documentation

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

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

Definition at line 382 of file itkHistogram.h.

Member Function Documentation

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

Definition at line 302 of file itkHistogram.h.

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

Definition at line 308 of file itkHistogram.h.

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

Method to get maximum value of n th bin of dimension d

Definition at line 171 of file itkHistogram.h.

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

Method to get the maximum of the bin corresponding to the gray level of dimension d.

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

Method to get minimum value of n th bin of dimension d

Definition at line 166 of file itkHistogram.h.

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

Method to get the minimum of the bin corresponding to the gray level of dimension d.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
virtual const char* itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetClassName (    )  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< float >>
BinMaxVectorType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetDimensionMaxs (  const unsigned int    dimension )  const [inline]
 

Method to get the maximum vector of a dimension

Definition at line 200 of file itkHistogram.h.

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

Method to get the minimum vector of a dimension

Definition at line 196 of file itkHistogram.h.

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

returns the frequency of the'dimension' dimension's 'n'th element.

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

returns frequency of a bin that is indexed by index

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

Method to get the frequency from histogram

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

Definition at line 226 of file itkHistogram.h.

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

Method to get maxs in the histogram by index

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

Method to get maxs of each dimension for a measurement in the histogram

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

Method to get mins in the histogram by index

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

Method to get mins of each dimension for a measurement in the histogram

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
IndexType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetIndex (  const InstanceIdentifier &    id ) 
 

returns 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< float >>
IndexType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetIndex (  const MeasurementVectorType &    measurement ) 
 

returns the index of histogram corresponding to measurement value

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

returns the instance identifier of the cell 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< float >>
BinMaxContainerType& itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::GetMaxs (    )  const [inline]
 

Method to get the maximum vector

Definition at line 208 of file itkHistogram.h.

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

Method to get measurement from the histogram

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

Method to get measurement from the histogram

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

Method to get measurement from the histogram using an instance identifier

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

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

Method to get the minimum vector

Definition at line 204 of file itkHistogram.h.

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

Get the total number of instances in this container

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

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

return the size of each dimension of the measurement vector container

Definition at line 160 of file itkHistogram.h.

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

Method to get m_Size

Definition at line 156 of file itkHistogram.h.

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

returns the frequency of the 'dimension' dimension

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

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

Method to increase the frequency by one. This function is convinent to create histogram.

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

Method to increase the frequency by one. This function is convinent to create histogram.

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

Method to increase the frequency by one. This function is convinent to create histogram.

Definition at line 250 of file itkHistogram.h.

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

Do the same thing as the above Initialize(SizeType) method do , and also creates equal size bins within the range given by lower and upper bound. If users want 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< float >>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Initialize (  const SizeType &    size ) 
 

generates the offset table. subclasses should call this method in their initialize() method the overide methods have prepare the frequency container for input and output.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
bool itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::IsIndexOutOfBound (  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< float >>
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< float >>
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< float >>
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< float >>
double itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::Quantile (  const unsigned int    dimension,
const double &    p
) 
 

returns 'p'th percentile value. 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< float >>
void itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::SetBinMax (  const unsigned int    dimension,
unsigned long    nbin,
const MeasurementType    max
)  [inline]
 

Method to set maximum value of n th bin of dimension d

Definition at line 181 of file itkHistogram.h.

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

Method to set minimum value of n th bin of dimension d

Definition at line 176 of file itkHistogram.h.

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

Method to set the frequency corresponding to gray levels measurement

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

Method to set the frequency of histogram

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

Method to set the frequency of histogram

Definition at line 236 of file itkHistogram.h.

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

Method to set the frequency of histogram

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

Returns the number of bins along the "dimension"

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

Definition at line 152 of file itkHistogram.h.

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

Friends And Related Function Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
friend class Iterator [friend]
 

Definition at line 300 of file itkHistogram.h.

Member Data Documentation

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
std::vector< std::vector<MeasurementType> > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::m_Max [protected]
 

Definition at line 392 of file itkHistogram.h.

template<class TMeasurement = float, unsigned int VMeasurementVectorSize = 1, class TFrequencyContainer = DenseFrequencyContainer< float >>
std::vector< std::vector<MeasurementType> > itk::Statistics::Histogram< TMeasurement, VMeasurementVectorSize, TFrequencyContainer >::m_Min [protected]
 

Definition at line 389 of file itkHistogram.h.

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

Definition at line 386 of file itkHistogram.h.

The documentation for this class was generated from the following file:
Generated at Fri May 21 01:52:53 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000