ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::DenseFrequencyContainer2 Class Reference

#include <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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
AbsoluteFrequencyType GetFrequency (const InstanceIdentifier id) const
 
virtual const char * GetNameOfClass () const
 
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 *)
 
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
 
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 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
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 Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- 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 ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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
 

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.

Member Typedef Documentation

◆ AbsoluteFrequencyType

Absoluate Frequency type alias

Definition at line 64 of file itkDenseFrequencyContainer2.h.

◆ ConstPointer

Definition at line 52 of file itkDenseFrequencyContainer2.h.

◆ FrequencyContainerPointer

Definition at line 78 of file itkDenseFrequencyContainer2.h.

◆ FrequencyContainerType

Internal storage class type alias

Definition at line 76 of file itkDenseFrequencyContainer2.h.

◆ InstanceIdentifier

InstanceIdenfitifer type alias

Definition at line 61 of file itkDenseFrequencyContainer2.h.

◆ Pointer

Definition at line 51 of file itkDenseFrequencyContainer2.h.

◆ RelativeFrequencyType

Relative Frequency type alias

Definition at line 70 of file itkDenseFrequencyContainer2.h.

◆ Self

Standard class type aliases

Definition at line 49 of file itkDenseFrequencyContainer2.h.

◆ Superclass

Definition at line 50 of file itkDenseFrequencyContainer2.h.

◆ TotalAbsoluteFrequencyType

Absolute Total frequency type

Definition at line 67 of file itkDenseFrequencyContainer2.h.

◆ 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

◆ CreateAnother()

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

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

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

Run-time type information (and related methods).

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
private

Definition at line 122 of file itkDenseFrequencyContainer2.h.


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