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

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

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

#include <itkDenseFrequencyContainer.h>

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

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef DenseFrequencyContainer Self
typedef Object Superclass
typedef SmartPointer< SelfPointer
typedef unsigned long InstanceIdentifier
typedef TFrequencyValue FrequencyType
typedef ValarrayImageContainer<
InstanceIdentifier, FrequencyType
FrequencyContainerType
typedef FrequencyContainerType::Pointer FrequencyContainerPointer

Public Member Functions

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 Member Functions

Pointer New ()

Protected Member Functions

 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 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

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

Definition at line 64 of file itkDenseFrequencyContainer.h.

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

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

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

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

Referenced by itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::GetTotalFrequency().

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

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

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

Reimplemented from itk::Object.

Definition at line 47 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 45 of file itkDenseFrequencyContainer.h.

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

Reimplemented from itk::Object.

Definition at line 46 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 88 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]
 

Gets the sum of the frequencies Definition at line 83 of file itkDenseFrequencyContainer.h.

References itk::Statistics::DenseFrequencyContainer< TFrequencyValue >::FrequencyType.

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

Sets the frequency of histogram using instance identifier


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 03:13:12 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000