#include <itkDenseFrequencyContainer2.h>

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

Examples: Examples/Statistics/Histogram.cxx, and SphinxExamples/src/Numerics/Statistics/HistogramCreationAndBinAccess/Code.cxx.

Definition at line 43 of file itkDenseFrequencyContainer2.h.

Inheritance diagram for itk::Statistics::DenseFrequencyContainer2:

Collaboration diagram for itk::Statistics::DenseFrequencyContainer2:

Public Types
using	AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType

using	ConstPointer = SmartPointer< const Self >

using	FrequencyContainerPointer = FrequencyContainerType::Pointer

using	FrequencyContainerType = ValarrayImageContainer< InstanceIdentifier, AbsoluteFrequencyType >

using	InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier

using	Pointer = SmartPointer< Self >

using	RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType

using	Self = DenseFrequencyContainer2

using	Superclass = Object

using	TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType

using	TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType

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

Public Member Functions
AbsoluteFrequencyType	GetFrequency (const InstanceIdentifier id) const

const char *	GetNameOfClass () const override

TotalAbsoluteFrequencyType	GetTotalFrequency () const

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

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
static Pointer	New ()

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

void	PrintSelf (std::ostream &os, Indent indent) const override

	~DenseFrequencyContainer2 () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 Attributes
FrequencyContainerPointer	m_FrequencyContainer {}

TotalAbsoluteFrequencyType	m_TotalFrequency {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ AbsoluteFrequencyType

using itk::Statistics::DenseFrequencyContainer2::AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType

Absolute Frequency type alias

Definition at line 64 of file itkDenseFrequencyContainer2.h.

◆ ConstPointer

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

Definition at line 52 of file itkDenseFrequencyContainer2.h.

◆ FrequencyContainerPointer

using itk::Statistics::DenseFrequencyContainer2::FrequencyContainerPointer = FrequencyContainerType::Pointer

Definition at line 78 of file itkDenseFrequencyContainer2.h.

◆ FrequencyContainerType

using itk::Statistics::DenseFrequencyContainer2::FrequencyContainerType = ValarrayImageContainer<InstanceIdentifier, AbsoluteFrequencyType>

Internal storage class type alias

Definition at line 76 of file itkDenseFrequencyContainer2.h.

◆ InstanceIdentifier

using itk::Statistics::DenseFrequencyContainer2::InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier

InstanceIdentifier type alias

Definition at line 61 of file itkDenseFrequencyContainer2.h.

◆ Pointer

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

Definition at line 51 of file itkDenseFrequencyContainer2.h.

◆ RelativeFrequencyType

using itk::Statistics::DenseFrequencyContainer2::RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType

Relative Frequency type alias

Definition at line 70 of file itkDenseFrequencyContainer2.h.

◆ Self

using itk::Statistics::DenseFrequencyContainer2::Self = DenseFrequencyContainer2

Standard class type aliases

Definition at line 49 of file itkDenseFrequencyContainer2.h.

◆ Superclass

using itk::Statistics::DenseFrequencyContainer2::Superclass = Object

Definition at line 50 of file itkDenseFrequencyContainer2.h.

◆ TotalAbsoluteFrequencyType

using itk::Statistics::DenseFrequencyContainer2::TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType

Absolute Total frequency type

Definition at line 67 of file itkDenseFrequencyContainer2.h.

◆ TotalRelativeFrequencyType

using itk::Statistics::DenseFrequencyContainer2::TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType

Relative Total frequency type

Definition at line 73 of file itkDenseFrequencyContainer2.h.

Constructor & Destructor Documentation

◆ DenseFrequencyContainer2()

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

protected

◆ ~DenseFrequencyContainer2()

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

overrideprotecteddefault

Member Function Documentation

◆ GetFrequency()

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.

◆ GetNameOfClass()

const char* itk::Statistics::DenseFrequencyContainer2::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetTotalFrequency()

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

inline

Gets the sum of the frequencies

Definition at line 108 of file itkDenseFrequencyContainer2.h.

◆ IncreaseFrequency()

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 convenient to create a histogram. It returns false when the bin id is out of bounds.

◆ Initialize()

void itk::Statistics::DenseFrequencyContainer2::Initialize ( SizeValueType length )

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

◆ New()

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

static

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetFrequency()

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.

◆ SetToZero()

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.

Member Data Documentation

◆ m_FrequencyContainer

FrequencyContainerPointer itk::Statistics::DenseFrequencyContainer2::m_FrequencyContainer {}

private

Internal storage

Definition at line 121 of file itkDenseFrequencyContainer2.h.

◆ m_TotalFrequency

TotalAbsoluteFrequencyType itk::Statistics::DenseFrequencyContainer2::m_TotalFrequency {}