ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::Statistics::SampleToHistogramFilter< TSample, THistogram > Class Template Reference
Module ITKStatistics

Computes the Histogram corresponding to a Sample. More...

#include <itkSampleToHistogramFilter.h>

Inheritance diagram for itk::Statistics::SampleToHistogramFilter< TSample, THistogram >:
Collaboration diagram for itk::Statistics::SampleToHistogramFilter< TSample, THistogram >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef
Superclass::DataObjectPointer 		DataObjectPointer
typedef
HistogramType::MeasurementType 		HistogramMeasurementType
typedef
HistogramType::MeasurementVectorType 		HistogramMeasurementVectorType
typedef HistogramType::SizeType HistogramSizeType
typedef THistogram HistogramType
typedef
SimpleDataObjectDecorator
< bool > 		InputBooleanObjectType
typedef
SimpleDataObjectDecorator
< HistogramMeasurementType > 		InputHistogramMeasurementObjectType
typedef
SimpleDataObjectDecorator
< HistogramMeasurementVectorType > 		InputHistogramMeasurementVectorObjectType
typedef
SimpleDataObjectDecorator
< HistogramSizeType > 		InputHistogramSizeObjectType
typedef
MeasurementVectorType::ValueType 		MeasurementType
typedef
SampleType::MeasurementVectorType 		MeasurementVectorType
typedef SmartPointer< Self > Pointer
typedef TSample SampleType
typedef SampleToHistogramFilter Self
typedef ProcessObject Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const SampleType * GetInput () const
virtual const char * GetNameOfClass () const
const HistogramType * GetOutput () const
virtual void GraftOutput (DataObject *output)
 itkSetGetDecoratedInputMacro (AutoMinimumMaximum, bool)
 itkSetGetDecoratedInputMacro (MarginalScale, HistogramMeasurementType)
 itkSetGetDecoratedInputMacro (HistogramSize, HistogramSizeType)
virtual void SetInput (const SampleType *sample)
 itkSetGetDecoratedInputMacro (HistogramBinMinimum, HistogramMeasurementVectorType)
 itkSetGetDecoratedInputMacro (HistogramBinMaximum, HistogramMeasurementVectorType)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual void GenerateData ()
void PrintSelf (std::ostream &os, Indent indent) const
 SampleToHistogramFilter ()
virtual ~SampleToHistogramFilter ()

Private Member Functions

void operator= (const Self &)
 SampleToHistogramFilter (const Self &)
HistogramMeasurementType SafeAssign (MeasurementType from) const
typedef
ProcessObject::DataObjectPointerArraySizeType 		DataObjectPointerArraySizeType
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)

Detailed Description

template<class TSample, class THistogram>
class itk::Statistics::SampleToHistogramFilter< TSample, THistogram >

Computes the Histogram corresponding to a Sample.

This filter produces as output the histogram corresponding to the values of a Sample.

See also:
Sample, Histogram
Wiki Examples:

Definition at line 55 of file itkSampleToHistogramFilter.h.

Member Typedef Documentation

template<class TSample , class THistogram >
typedef SmartPointer< const Self > itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::ConstPointer

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef Superclass::DataObjectPointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::DataObjectPointer

Type for the data object output

Reimplemented from itk::ProcessObject.

Definition at line 80 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::DataObjectPointerArraySizeType [protected]

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also:
ProcessObject

Reimplemented from itk::ProcessObject.

Definition at line 148 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef HistogramType::MeasurementType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramMeasurementType

Definition at line 76 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef HistogramType::MeasurementVectorType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramMeasurementVectorType

Definition at line 77 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef HistogramType::SizeType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramSizeType

Definition at line 75 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef THistogram itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::HistogramType

Definition at line 72 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SimpleDataObjectDecorator< bool > itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputBooleanObjectType

Type of DataObjects to use for AutoMinimumMaximum input

Definition at line 106 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SimpleDataObjectDecorator< HistogramMeasurementType > itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputHistogramMeasurementObjectType

