itk::Statistics::SparseFrequencyContainer Class Reference

#include <itkSparseFrequencyContainer.h>

Inheritance diagram for itk::Statistics::SparseFrequencyContainer:

[legend]Collaboration diagram for itk::Statistics::SparseFrequencyContainer:

[legend]List of all members.

---

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 36 of file itkSparseFrequencyContainer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef FrequencyContainerType::const_iterator	FrequencyContainerConstIterator
typedef std::map< InstanceIdentifier, FrequencyType >	FrequencyContainerType
typedef float	FrequencyType
typedef unsigned long	InstanceIdentifier
typedef SmartPointer< Self >	Pointer
typedef SparseFrequencyContainer	Self
typedef Object	Superclass
typedef NumericTraits< FrequencyType >::AccumulateType	TotalFrequencyType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
FrequencyType	GetFrequency (const InstanceIdentifier id) const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard macros *virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
TotalFrequencyType	GetTotalFrequency ()
bool	HasObserver (const EventObject &event) const
bool	IncreaseFrequency (const InstanceIdentifier id, const FrequencyType value)
void	Initialize (unsigned long length)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
bool	SetFrequency (const InstanceIdentifier id, const FrequencyType value)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetToZero ()
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SparseFrequencyContainer ()
virtual	~SparseFrequencyContainer ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Statistics::SparseFrequencyContainer::ConstPointer

Reimplemented from itk::Object. Definition at line 43 of file itkSparseFrequencyContainer.h.

typedef FrequencyContainerType::const_iterator itk::Statistics::SparseFrequencyContainer::FrequencyContainerConstIterator

Definition at line 62 of file itkSparseFrequencyContainer.h.

typedef std::map< InstanceIdentifier, FrequencyType > itk::Statistics::SparseFrequencyContainer::FrequencyContainerType

Histogram typedef support Definition at line 60 of file itkSparseFrequencyContainer.h.

typedef float itk::Statistics::SparseFrequencyContainer::FrequencyType

frequency type alias Definition at line 54 of file itkSparseFrequencyContainer.h.

typedef unsigned long itk::Statistics::SparseFrequencyContainer::InstanceIdentifier

instance idenfitifer alias Definition at line 47 of file itkSparseFrequencyContainer.h.

typedef SmartPointer<Self> itk::Statistics::SparseFrequencyContainer::Pointer

Reimplemented from itk::Object. Definition at line 42 of file itkSparseFrequencyContainer.h.

typedef SparseFrequencyContainer itk::Statistics::SparseFrequencyContainer::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 40 of file itkSparseFrequencyContainer.h.

typedef Object itk::Statistics::SparseFrequencyContainer::Superclass

Reimplemented from itk::Object. Definition at line 41 of file itkSparseFrequencyContainer.h.

typedef NumericTraits<FrequencyType>::AccumulateType itk::Statistics::SparseFrequencyContainer::TotalFrequencyType

Total frequency type Definition at line 57 of file itkSparseFrequencyContainer.h.

---

Constructor & Destructor Documentation

itk::Statistics::SparseFrequencyContainer::SparseFrequencyContainer (   )  [protected]

virtual itk::Statistics::SparseFrequencyContainer::~SparseFrequencyContainer (   )  [inline, protected, virtual]

Definition at line 89 of file itkSparseFrequencyContainer.h.

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

FrequencyType itk::Statistics::SparseFrequencyContainer::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.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

Standard macros* virtual const char* itk::Statistics::SparseFrequencyContainer::GetNameOfClass (   )  const [virtual]

Standard part of all itk objects. Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

TotalFrequencyType itk::Statistics::SparseFrequencyContainer::GetTotalFrequency (   )  [inline]

Definition at line 84 of file itkSparseFrequencyContainer.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

bool itk::Statistics::SparseFrequencyContainer::IncreaseFrequency (  const InstanceIdentifier  id, const FrequencyType  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::SparseFrequencyContainer::Initialize (  unsigned long  length  )

prepares the frequency container

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::Statistics::SparseFrequencyContainer::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

void itk::Statistics::SparseFrequencyContainer::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

bool itk::Statistics::SparseFrequencyContainer::SetFrequency (  const InstanceIdentifier  id, const FrequencyType  value )

Method to set the frequency of histogram using instance identifier. It returns false when the Id is out of bounds

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

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

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkSparseFrequencyContainer.h

---