itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength > Class Template Reference

#include <itkListSampleToHistogramGenerator.h>

Inheritance diagram for itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >:

[legend]Collaboration diagram for itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >:

[legend]List of all members.

---

Detailed Description

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1>
class itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >

Generates a Histogram using the data from the ListSample object.

This class is templated over the type of ListSample (which is a subclass of ListSampleBase class), the type of measurement values in the histogram, and The type of the frequency container that will be used to store frequency in the result histogram.

User should plug in the input list sample and specify the number of bins along each dimension. For example, if a measurement vector of the input list sample has three components, the histogram will be three dimensional histogram. So, the SetNumberOfBins() function will accepts itk::Size object with three components.

The upper bound and lower bound of the histogram will be automatically determined by the FindSampleBound funtion in itkStatisticsAlgorithm.h & .txx. The hitogram object's upper bound will be slightly bigger than the uppper bound from the FindSampleBound to include the maximum values in the Histogram object. To extend the upper bound of the histogram. this class internally uses the intervals between two bins and the marginal scale constant that you can set using the SetMarginalScale(float) funtion. The default marginal scale constant value is 100, which means that the upper bound of Histogram will be upper bound of the list sample + (bin interval) / 100 ( = marginal scale).

The result historam has equi-size bins along each axe.

NOTE: The second template argument, THistogramMeasurement should be float-point type (float or double).

Recent API changes The class is templated over the list sample, the frequency measurement precision, the length of each measurement vector and optionally over the type of frequency container.

See also:

Histogram, ListSampleBase, FindSampleBound

Definition at line 71 of file itkListSampleToHistogramGenerator.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef NumericTraits< THistogramMeasurement >::RealType	HistogramMeasurementRealType
typedef HistogramType::SizeType	HistogramSizeType
typedef Histogram< HistogramMeasurementRealType, itkGetStaticConstMacro(MeasurementVectorSize), TFrequencyContainer	HistogramType )
typedef HistogramType::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef ListSampleToHistogramGenerator	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAutoMinMax ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
const HistogramType *	GetOutput () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, TMeasurementVectorLength)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAutoMinMax (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetHistogramMax (const MeasurementVectorType &histogramMax)
void	SetHistogramMin (const MeasurementVectorType &histogramMin)
plug in the ListSample object *void	SetListSample (const TListSample *list)
void	SetMarginalScale (float scale)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetNumberOfBins (HistogramSizeType sizes)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
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
void	GenerateData ()
	ListSampleToHistogramGenerator ()
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
virtual	~ListSampleToHistogramGenerator ()
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

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef SmartPointer<const Self> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::ConstPointer

Reimplemented from itk::Object. Definition at line 79 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef NumericTraits< THistogramMeasurement >::RealType itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::HistogramMeasurementRealType

Type needed for defining the limits of the histogram bins Definition at line 93 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef HistogramType::SizeType itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::HistogramSizeType

Definition at line 99 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef Histogram< HistogramMeasurementRealType, itkGetStaticConstMacro(MeasurementVectorSize), TFrequencyContainer itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::HistogramType)

Definition at line 97 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef HistogramType::MeasurementVectorType itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::MeasurementVectorType

Definition at line 100 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef SmartPointer<Self> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Pointer

Reimplemented from itk::Object. Definition at line 78 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef ListSampleToHistogramGenerator itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Self

Standard typedefs Reimplemented from itk::Object. Definition at line 76 of file itkListSampleToHistogramGenerator.h.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> typedef Object itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Superclass

Reimplemented from itk::Object. Definition at line 77 of file itkListSampleToHistogramGenerator.h.

---

Constructor & Destructor Documentation

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::ListSampleToHistogramGenerator (   )  [protected]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::~ListSampleToHistogramGenerator (   )  [inline, protected, virtual]

Definition at line 175 of file itkListSampleToHistogramGenerator.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.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GenerateData (   )  [protected]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual const bool& itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GetAutoMinMax (   )  [virtual]

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.

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

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual const char* itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> const HistogramType* itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::GetOutput (  void   )  const [inline]

Definition at line 123 of file itkListSampleToHistogramGenerator.h.

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.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.

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.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::itkStaticConstMacro (  MeasurementVectorSize  , unsigned  int, TMeasurementVectorLength  )

the number of components in a measurement vector

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

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> static Pointer itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::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]

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::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.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> virtual void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetAutoMinMax (  bool  _arg  )  [virtual]

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

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

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

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetHistogramMax (  const MeasurementVectorType &  histogramMax  )  [inline]

Definition at line 152 of file itkListSampleToHistogramGenerator.h. References itk::MeasurementVectorTraits::Assert(), and itkExceptionMacro.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetHistogramMin (  const MeasurementVectorType &  histogramMin  )  [inline]

Definition at line 132 of file itkListSampleToHistogramGenerator.h. References itk::MeasurementVectorTraits::Assert(), and itkExceptionMacro.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> plug in the ListSample object* void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetListSample (  const TListSample *  list  )  [inline]

Definition at line 103 of file itkListSampleToHistogramGenerator.h. References itkExceptionMacro.

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetMarginalScale (  float  scale  )  [inline]

Definition at line 117 of file itkListSampleToHistogramGenerator.h.

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

Returns: Set the MetaDataDictionary

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::SetNumberOfBins (  HistogramSizeType  sizes  )  [inline]

Definition at line 120 of file itkListSampleToHistogramGenerator.h.

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

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

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

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

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = DenseFrequencyContainer, unsigned int TMeasurementVectorLength = 1> void itk::Statistics::ListSampleToHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer, TMeasurementVectorLength >::Update (  void   )  [inline]

Definition at line 126 of file itkListSampleToHistogramGenerator.h. References HardConnectedComponentImageFilter::GenerateData().

---

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:

• itkListSampleToHistogramGenerator.h

---