#include <itkSparseFrequencyContainer2.h>

Inheritance diagram for itk::Statistics::SparseFrequencyContainer2:

Collaboration diagram for itk::Statistics::SparseFrequencyContainer2:

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

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 Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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

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

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

	SparseFrequencyContainer2 ()

virtual	~SparseFrequencyContainer2 ()

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
void	operator= (const Self &) ITK_DELETE_FUNCTION

	SparseFrequencyContainer2 (const Self &) ITK_DELETE_FUNCTION

Private Attributes
FrequencyContainerType	m_FrequencyContainer

TotalAbsoluteFrequencyType	m_TotalFrequency

virtual const char *	GetNameOfClass () const

virtual ::itk::LightObject::Pointer	CreateAnother () const

static Pointer	New ()

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

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

Absolute frequency type alias

Definition at line 59 of file itkSparseFrequencyContainer2.h.

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

Definition at line 48 of file itkSparseFrequencyContainer2.h.

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

Definition at line 73 of file itkSparseFrequencyContainer2.h.

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

Histogram typedef support

Definition at line 71 of file itkSparseFrequencyContainer2.h.

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

instance idenfitifer alias

Definition at line 52 of file itkSparseFrequencyContainer2.h.

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

Definition at line 47 of file itkSparseFrequencyContainer2.h.

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

Relative frequency type alias

Definition at line 65 of file itkSparseFrequencyContainer2.h.

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

Standard class typedefs.

Definition at line 45 of file itkSparseFrequencyContainer2.h.

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

Definition at line 46 of file itkSparseFrequencyContainer2.h.

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

Absolute Total frequency type

Definition at line 62 of file itkSparseFrequencyContainer2.h.

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

Relative Relative frequency type

Definition at line 68 of file itkSparseFrequencyContainer2.h.

Constructor & Destructor Documentation

itk::Statistics::SparseFrequencyContainer2::SparseFrequencyContainer2 ( )

protected

virtual itk::Statistics::SparseFrequencyContainer2::~SparseFrequencyContainer2 ( )

inlineprotectedvirtual

Definition at line 102 of file itkSparseFrequencyContainer2.h.

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

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::Statistics::SparseFrequencyContainer2::CreateAnother ( ) 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 95 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

void itk::Statistics::SparseFrequencyContainer2::operator= ( const Self & )

private

virtual void itk::Statistics::SparseFrequencyContainer2::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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.