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

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

#include <itkSampleToHistogramProjectionFilter.h>

Inheritance diagram for itk::Statistics::SampleToHistogramProjectionFilter:

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

[legend]List of all members.

Public Types
typedef SampleToHistogramProjectionFilter	Self
typedef SampleAlgorithmBase< TInputSample >	Superclass
typedef SmartPointer< Self >	Pointer
typedef const SmartPointer< Self >	ConstPointer
typedef TInputSample::MeasurementVectorType	MeasurementVectorType
typedef TInputSample::MeasurementType	MeasurementType
typedef TInputSample::FrequencyType	FrequencyType
typedef TInputSample::InstanceIdentifier	InstanceIdentifier
typedef Superclass::InputSampleType	InputSampleType
typedef FixedArray< double, itkGetStaticConstMacro(MeasurementVectorSize)	ArrayType )
typedef Vector< double, itkGetStaticConstMacro(MeasurementVectorSize)	MeanType )
typedef Histogram< THistogramMeasurement, 1 >	HistogramType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, TInputSample::MeasurementVectorSize)
virtual void	SetHistogram (HistogramType *histogram)
void	SetMean (MeanType *center)
MeanType *	GetMean ()
void	SetStandardDeviation (double *value)
double *	GetStandardDeviation ()
void	SetProjectionAxis (ArrayType *axis)
ArrayType *	GetProjectionAxis ()
void	SetHistogramBinOverlap (double overlap)
Static Public Methods
Pointer	New ()
Protected Methods
	SampleToHistogramProjectionFilter ()
virtual	~SampleToHistogramProjectionFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
float	CalculateOverlap (int binIndex, float dotProduct, float scale, float marginalDistance, bool firstHalf)
void	GenerateData ()

---

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.

Definition at line 47 of file itkSampleToHistogramProjectionFilter.h.

---

Member Typedef Documentation

template<class TInputSample, class THistogramMeasurement> typedef FixedArray< double, itkGetStaticConstMacro(MeasurementVectorSize) itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::ArrayType)

1D array typedef Definition at line 76 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 55 of file itkSampleToHistogramProjectionFilter.h.

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

Definition at line 68 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 83 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 72 of file itkSampleToHistogramProjectionFilter.h.

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

Definition at line 69 of file itkSampleToHistogramProjectionFilter.h.

template<class TInputSample, class THistogramMeasurement> typedef Vector< double, itkGetStaticConstMacro(MeasurementVectorSize) itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::MeanType)

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

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

Definition at line 67 of file itkSampleToHistogramProjectionFilter.h.

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

Definition at line 66 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 54 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 52 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 53 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 113 of file itkSampleToHistogramProjectionFilter.h.

---

Member Function Documentation

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

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

template<class TInputSample, class THistogramMeasurement> virtual const char* itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::GetClassName (    )  const [virtual]

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

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

Gets the mean of the sample

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

Gets the projection axis

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

Gets the standard deviation of the sample

template<class TInputSample, class THistogramMeasurement> itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::itkStaticConstMacro (  MeasurementVectorSize   , unsigned    int, TInputSample::MeasurementVectorSize    )

Enums and typedefs from the TInputSample

template<class TInputSample, class THistogramMeasurement> Pointer itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::New (    )  [static]

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

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

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, class THistogramMeasurement> void itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >::SetMean (  MeanType *    center )

Sets the mean of the sample

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

Sets the projection axis

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

Sets the standard deviation of the sample

---

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

• itkSampleToHistogramProjectionFilter.h

---