#include <itkDenseFrequencyContainer2.h>

Inheritance diagram for itk::Statistics::DenseFrequencyContainer2:

Collaboration diagram for itk::Statistics::DenseFrequencyContainer2:

Public Types
typedef MeasurementVectorTraits::AbsoluteFrequencyType	AbsoluteFrequencyType
typedef SmartPointer< const Self >	ConstPointer
typedef FrequencyContainerType::Pointer	FrequencyContainerPointer
typedef ValarrayImageContainer < InstanceIdentifier, AbsoluteFrequencyType >	FrequencyContainerType
typedef MeasurementVectorTraits::InstanceIdentifier	InstanceIdentifier
typedef SmartPointer< Self >	Pointer
typedef MeasurementVectorTraits::RelativeFrequencyType	RelativeFrequencyType
typedef DenseFrequencyContainer2	Self
typedef Object	Superclass
typedef MeasurementVectorTraits::TotalAbsoluteFrequencyType	TotalAbsoluteFrequencyType
typedef MeasurementVectorTraits::TotalRelativeFrequencyType	TotalRelativeFrequencyType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

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 ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

Protected Member Functions
	DenseFrequencyContainer2 ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~DenseFrequencyContainer2 ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

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

typedef MeasurementVectorTraits::AbsoluteFrequencyType itk::Statistics::DenseFrequencyContainer2::AbsoluteFrequencyType

Absoluate Frequency type alias

Definition at line 61 of file itkDenseFrequencyContainer2.h.

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

Reimplemented from itk::Object.

Definition at line 49 of file itkDenseFrequencyContainer2.h.

typedef FrequencyContainerType::Pointer itk::Statistics::DenseFrequencyContainer2::FrequencyContainerPointer

Definition at line 76 of file itkDenseFrequencyContainer2.h.

typedef ValarrayImageContainer< InstanceIdentifier, AbsoluteFrequencyType > itk::Statistics::DenseFrequencyContainer2::FrequencyContainerType

Internal storage class typedefs

Definition at line 74 of file itkDenseFrequencyContainer2.h.

typedef MeasurementVectorTraits::InstanceIdentifier itk::Statistics::DenseFrequencyContainer2::InstanceIdentifier

InstanceIdenfitifer type alias

Definition at line 55 of file itkDenseFrequencyContainer2.h.

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

Reimplemented from itk::Object.

Definition at line 48 of file itkDenseFrequencyContainer2.h.

typedef MeasurementVectorTraits::RelativeFrequencyType itk::Statistics::DenseFrequencyContainer2::RelativeFrequencyType

Relative Frequency type alias

Definition at line 67 of file itkDenseFrequencyContainer2.h.

typedef DenseFrequencyContainer2 itk::Statistics::DenseFrequencyContainer2::Self

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 46 of file itkDenseFrequencyContainer2.h.

typedef Object itk::Statistics::DenseFrequencyContainer2::Superclass

Reimplemented from itk::Object.

Definition at line 47 of file itkDenseFrequencyContainer2.h.

typedef MeasurementVectorTraits::TotalAbsoluteFrequencyType itk::Statistics::DenseFrequencyContainer2::TotalAbsoluteFrequencyType

Absolute Total frequency type

Definition at line 64 of file itkDenseFrequencyContainer2.h.

typedef MeasurementVectorTraits::TotalRelativeFrequencyType itk::Statistics::DenseFrequencyContainer2::TotalRelativeFrequencyType

Relative Total frequency type

Definition at line 70 of file itkDenseFrequencyContainer2.h.

Constructor & Destructor Documentation

itk::Statistics::DenseFrequencyContainer2::DenseFrequencyContainer2 ( )

protected

virtual itk::Statistics::DenseFrequencyContainer2::~DenseFrequencyContainer2 ( )

inlineprotectedvirtual

Definition at line 108 of file itkDenseFrequencyContainer2.h.

itk::Statistics::DenseFrequencyContainer2::DenseFrequencyContainer2 ( const Self & )

private

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.

AbsoluteFrequencyType itk::Statistics::DenseFrequencyContainer2::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::DenseFrequencyContainer2::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

TotalAbsoluteFrequencyType itk::Statistics::DenseFrequencyContainer2::GetTotalFrequency ( )

inline

Gets the sum of the frequencies

Definition at line 101 of file itkDenseFrequencyContainer2.h.

bool itk::Statistics::DenseFrequencyContainer2::IncreaseFrequency	(	const InstanceIdentifier	id,
		const AbsoluteFrequencyType	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::DenseFrequencyContainer2::Initialize ( SizeValueType length )

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

static Pointer itk::Statistics::DenseFrequencyContainer2::New ( )

static

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

protectedvirtual

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::DenseFrequencyContainer2::SetFrequency	(	const InstanceIdentifier	id,
		const AbsoluteFrequencyType	value
	)

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

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