itk::Statistics::DenseFrequencyContainer< TFrequencyValue > Class Template Reference

his class is a container for an histogram. More...

#include <itkDenseFrequencyContainer.h>

Inheritance diagram for itk::Statistics::DenseFrequencyContainer:

[legend]Collaboration diagram for itk::Statistics::DenseFrequencyContainer< TFrequencyValue >:

[legend]List of all members.

Public Types
typedef DenseFrequencyContainer	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef unsigned long	InstanceIdentifier
typedef TFrequencyValue	FrequencyType
typedef ValarrayImageContainer< InstanceIdentifier, FrequencyType >	FrequencyContainerType
typedef FrequencyContainerType::Pointer	FrequencyContainerPointer
Public Methods
virtual const char *	GetClassName () const
void	Initialize (unsigned long length)
void	SetFrequency (const InstanceIdentifier id, const FrequencyType value)
void	IncreaseFrequency (const InstanceIdentifier id, const FrequencyType value)
FrequencyType	GetFrequency (const InstanceIdentifier id) const
FrequencyType	GetTotalFrequency ()
Static Public Methods
Pointer	New ()
Protected Methods
	DenseFrequencyContainer ()
virtual	~DenseFrequencyContainer ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TFrequencyValue = float>
class itk::Statistics::DenseFrequencyContainer< TFrequencyValue >

his class is a container for an histogram.

This class uses an map to store histogram. If your histogram is dense use DenseFrequencyContainer. You should access each bin by (InstanceIdentifier)index or measurement vector.

Definition at line 37 of file itkDenseFrequencyContainer.h.

---

Member Typedef Documentation

template<class TFrequencyValue = float> typedef FrequencyContainerType::Pointer itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::FrequencyContainerPointer

Definition at line 61 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef ValarrayImageContainer< InstanceIdentifier, FrequencyType > itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::FrequencyContainerType

Histogram typedef support Definition at line 60 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef TFrequencyValue itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::FrequencyType

frequency type alias Definition at line 56 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef unsigned long itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::InstanceIdentifier

instance idenfitifer alias Definition at line 53 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef SmartPointer<Self> itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::Pointer

Reimplemented from itk::Object. Definition at line 44 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef DenseFrequencyContainer itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::Self

Standard class typedefs Reimplemented from itk::Object. Definition at line 42 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef Object itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::Superclass

Reimplemented from itk::Object. Definition at line 43 of file itkDenseFrequencyContainer.h.

---

Constructor & Destructor Documentation

template<class TFrequencyValue = float> itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::DenseFrequencyContainer (    )  [protected]

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

Definition at line 83 of file itkDenseFrequencyContainer.h.

---

Member Function Documentation

template<class TFrequencyValue = float> virtual const char* itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

template<class TFrequencyValue = float> FrequencyType itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::GetFrequency (  const InstanceIdentifier    id )  const

Method to get the frequency of a bin from the histogram

template<class TFrequencyValue = float> FrequencyType itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::GetTotalFrequency (    )  [inline]

Definition at line 78 of file itkDenseFrequencyContainer.h.

template<class TFrequencyValue = float> void itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::IncreaseFrequency (  const InstanceIdentifier    id, const FrequencyType    value )

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

template<class TFrequencyValue = float> void itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::Initialize (  unsigned long    length )

calls the Initialize method of superclass to generate the offset table and prepare the frequency container

template<class TFrequencyValue = float> Pointer itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TFrequencyValue = float> void itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::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::Object.

template<class TFrequencyValue = float> void itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::SetFrequency (  const InstanceIdentifier    id, const FrequencyType    value )

Method to set the frequency of histogram using instance identifier

---

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

• itkDenseFrequencyContainer.h

---