itk::Statistics::SparseFrequencyContainer2 Class Reference

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

#include <itkSparseFrequencyContainer2.h>

Inheritance diagram for itk::Statistics::SparseFrequencyContainer2:

Collaboration diagram for itk::Statistics::SparseFrequencyContainer2:

List of all members.

Public Types
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType
typedef SmartPointer< const Self >	ConstPointer
typedef FrequencyContainerType::const_iterator	FrequencyContainerConstIterator
typedef std::map < InstanceIdentifier, AbsoluteFrequencyType >	FrequencyContainerType
typedef MeasurementVectorTraits::InstanceIdentifier	InstanceIdentifier
typedef SmartPointer< Self >	Pointer
typedef MeasurementVectorTraits::RelativeFrequencyType	RelativeFrequencyType
typedef SparseFrequencyContainer2	Self
typedef Object	Superclass
typedef MeasurementVectorTraits::TotalAbsoluteFrequencyType	TotalAbsoluteFrequencyType
typedef MeasurementVectorTraits::TotalRelativeFrequencyType	TotalRelativeFrequencyType
Public Member Functions
AbsoluteFrequencyType	GetFrequency (const InstanceIdentifier id) 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 ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	SparseFrequencyContainer2 ()
virtual	~SparseFrequencyContainer2 ()
Private Member Functions
void	operator= (const Self &)
	SparseFrequencyContainer2 (const Self &)
Private Attributes
FrequencyContainerType	m_FrequencyContainer
TotalAbsoluteFrequencyType	m_TotalFrequency
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
static Pointer	New ()

---

Detailed Description

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 40 of file itkSparseFrequencyContainer2.h.

---

Member Typedef Documentation

typedef MeasurementVectorTraits::AbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::AbsoluteFrequencyType

Absolute frequency type alias

Definition at line 58 of file itkSparseFrequencyContainer2.h.

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

Reimplemented from itk::Object.

Definition at line 47 of file itkSparseFrequencyContainer2.h.

typedef FrequencyContainerType::const_iterator itk::Statistics::SparseFrequencyContainer2::FrequencyContainerConstIterator

Definition at line 72 of file itkSparseFrequencyContainer2.h.

typedef std::map< InstanceIdentifier, AbsoluteFrequencyType > itk::Statistics::SparseFrequencyContainer2::FrequencyContainerType

Histogram typedef support

Definition at line 70 of file itkSparseFrequencyContainer2.h.

typedef MeasurementVectorTraits::InstanceIdentifier itk::Statistics::SparseFrequencyContainer2::InstanceIdentifier

instance idenfitifer alias

Definition at line 51 of file itkSparseFrequencyContainer2.h.

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

Reimplemented from itk::Object.

Definition at line 46 of file itkSparseFrequencyContainer2.h.

typedef MeasurementVectorTraits::RelativeFrequencyType itk::Statistics::SparseFrequencyContainer2::RelativeFrequencyType

Relative frequency type alias

Definition at line 64 of file itkSparseFrequencyContainer2.h.

typedef SparseFrequencyContainer2 itk::Statistics::SparseFrequencyContainer2::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 44 of file itkSparseFrequencyContainer2.h.

typedef Object itk::Statistics::SparseFrequencyContainer2::Superclass

Reimplemented from itk::Object.

Definition at line 45 of file itkSparseFrequencyContainer2.h.

typedef MeasurementVectorTraits::TotalAbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::TotalAbsoluteFrequencyType

Absolute Total frequency type

Definition at line 61 of file itkSparseFrequencyContainer2.h.

typedef MeasurementVectorTraits::TotalRelativeFrequencyType itk::Statistics::SparseFrequencyContainer2::TotalRelativeFrequencyType

Relative Relative frequency type

Definition at line 67 of file itkSparseFrequencyContainer2.h.

---

Constructor & Destructor Documentation

itk::Statistics::SparseFrequencyContainer2::SparseFrequencyContainer2

(

)

[protected]

virtual itk::Statistics::SparseFrequencyContainer2::~SparseFrequencyContainer2

(

)

[inline, protected, virtual]

Definition at line 101 of file itkSparseFrequencyContainer2.h.

itk::Statistics::SparseFrequencyContainer2::SparseFrequencyContainer2

(

const Self &

)

[private]

---

Member Function Documentation

virtual::itk::LightObject::Pointer itk::Statistics::SparseFrequencyContainer2::CreateAnother

(

void

)

const [virtual]

Standard macros

Reimplemented from itk::Object.

AbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::GetFrequency

(

const InstanceIdentifier

id

)

const

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

virtual const char* itk::Statistics::SparseFrequencyContainer2::GetNameOfClass

(

)

const [virtual]

Standard macros

Reimplemented from itk::Object.

TotalAbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::GetTotalFrequency

(

)

[inline]

Definition at line 94 of file itkSparseFrequencyContainer2.h.

bool itk::Statistics::SparseFrequencyContainer2::IncreaseFrequency	(	const InstanceIdentifier	id,
		const AbsoluteFrequencyType	value
	)

Method to increase the frequency by one. This function is convinent to create a histogram. It returns false when the id is out of bounds.

void itk::Statistics::SparseFrequencyContainer2::Initialize

(

SizeValueType

length

)

prepares the frequency container

static Pointer itk::Statistics::SparseFrequencyContainer2::New

(

)

[static]

Standard macros

Reimplemented from itk::Object.

void itk::Statistics::SparseFrequencyContainer2::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

void itk::Statistics::SparseFrequencyContainer2::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::SparseFrequencyContainer2::SetFrequency	(	const InstanceIdentifier	id,
		const AbsoluteFrequencyType	value
	)

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

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

---

Member Data Documentation

FrequencyContainerType itk::Statistics::SparseFrequencyContainer2::m_FrequencyContainer [private]

Definition at line 109 of file itkSparseFrequencyContainer2.h.

TotalAbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::m_TotalFrequency [private]

Definition at line 110 of file itkSparseFrequencyContainer2.h.

---

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

• itkSparseFrequencyContainer2.h