Calculates the covariance matrix of the target sample data. More...

#include <itkCovarianceSampleFilter.h>

Inheritance diagram for itk::Statistics::CovarianceSampleFilter< TSample >:

Collaboration diagram for itk::Statistics::CovarianceSampleFilter< TSample >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SimpleDataObjectDecorator < MatrixType >	MatrixDecoratedType
typedef VariableSizeMatrix < double >	MatrixType
typedef NumericTraits < MeasurementType >::RealType	MeasurementRealType
typedef TSample::MeasurementType	MeasurementType
typedef SimpleDataObjectDecorator < MeasurementVectorRealType >	MeasurementVectorDecoratedType
typedef NumericTraits < MeasurementVectorType > ::RealType	MeasurementVectorRealType
typedef TSample::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef MeasurementVectorDecoratedType	OutputType
typedef SmartPointer< Self >	Pointer
typedef TSample	SampleType
typedef CovarianceSampleFilter	Self
typedef ProcessObject	Superclass
Public Member Functions
const MatrixType	GetCovarianceMatrix () const
const MatrixDecoratedType *	GetCovarianceMatrixOutput () const
const SampleType *	GetInput () const
const MeasurementVectorRealType	GetMean () const
const MeasurementVectorDecoratedType *	GetMeanOutput () const
MeasurementVectorSizeType	GetMeasurementVectorSize () const
void	SetInput (const SampleType *sample)
Protected Types
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Protected Member Functions
	CovarianceSampleFilter ()
void	GenerateData ()
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~CovarianceSampleFilter ()
Private Member Functions
	CovarianceSampleFilter (const Self &)
void	operator= (const Self &)
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
static Pointer	New ()

Detailed Description

template<class TSample>
class itk::Statistics::CovarianceSampleFilter< TSample >

Calculates the covariance matrix of the target sample data.

The filter calculates first the sample mean and use it in the covariance calculation. The covariance is computed as follows Let $\Sigma$ denotes covariance matrix for the sample, then: When $x_{i}$ is $i$ th component of a measurement vector $\vec x$ , $\mu_{i}$ is the $i$ th component of the $\vec\mu$ , and the $\sigma_{ij}$ is the $ij$ th component $\Sigma$ , $\sigma_{ij} = (x_{i} - \mu_{i})(x_{j} - \mu_{j})$

This estimator is an unbiased one, because it divisor in the covariance computation takes into account that one degree of freedom has been taken for computing the mean.

Without the plugged in mean vector, this calculator will perform the single pass mean and covariance calculation algorithm.

Definition at line 52 of file itkCovarianceSampleFilter.h.

Member Typedef Documentation

template<class TSample >

typedef SmartPointer< const Self > itk::Statistics::CovarianceSampleFilter< TSample >::ConstPointer

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 60 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef DataObject::Pointer itk::Statistics::CovarianceSampleFilter< TSample >::DataObjectPointer [protected]

DataObject pointer

Reimplemented from itk::ProcessObject.

Definition at line 118 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::CovarianceSampleFilter< TSample >::DataObjectPointerArraySizeType [protected]

Reimplemented from itk::ProcessObject.

Definition at line 120 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef SimpleDataObjectDecorator< MatrixType > itk::Statistics::CovarianceSampleFilter< TSample >::MatrixDecoratedType

VariableSizeMatrix is not a DataObject, we need to decorate it to push it down a ProcessObject's pipeline

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 92 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef VariableSizeMatrix< double > itk::Statistics::CovarianceSampleFilter< TSample >::MatrixType

Typedef for Covariance output

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 82 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef NumericTraits< MeasurementType >::RealType itk::Statistics::CovarianceSampleFilter< TSample >::MeasurementRealType

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 76 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef TSample::MeasurementType itk::Statistics::CovarianceSampleFilter< TSample >::MeasurementType

Type of vector elements

Definition at line 75 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef SimpleDataObjectDecorator< MeasurementVectorRealType > itk::Statistics::CovarianceSampleFilter< TSample >::MeasurementVectorDecoratedType

