ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::SparseFrequencyContainer2 Class Reference

#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

using AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType
 
using ConstPointer = SmartPointer< const Self >
 
using FrequencyContainerConstIterator = FrequencyContainerType::const_iterator
 
using FrequencyContainerType = std::map< InstanceIdentifier, AbsoluteFrequencyType >
 
using InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier
 
using Pointer = SmartPointer< Self >
 
using RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType
 
using Self = SparseFrequencyContainer2
 
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
 
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 noexceptoverride
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 SparseFrequencyContainer2 ()
 
 ~SparseFrequencyContainer2 () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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

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
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

Absolute frequency type alias

Definition at line 61 of file itkSparseFrequencyContainer2.h.

Definition at line 50 of file itkSparseFrequencyContainer2.h.

Definition at line 74 of file itkSparseFrequencyContainer2.h.

Histogram type alias support

Definition at line 73 of file itkSparseFrequencyContainer2.h.

instance idenfitifer alias

Definition at line 58 of file itkSparseFrequencyContainer2.h.

Definition at line 49 of file itkSparseFrequencyContainer2.h.

Relative frequency type alias

Definition at line 67 of file itkSparseFrequencyContainer2.h.

Standard class type aliases.

Definition at line 47 of file itkSparseFrequencyContainer2.h.

Definition at line 48 of file itkSparseFrequencyContainer2.h.

Absolute Total frequency type

Definition at line 64 of file itkSparseFrequencyContainer2.h.

Relative Relative frequency type

Definition at line 70 of file itkSparseFrequencyContainer2.h.

Constructor & Destructor Documentation

itk::Statistics::SparseFrequencyContainer2::SparseFrequencyContainer2 ( )
protected
itk::Statistics::SparseFrequencyContainer2::~SparseFrequencyContainer2 ( )
overrideprotecteddefault

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 96 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::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.

Member Data Documentation

FrequencyContainerType itk::Statistics::SparseFrequencyContainer2::m_FrequencyContainer
private

Definition at line 108 of file itkSparseFrequencyContainer2.h.

TotalAbsoluteFrequencyType itk::Statistics::SparseFrequencyContainer2::m_TotalFrequency
private

Definition at line 109 of file itkSparseFrequencyContainer2.h.


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