ITK
6.0.0
Insight Toolkit
|
#include <itkSparseFrequencyContainer2.h>
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.
Public Member Functions | |
AbsoluteFrequencyType | GetFrequency (const InstanceIdentifier id) 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 *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 |
const char * | GetNameOfClass () const override |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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 |
void | PrintSelf (std::ostream &os, Indent indent) const override |
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 | PrintSelf (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 {} |
const char * | GetNameOfClass () const override |
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 val) |
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 {} |
using itk::Statistics::SparseFrequencyContainer2::AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType |
Absolute frequency type alias
Definition at line 62 of file itkSparseFrequencyContainer2.h.
Definition at line 51 of file itkSparseFrequencyContainer2.h.
using itk::Statistics::SparseFrequencyContainer2::FrequencyContainerConstIterator = FrequencyContainerType::const_iterator |
Definition at line 75 of file itkSparseFrequencyContainer2.h.
using itk::Statistics::SparseFrequencyContainer2::FrequencyContainerType = std::map<InstanceIdentifier, AbsoluteFrequencyType> |
Histogram type alias support
Definition at line 74 of file itkSparseFrequencyContainer2.h.
using itk::Statistics::SparseFrequencyContainer2::InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier |
instance identifier alias
Definition at line 59 of file itkSparseFrequencyContainer2.h.
Definition at line 50 of file itkSparseFrequencyContainer2.h.
using itk::Statistics::SparseFrequencyContainer2::RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType |
Relative frequency type alias
Definition at line 68 of file itkSparseFrequencyContainer2.h.
Standard class type aliases.
Definition at line 48 of file itkSparseFrequencyContainer2.h.
Definition at line 49 of file itkSparseFrequencyContainer2.h.
using itk::Statistics::SparseFrequencyContainer2::TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType |
Absolute Total frequency type
Definition at line 65 of file itkSparseFrequencyContainer2.h.
using itk::Statistics::SparseFrequencyContainer2::TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType |
Relative Relative frequency type
Definition at line 71 of file itkSparseFrequencyContainer2.h.
|
protected |
|
overrideprotecteddefault |
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.
|
overridevirtual |
Reimplemented from itk::Object.
|
inline |
Definition at line 102 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 convenient 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 |
|
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.
|
private |
Definition at line 115 of file itkSparseFrequencyContainer2.h.
|
private |
Definition at line 116 of file itkSparseFrequencyContainer2.h.