ITK  4.13.0
Insight Segmentation and Registration 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:

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, WikiExamples/Statistics/Histogram.cxx, and WikiExamples/Statistics/SampleToHistogramFilter.cxx.

Definition at line 42 of file itkDenseFrequencyContainer2.h.

Public Types

typedef
MeasurementVectorTraits::AbsoluteFrequencyType 
AbsoluteFrequencyType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
FrequencyContainerType::Pointer 
FrequencyContainerPointer
 
typedef ValarrayImageContainer
< InstanceIdentifier,
AbsoluteFrequencyType
FrequencyContainerType
 
typedef
MeasurementVectorTraits::InstanceIdentifier 
InstanceIdentifier
 
typedef SmartPointer< SelfPointer
 
typedef
MeasurementVectorTraits::RelativeFrequencyType 
RelativeFrequencyType
 
typedef DenseFrequencyContainer2 Self
 
typedef Object Superclass
 
typedef
MeasurementVectorTraits::TotalAbsoluteFrequencyType 
TotalAbsoluteFrequencyType
 
typedef
MeasurementVectorTraits::TotalRelativeFrequencyType 
TotalRelativeFrequencyType
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
AbsoluteFrequencyType GetFrequency (const InstanceIdentifier id) const
 
virtual const char * GetNameOfClass () 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
 
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
 

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

Member Typedef Documentation

Absoluate Frequency type alias

Definition at line 62 of file itkDenseFrequencyContainer2.h.

Definition at line 50 of file itkDenseFrequencyContainer2.h.

Definition at line 77 of file itkDenseFrequencyContainer2.h.

Internal storage class typedefs

Definition at line 75 of file itkDenseFrequencyContainer2.h.

InstanceIdenfitifer type alias

Definition at line 56 of file itkDenseFrequencyContainer2.h.

Definition at line 49 of file itkDenseFrequencyContainer2.h.

Relative Frequency type alias

Definition at line 68 of file itkDenseFrequencyContainer2.h.

Standard class typedefs

Definition at line 47 of file itkDenseFrequencyContainer2.h.

Definition at line 48 of file itkDenseFrequencyContainer2.h.

Absolute Total frequency type

Definition at line 65 of file itkDenseFrequencyContainer2.h.

Relative Total frequency type

Definition at line 71 of file itkDenseFrequencyContainer2.h.

Constructor & Destructor Documentation

itk::Statistics::DenseFrequencyContainer2::DenseFrequencyContainer2 ( )
protected
virtual itk::Statistics::DenseFrequencyContainer2::~DenseFrequencyContainer2 ( )
inlineoverrideprotectedvirtual

Definition at line 109 of file itkDenseFrequencyContainer2.h.

Member Function Documentation

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.

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.

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

Gets the sum of the frequencies

Definition at line 102 of file itkDenseFrequencyContainer2.h.

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

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

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

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

Method for creation through the object factory.

virtual 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.

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.

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

FrequencyContainerPointer itk::Statistics::DenseFrequencyContainer2::m_FrequencyContainer
private

Internal storage

Definition at line 113 of file itkDenseFrequencyContainer2.h.

TotalAbsoluteFrequencyType itk::Statistics::DenseFrequencyContainer2::m_TotalFrequency
private

Definition at line 117 of file itkDenseFrequencyContainer2.h.


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