Type of DataObjects to use for Marginal Scale inputs

Definition at line 98 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SimpleDataObjectDecorator< HistogramMeasurementVectorType > itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputHistogramMeasurementVectorObjectType

Type of DataObjects to use for Minimum and Maximums values of the histogram bins.

Definition at line 103 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SimpleDataObjectDecorator< HistogramSizeType > itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::InputHistogramSizeObjectType

Type of DataObjects to use for Size inputs

Definition at line 94 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef MeasurementVectorType::ValueType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MeasurementType

Definition at line 74 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SampleType::MeasurementVectorType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MeasurementVectorType

Definition at line 73 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SmartPointer< Self > itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 61 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef TSample itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleType

MeasurementVector typedef support

Definition at line 68 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef SampleToHistogramFilter itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Self

Standard class typedefs

Reimplemented from itk::ProcessObject.

Definition at line 59 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
typedef ProcessObject itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 60 of file itkSampleToHistogramFilter.h.

Constructor & Destructor Documentation

template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleToHistogramFilter ( ) [protected]
template<class TSample , class THistogram >
virtual itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::~SampleToHistogramFilter ( ) [protected, virtual]
template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SampleToHistogramFilter ( const Self &  ) [private]

Member Function Documentation

template<class TSample , class THistogram >
virtual::itk::LightObject::Pointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::CreateAnother ( void  ) const [virtual]

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

template<class TSample , class THistogram >
virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GenerateData ( void  ) [protected, virtual]

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >
virtual const SampleType* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetInput ( ) const [virtual]
template<class TSample , class THistogram >
virtual const char* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods)

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >
const HistogramType* itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GetOutput ( ) const

Get the output Histogram

template<class TSample , class THistogram >
virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::GraftOutput ( DataObject *  output) [virtual]

Method that facilitates the use of this filter in the internal pipeline of another filter.

template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro ( MarginalScale  ,
HistogramMeasurementType   
)

Methods for setting and getting the Marginal scale value. The marginal scale is used when the type of the measurement vector componets are of integer type.

template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro ( AutoMinimumMaximum  ,
bool   
)

Methods for setting and getting the boolean flag that defines whether the minimum and maximum of the histogram are going to be computed automatically from the values of the sample

template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro ( HistogramBinMinimum  ,
HistogramMeasurementVectorType   
)

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro ( HistogramBinMaximum  ,
HistogramMeasurementVectorType   
)

Methods for setting and getting the Minimum and Maximum values of the histogram bins.

template<class TSample , class THistogram >
itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::itkSetGetDecoratedInputMacro ( HistogramSize  ,
HistogramSizeType   
)

Methods for setting and getting the histogram size. The histogram size is encapsulated inside a decorator class. For this reason, it is possible to set and get the decorator class, but it is only possible to set the histogram size by value. This macro declares the methods SetHistogramSize(), SetHistogramSizeInput(), GetHistogramSizeInput().

template<class TSample , class THistogram >
virtual DataObjectPointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::MakeOutput ( DataObjectPointerArraySizeType  idx) [protected, virtual]

Make a DataObject of the correct type to used as the specified output. This method is automatically called when DataObject::DisconnectPipeline() is called.

See also:
ProcessObject

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >
static Pointer itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TSample , class THistogram >
void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::operator= ( const Self &  ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

template<class TSample , class THistogram >
void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::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::ProcessObject.

template<class TSample , class THistogram >
HistogramMeasurementType itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SafeAssign ( MeasurementType  from) const [inline, private]

SafeAssign -- avoid numeric overflow/underflow

Definition at line 161 of file itkSampleToHistogramFilter.h.

template<class TSample , class THistogram >
virtual void itk::Statistics::SampleToHistogramFilter< TSample, THistogram >::SetInput ( const SampleType *  sample) [virtual]

Set/Get the input sample

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 01:54:06 for ITK by doxygen 1.7.4