itk::Statistics::DenseFrequencyContainer Class Reference

his class is a container for frequencies of bins in an histogram. More...

#include <itkDenseFrequencyContainer.h>

Inheritance diagram for itk::Statistics::DenseFrequencyContainer:

[legend]Collaboration diagram for itk::Statistics::DenseFrequencyContainer:

[legend]List of all members.

Public Types
typedef DenseFrequencyContainer	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef unsigned long	InstanceIdentifier
typedef float	FrequencyType
typedef NumericTraits< FrequencyType >::AccumulateType	TotalFrequencyType
typedef ValarrayImageContainer< InstanceIdentifier, FrequencyType >	FrequencyContainerType
typedef FrequencyContainerType::Pointer	FrequencyContainerPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
void	Initialize (unsigned long length)
void	SetToZero ()
bool	SetFrequency (const InstanceIdentifier id, const FrequencyType value)
bool	IncreaseFrequency (const InstanceIdentifier id, const FrequencyType value)
FrequencyType	GetFrequency (const InstanceIdentifier id) const
TotalFrequencyType	GetTotalFrequency ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	DenseFrequencyContainer ()
virtual	~DenseFrequencyContainer ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

his class is a container for frequencies of bins in an histogram.

This class uses the ValarrayImageContainer class to store frequencies. If the histogram has many zero frequency bins. use SparseFrequencyContainer. You should access each bin by (InstanceIdentifier)index or measurement vector.

See also:

Histogram, SparseFrequencyContainer

Definition at line 40 of file itkDenseFrequencyContainer.h.

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Statistics::DenseFrequencyContainer::ConstPointer

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

typedef FrequencyContainerType::Pointer itk::Statistics::DenseFrequencyContainer::FrequencyContainerPointer

Definition at line 68 of file itkDenseFrequencyContainer.h.

typedef ValarrayImageContainer< InstanceIdentifier, FrequencyType > itk::Statistics::DenseFrequencyContainer::FrequencyContainerType

Internal storage class typedefs Definition at line 67 of file itkDenseFrequencyContainer.h.

typedef float itk::Statistics::DenseFrequencyContainer::FrequencyType

Frequency type alias Definition at line 60 of file itkDenseFrequencyContainer.h.

typedef unsigned long itk::Statistics::DenseFrequencyContainer::InstanceIdentifier

InstanceIdenfitifer type alias Definition at line 57 of file itkDenseFrequencyContainer.h.

typedef SmartPointer<Self> itk::Statistics::DenseFrequencyContainer::Pointer

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

typedef DenseFrequencyContainer itk::Statistics::DenseFrequencyContainer::Self

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

typedef Object itk::Statistics::DenseFrequencyContainer::Superclass

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

typedef NumericTraits<FrequencyType>::AccumulateType itk::Statistics::DenseFrequencyContainer::TotalFrequencyType

Total frequency type Definition at line 63 of file itkDenseFrequencyContainer.h. Referenced by GetTotalFrequency().

---

Constructor & Destructor Documentation

itk::Statistics::DenseFrequencyContainer::DenseFrequencyContainer (   )  [protected]

virtual itk::Statistics::DenseFrequencyContainer::~DenseFrequencyContainer (   )  [inline, protected, virtual]

Definition at line 98 of file itkDenseFrequencyContainer.h.

---

Member Function Documentation

FrequencyType itk::Statistics::DenseFrequencyContainer::GetFrequency (  const InstanceIdentifier  id  )  const

Method to get the frequency of a bin from the histogram. It returns zero when the Id is out of bounds.

virtual const char* itk::Statistics::DenseFrequencyContainer::GetNameOfClass (   )  const [virtual]

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

TotalFrequencyType itk::Statistics::DenseFrequencyContainer::GetTotalFrequency (   )  [inline]

Gets the sum of the frequencies Definition at line 93 of file itkDenseFrequencyContainer.h. References TotalFrequencyType.

bool itk::Statistics::DenseFrequencyContainer::IncreaseFrequency (  const InstanceIdentifier  id, const FrequencyType  value )

Increases the frequency of a bin specified by the InstanceIdentifier by one. This function is convinient to create a histogram. It returns false when the bin id is out of bounds.

void itk::Statistics::DenseFrequencyContainer::Initialize (  unsigned long  length  )

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

Pointer itk::Statistics::DenseFrequencyContainer::New (   )  [static]

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

void itk::Statistics::DenseFrequencyContainer::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.

bool itk::Statistics::DenseFrequencyContainer::SetFrequency (  const InstanceIdentifier  id, const FrequencyType  value )

Sets the frequency of histogram using instance identifier. It returns false when the Id is out of bounds.

void itk::Statistics::DenseFrequencyContainer::SetToZero (   )

Calls the SetToZero method of superclass to initialize all the bins to Zero. This should be done before starting to call the IncreaseFrequency method.

---

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

• itkDenseFrequencyContainer.h

---