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

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

#include <itkSparseFrequencyContainer.h>

Inheritance diagram for itk::Statistics::SparseFrequencyContainer< TFrequencyValue >:

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

[legend]List of all members.

[NOHEADER]
virtual const char *	GetClassName () const
Pointer	New ()
Public Types
typedef SparseFrequencyContainer	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef unsigned long	InstanceIdentifier
typedef TFrequencyValue	FrequencyType
typedef std::map< InstanceIdentifier, FrequencyType >	FrequencyContainerType
typedef FrequencyContainerType::iterator	FrequencyContainerIterator
Public Member Functions
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 ()
Protected Member Functions
	SparseFrequencyContainer ()
virtual	~SparseFrequencyContainer ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

his class is a container for an histogram.

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

Definition at line 36 of file itkSparseFrequencyContainer.h.

---

Member Typedef Documentation

template<class TFrequencyValue = float> typedef FrequencyContainerType::iterator itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::FrequencyContainerIterator

Iterator typedef support Definition at line 61 of file itkSparseFrequencyContainer.h.

template<class TFrequencyValue = float> typedef std::map< InstanceIdentifier, FrequencyType > itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::FrequencyContainerType

Histogram typedef support Definition at line 57 of file itkSparseFrequencyContainer.h. Referenced by itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::~SparseFrequencyContainer().

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

frequency type alias Definition at line 53 of file itkSparseFrequencyContainer.h. Referenced by itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::~SparseFrequencyContainer().

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

instance idenfitifer alias Definition at line 50 of file itkSparseFrequencyContainer.h.

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

Reimplemented from itk::Object. Definition at line 42 of file itkSparseFrequencyContainer.h.

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

Standard class typedefs. Reimplemented from itk::Object. Definition at line 40 of file itkSparseFrequencyContainer.h. Referenced by itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::~SparseFrequencyContainer().

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

Reimplemented from itk::Object. Definition at line 41 of file itkSparseFrequencyContainer.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 82 of file itkSparseFrequencyContainer.h. References itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::FrequencyContainerType, itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::FrequencyType, and itk::Statistics::SparseFrequencyContainer< TFrequencyValue >::Self.

---

Member Function Documentation

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

Standard macros Reimplemented from itk::Object.

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

Method to get the frequency of a bin from the histogram

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

Definition at line 77 of file itkSparseFrequencyContainer.h.

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

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

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

prepares the frequency container

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

Standard macros Reimplemented from itk::Object.

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

• itkSparseFrequencyContainer.h

---