ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::Statistics::DenseFrequencyContainer2 Class Reference

#include <itkDenseFrequencyContainer2.h>

+ Inheritance diagram for itk::Statistics::DenseFrequencyContainer2:
+ Collaboration diagram for itk::Statistics::DenseFrequencyContainer2:

List of all members.

Public Types

typedef
MeasurementVectorTraits::AbsoluteFrequencyType 
AbsoluteFrequencyType
typedef SmartPointer< const SelfConstPointer
typedef
FrequencyContainerType::Pointer 
FrequencyContainerPointer
typedef ValarrayImageContainer
< InstanceIdentifier,
AbsoluteFrequencyType
FrequencyContainerType
typedef
MeasurementVectorTraits::InstanceIdentifier 
InstanceIdentifier
typedef SmartPointer< SelfPointer
typedef
MeasurementVectorTraits::RelativeFrequencyType 
RelativeFrequencyType
typedef DenseFrequencyContainer2 Self
typedef Object Superclass
typedef
MeasurementVectorTraits::TotalAbsoluteFrequencyType 
TotalAbsoluteFrequencyType
typedef
MeasurementVectorTraits::TotalRelativeFrequencyType 
TotalRelativeFrequencyType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
AbsoluteFrequencyType GetFrequency (const InstanceIdentifier id) const
virtual const char * GetNameOfClass () const
TotalAbsoluteFrequencyType GetTotalFrequency ()
bool IncreaseFrequency (const InstanceIdentifier id, const AbsoluteFrequencyType value)
void Initialize (SizeValueType length)
bool SetFrequency (const InstanceIdentifier id, const AbsoluteFrequencyType value)
void SetToZero ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

Private Member Functions

 DenseFrequencyContainer2 (const Self &)
void operator= (const Self &)

Private Attributes

FrequencyContainerPointer m_FrequencyContainer
TotalAbsoluteFrequencyType m_TotalFrequency

Detailed Description

This 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 41 of file itkDenseFrequencyContainer2.h.


Member Typedef Documentation

Absoluate Frequency type alias

Definition at line 61 of file itkDenseFrequencyContainer2.h.

Reimplemented from itk::Object.

Definition at line 49 of file itkDenseFrequencyContainer2.h.

Definition at line 76 of file itkDenseFrequencyContainer2.h.

Internal storage class typedefs

Definition at line 74 of file itkDenseFrequencyContainer2.h.

InstanceIdenfitifer type alias

Definition at line 55 of file itkDenseFrequencyContainer2.h.

Reimplemented from itk::Object.

Definition at line 48 of file itkDenseFrequencyContainer2.h.

Relative Frequency type alias

Definition at line 67 of file itkDenseFrequencyContainer2.h.

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 46 of file itkDenseFrequencyContainer2.h.

Reimplemented from itk::Object.

Definition at line 47 of file itkDenseFrequencyContainer2.h.

Absolute Total frequency type

Definition at line 64 of file itkDenseFrequencyContainer2.h.

Relative Total frequency type

Definition at line 70 of file itkDenseFrequencyContainer2.h.


Constructor & Destructor Documentation

Definition at line 108 of file itkDenseFrequencyContainer2.h.


Member Function Documentation

virtual::itk::LightObject::Pointer itk::Statistics::DenseFrequencyContainer2::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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::DenseFrequencyContainer2::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

Gets the sum of the frequencies

Definition at line 101 of file itkDenseFrequencyContainer2.h.

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.

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

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::Statistics::DenseFrequencyContainer2::operator= ( const Self ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

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

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

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


Member Data Documentation

Internal storage

Definition at line 116 of file itkDenseFrequencyContainer2.h.

Definition at line 117 of file itkDenseFrequencyContainer2.h.


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