itk::Statistics::SparseFrequencyContainer2 Class Reference

#include <itkSparseFrequencyContainer2.h>

Inheritance diagram for itk::Statistics::SparseFrequencyContainer2:

Collaboration diagram for itk::Statistics::SparseFrequencyContainer2:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = SparseFrequencyContainer2
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject
using	InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier
using	AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType
using	TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType
using	RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType
using	TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType
using	FrequencyContainerType = std::map< InstanceIdentifier, AbsoluteFrequencyType >
using	FrequencyContainerConstIterator = FrequencyContainerType::const_iterator
FrequencyContainerType	m_FrequencyContainer
TotalAbsoluteFrequencyType	m_TotalFrequency
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	Initialize (SizeValueType length)
void	SetToZero ()
bool	SetFrequency (const InstanceIdentifier id, const AbsoluteFrequencyType value)
bool	IncreaseFrequency (const InstanceIdentifier id, const AbsoluteFrequencyType value)
AbsoluteFrequencyType	GetFrequency (const InstanceIdentifier id) const
TotalAbsoluteFrequencyType	GetTotalFrequency () const
static Pointer	New ()
	SparseFrequencyContainer2 ()
	~SparseFrequencyContainer2 () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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

Member Typedef Documentation

AbsoluteFrequencyType

using itk::Statistics::SparseFrequencyContainer2::AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType

Absolute frequency type alias

Definition at line 62 of file itkSparseFrequencyContainer2.h.

ConstPointer

using itk::Statistics::SparseFrequencyContainer2::ConstPointer = SmartPointer<const Self>

Definition at line 51 of file itkSparseFrequencyContainer2.h.

FrequencyContainerConstIterator

using itk::Statistics::SparseFrequencyContainer2::FrequencyContainerConstIterator = FrequencyContainerType::const_iterator

instance identifier alias

Definition at line 75 of file itkSparseFrequencyContainer2.h.

FrequencyContainerType

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

Histogram type alias support

Definition at line 74 of file itkSparseFrequencyContainer2.h.

InstanceIdentifier

using itk::Statistics::SparseFrequencyContainer2::InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier

instance identifier alias

Definition at line 59 of file itkSparseFrequencyContainer2.h.

Pointer

using itk::Statistics::SparseFrequencyContainer2::Pointer = SmartPointer<Self>

Definition at line 50 of file itkSparseFrequencyContainer2.h.

RelativeFrequencyType

using itk::Statistics::SparseFrequencyContainer2::RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType

Relative frequency type alias

Definition at line 68 of file itkSparseFrequencyContainer2.h.

Self

using itk::Statistics::SparseFrequencyContainer2::Self = SparseFrequencyContainer2

Standard class type aliases.

Definition at line 48 of file itkSparseFrequencyContainer2.h.

Superclass

using itk::Statistics::SparseFrequencyContainer2::Superclass = Object

Definition at line 49 of file itkSparseFrequencyContainer2.h.

TotalAbsoluteFrequencyType

using itk::Statistics::SparseFrequencyContainer2::TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType

Absolute Total frequency type

Definition at line 65 of file itkSparseFrequencyContainer2.h.

TotalRelativeFrequencyType

using itk::Statistics::SparseFrequencyContainer2::TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType

Relative Relative frequency type

Definition at line 71 of file itkSparseFrequencyContainer2.h.

Constructor & Destructor Documentation

SparseFrequencyContainer2()

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

protected

instance identifier alias

~SparseFrequencyContainer2()

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

overrideprotecteddefault

instance identifier alias

Member Function Documentation

CreateAnother()

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

virtual

instance identifier alias

Reimplemented from itk::Object.

GetFrequency()

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.

GetNameOfClass()

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

virtual

Standard macros

Reimplemented from itk::Object.

GetTotalFrequency()

TotalAbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::GetTotalFrequency ( ) const

inline

instance identifier alias

Definition at line 102 of file itkSparseFrequencyContainer2.h.

IncreaseFrequency()

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

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

Initialize()

void itk::Statistics::SparseFrequencyContainer2::Initialize

(

SizeValueType

length

)

prepares the frequency container

New()

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

static

instance identifier alias

PrintSelf()

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

overrideprotectedvirtual

instance identifier alias

Reimplemented from itk::Object.

SetFrequency()

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

SetToZero()

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

m_FrequencyContainer

FrequencyContainerType itk::Statistics::SparseFrequencyContainer2::m_FrequencyContainer

private

instance identifier alias

Definition at line 115 of file itkSparseFrequencyContainer2.h.

m_TotalFrequency

TotalAbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::m_TotalFrequency

private

instance identifier alias

Definition at line 116 of file itkSparseFrequencyContainer2.h.

---

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

• itkSparseFrequencyContainer2.h