itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement > Class Template Reference

#include <itkSampleToHistogramProjectionFilter.h>

Inheritance diagram for itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >:

[legend]Collaboration diagram for itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >:

[legend]List of all members.

---

Detailed Description

template<class TInputSample, class THistogramMeasurement>
class itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >

projects measurement vectors on to an axis to generate an 1D histogram.

Users should set the input sample, the output histogram, the mean of input sample, the standard deviation of the input sample, and the projection axis respectively using the SetInputSample, the SetHistogram, the SetMean, SetStandardDeviation, and SetProjectionAxis method before run this algorithm.

If the bin overlap value is set by the SetHistogramBinOverlap method and greater than 0.001, the frequency will be weighted based on its closeness of the projected values.

Recent API changes: The static const macro to get the length of a measurement vector, MeasurementVectorSize has been removed to allow the length of a measurement vector to be specified at run time. This is now obtained from the input sample. Typedefs for the Histogram mean MeanType etc have been changed to Array.

Definition at line 54 of file itkSampleToHistogramProjectionFilter.h.

Public Types
typedef Array< double >	ArrayType
typedef const SmartPointer< Self >	ConstPointer
typedef TInputSample::FrequencyType	FrequencyType
typedef Histogram< THistogramMeasurement, 1 >	HistogramType
typedef Superclass::InputSampleType	InputSampleType
typedef TInputSample::InstanceIdentifier	InstanceIdentifier
typedef Array< double >	MeanType
typedef TInputSample::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TInputSample::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef SampleToHistogramProjectionFilter	Self
typedef SampleAlgorithmBase< TInputSample >	Superclass
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
const TInputSample *	GetInputSample () const
MeanType *	GetMean ()
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
ArrayType *	GetProjectionAxis ()
virtual int	GetReferenceCount () const
double *	GetStandardDeviation ()
bool	HasObserver (const EventObject &event) const
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
virtual void	SetHistogram (HistogramType *histogram)
void	SetHistogramBinOverlap (double overlap)
Stores the sample pointer *void	SetInputSample (const TInputSample *sample)
void	SetMean (MeanType *center)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetProjectionAxis (ArrayType *axis)
virtual void	SetReferenceCount (int)
void	SetStandardDeviation (double *value)
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
float	CalculateOverlap (int binIndex, float dotProduct, float scale, float marginalDistance, bool firstHalf)
void	GenerateData ()
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
	SampleToHistogramProjectionFilter ()
virtual	~SampleToHistogramProjectionFilter ()
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 TInputSample, class THistogramMeasurement> typedef Array< double > itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::ArrayType

1D array typedef Definition at line 82 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef const SmartPointer< Self > itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::ConstPointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 62 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef TInputSample::FrequencyType itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::FrequencyType

Definition at line 74 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef Histogram< THistogramMeasurement, 1 > itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::HistogramType

Type of the output object Definition at line 88 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef Superclass::InputSampleType itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::InputSampleType

typedefs from the superclass Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 78 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef TInputSample::InstanceIdentifier itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::InstanceIdentifier

Definition at line 75 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef Array< double > itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::MeanType

The center of the histogram Definition at line 85 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef TInputSample::MeasurementType itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::MeasurementType

Definition at line 73 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef Superclass::MeasurementVectorSizeType itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::MeasurementVectorSizeType

Length of a measurement vector Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 79 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef TInputSample::MeasurementVectorType itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::MeasurementVectorType

Enums and typedefs from the TInputSample Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 68 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef SmartPointer< Self > itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::Pointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 61 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef SampleToHistogramProjectionFilter itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::Self

Standard class typedefs Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 59 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef SampleAlgorithmBase< TInputSample > itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::Superclass

Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >. Definition at line 60 of file itkSampleToHistogramProjectionFilter.h.

---

Constructor & Destructor Documentation

template<class TInputSample, class THistogramMeasurement> itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SampleToHistogramProjectionFilter (   )  [protected]

template<class TInputSample, class THistogramMeasurement> virtual itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::~SampleToHistogramProjectionFilter (   )  [inline, protected, virtual]

Definition at line 118 of file itkSampleToHistogramProjectionFilter.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.

template<class TInputSample, class THistogramMeasurement> float itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::CalculateOverlap (  int  binIndex, float  dotProduct, float  scale, float  marginalDistance, bool  firstHalf )  [protected]

Calculates overlap weight for the bin based on closeness to the adjacent bins

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 TInputSample, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::GenerateData (   )  [protected, virtual]

Runs this algorithm to fill the output histogram Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >.

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]

template<class TInputSample> const TInputSample* itk::Statistics::SampleAlgorithmBase< TInputSample >::GetInputSample (   )  const [inline, inherited]

Definition at line 82 of file itkSampleAlgorithmBase.h.

template<class TInputSample, class THistogramMeasurement> MeanType* itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::GetMean (   )

Gets the mean of the sample

template<class TInputSample> virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TInputSample >::GetMeasurementVectorSize (   )  const [virtual, inherited]

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

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 TInputSample, class THistogramMeasurement> virtual const char* itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods) Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >.

template<class TInputSample, class THistogramMeasurement> ArrayType* itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::GetProjectionAxis (   )

Gets the projection axis

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

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

template<class TInputSample, class THistogramMeasurement> double* itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::GetStandardDeviation (   )

Gets the standard deviation of the sample

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.

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 TInputSample, class THistogramMeasurement> static Pointer itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputSample >.

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 TInputSample, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::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::Statistics::SampleAlgorithmBase< TInputSample >.

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.

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 TInputSample, class THistogramMeasurement> virtual void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SetHistogram (  HistogramType *  histogram  )  [virtual]

Sets the output histogram

template<class TInputSample, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SetHistogramBinOverlap (  double  overlap  )

Sets the overlap between adjacent bins. If this value is not set, then the overlap calculation will be skipped

template<class TInputSample> Stores the sample pointer* void itk::Statistics::SampleAlgorithmBase< TInputSample >::SetInputSample (  const TInputSample *  sample  )  [inline, inherited]

Definition at line 63 of file itkSampleAlgorithmBase.h.

template<class TInputSample, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SetMean (  MeanType *  center  )

Sets the mean of the sample

template<class TInputSample> virtual void itk::Statistics::SampleAlgorithmBase< TInputSample >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual, inherited]

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

Returns: Set the MetaDataDictionary

template<class TInputSample, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SetProjectionAxis (  ArrayType *  axis  )

Sets the projection axis

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

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

template<class TInputSample, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SetStandardDeviation (  double *  value  )

Sets the standard deviation of the sample

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

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

template<class TInputSample> void itk::Statistics::SampleAlgorithmBase< TInputSample >::Update (  void   )  [inline, inherited]

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming Definition at line 88 of file itkSampleAlgorithmBase.h.

---

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:

• itkSampleToHistogramProjectionFilter.h

---