MeasurementVector is not a DataObject, we need to decorate it to push it down a ProcessObject's pipeline

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 96 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef NumericTraits< MeasurementVectorType >::RealType itk::Statistics::CovarianceSampleFilter< TSample >::MeasurementVectorRealType

Type of the measurement vector type

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 79 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef TSample::MeasurementVectorSizeType itk::Statistics::CovarianceSampleFilter< TSample >::MeasurementVectorSizeType

Length of a measurement vector

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 65 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef TSample::MeasurementVectorType itk::Statistics::CovarianceSampleFilter< TSample >::MeasurementVectorType

Measurement vector type

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 72 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef MeasurementVectorDecoratedType itk::Statistics::CovarianceSampleFilter< TSample >::OutputType

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 98 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef SmartPointer< Self > itk::Statistics::CovarianceSampleFilter< TSample >::Pointer

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 59 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef TSample itk::Statistics::CovarianceSampleFilter< TSample >::SampleType

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 61 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef CovarianceSampleFilter itk::Statistics::CovarianceSampleFilter< TSample >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 57 of file itkCovarianceSampleFilter.h.

template<class TSample >

typedef ProcessObject itk::Statistics::CovarianceSampleFilter< TSample >::Superclass

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

Definition at line 58 of file itkCovarianceSampleFilter.h.

Constructor & Destructor Documentation

template<class TSample >

itk::Statistics::CovarianceSampleFilter< TSample >::CovarianceSampleFilter ( ) [protected]

template<class TSample >

virtual itk::Statistics::CovarianceSampleFilter< TSample >::~CovarianceSampleFilter ( ) [protected, virtual]

template<class TSample >

itk::Statistics::CovarianceSampleFilter< TSample >::CovarianceSampleFilter ( const Self & ) [private]

Member Function Documentation

template<class TSample >

virtual::itk::LightObject::Pointer itk::Statistics::CovarianceSampleFilter< TSample >::CreateAnother ( void ) const [virtual]

Standard Macros

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::CovarianceSampleFilter< TSample >::GenerateData ( void ) [protected, virtual]

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

template<class TSample >

const MatrixType itk::Statistics::CovarianceSampleFilter< TSample >::GetCovarianceMatrix ( ) const

Return the covariance matrix

template<class TSample >

const MatrixDecoratedType* itk::Statistics::CovarianceSampleFilter< TSample >::GetCovarianceMatrixOutput ( ) const

template<class TSample >

const SampleType* itk::Statistics::CovarianceSampleFilter< TSample >::GetInput ( ) const

template<class TSample >

const MeasurementVectorRealType itk::Statistics::CovarianceSampleFilter< TSample >::GetMean ( ) const

Return the mean vector

template<class TSample >

const MeasurementVectorDecoratedType* itk::Statistics::CovarianceSampleFilter< TSample >::GetMeanOutput ( ) const

template<class TSample >

MeasurementVectorSizeType itk::Statistics::CovarianceSampleFilter< TSample >::GetMeasurementVectorSize ( ) const

template<class TSample >

virtual const char* itk::Statistics::CovarianceSampleFilter< TSample >::GetNameOfClass ( ) const [virtual]

Standard Macros

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

template<class TSample >

virtual DataObjectPointer itk::Statistics::CovarianceSampleFilter< TSample >::MakeOutput ( DataObjectPointerArraySizeType idx ) [protected, virtual]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<class TSample >

static Pointer itk::Statistics::CovarianceSampleFilter< TSample >::New ( ) [static]

Standard Macros

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::CovarianceSampleFilter< TSample >::operator= ( const Self & ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

template<class TSample >

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

Reimplemented in itk::Statistics::WeightedCovarianceSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::CovarianceSampleFilter< TSample >::SetInput ( const SampleType * sample )

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

itkCovarianceSampleFilter.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Detailed Description

template<class TSample> class itk::Statistics::CovarianceSampleFilter< TSample >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class TSample>
class itk::Statistics::CovarianceSampleFilter< TSample >