Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::Statistics::WeightedCovarianceCalculator< TSample > Class Template Reference

Calculates the covariance matrix of the target sample data where each measurement vector has an associated weight value. More...

#include <itkWeightedCovarianceCalculator.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::Statistics::WeightedCovarianceCalculator< TSample >:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

virtual const char * GetNameOfClass () const
Pointer New ()

Public Types

typedef WeightedCovarianceCalculator Self
typedef SampleAlgorithmBase<
TSample > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
typedef TSample::MeasurementVectorType MeasurementVectorType
typedef FunctionBase< MeasurementVectorType,
double > 
WeightFunctionType
typedef Array< double > MeanType
typedef VariableSizeMatrix<
double > 
OutputType
typedef Array< double > WeightArrayType

Public Member Functions

void SetWeights (WeightArrayType *array)
WeightArrayTypeGetWeights ()
void SetWeightFunction (WeightFunctionType *func)
WeightFunctionTypeGetWeightFunction ()
void SetMean (MeanType *mean)
MeanTypeGetMean ()
OutputTypeGetOutput ()

Protected Member Functions

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

Detailed Description

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

Calculates the covariance matrix of the target sample data where each measurement vector has an associated weight value.

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. It is now obtained from the input sample. Please use the function GetMeasurementVectorSize() to obtain the length. The mean output is an Array rather than a Vector. The covariance matrix is represented by a VariableSizeMatrix rather than a Matrix.

See also:
CovarianceCalculator SampleAlgorithmBase

Definition at line 42 of file itkWeightedCovarianceCalculator.h.


Member Typedef Documentation

template<class TSample>
typedef SmartPointer<const Self> itk::Statistics::WeightedCovarianceCalculator< TSample >::ConstPointer
 

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 50 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef Array< double > itk::Statistics::WeightedCovarianceCalculator< TSample >::MeanType
 

Typedef for the mean output

Definition at line 67 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef Superclass::MeasurementVectorSizeType itk::Statistics::WeightedCovarianceCalculator< TSample >::MeasurementVectorSizeType
 

Length of a measurement vector

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 58 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef TSample::MeasurementVectorType itk::Statistics::WeightedCovarianceCalculator< TSample >::MeasurementVectorType
 

Measurement vector typedef

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 61 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef VariableSizeMatrix< double > itk::Statistics::WeightedCovarianceCalculator< TSample >::OutputType
 

Typedef for Covariance output

Definition at line 70 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef SmartPointer<Self> itk::Statistics::WeightedCovarianceCalculator< TSample >::Pointer
 

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 49 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef WeightedCovarianceCalculator itk::Statistics::WeightedCovarianceCalculator< TSample >::Self
 

Standard class typedefs.

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 47 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef SampleAlgorithmBase< TSample > itk::Statistics::WeightedCovarianceCalculator< TSample >::Superclass
 

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 48 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef Array< double > itk::Statistics::WeightedCovarianceCalculator< TSample >::WeightArrayType
 

Array typedef for weights

Definition at line 73 of file itkWeightedCovarianceCalculator.h.

template<class TSample>
typedef FunctionBase< MeasurementVectorType, double > itk::Statistics::WeightedCovarianceCalculator< TSample >::WeightFunctionType
 

Weight calculation function typedef

Definition at line 64 of file itkWeightedCovarianceCalculator.h.


Constructor & Destructor Documentation

template<class TSample>
itk::Statistics::WeightedCovarianceCalculator< TSample >::WeightedCovarianceCalculator  )  [protected]
 

template<class TSample>
virtual itk::Statistics::WeightedCovarianceCalculator< TSample >::~WeightedCovarianceCalculator  )  [protected, virtual]
 


Member Function Documentation

template<class TSample>
void itk::Statistics::WeightedCovarianceCalculator< TSample >::ComputeCovarianceWithGivenMean  )  [protected]
 

template<class TSample>
void itk::Statistics::WeightedCovarianceCalculator< TSample >::ComputeCovarianceWithoutGivenMean  )  [protected]
 

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

Calculates the covariance and save it

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample>
MeanType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetMean  ) 
 

Gets the mean

template<class TSample>
virtual const char* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetNameOfClass  )  const [virtual]
 

Standard Macros

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample>
OutputType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetOutput  ) 
 

Returns the covariance matrix of the target sample data

template<class TSample>
WeightFunctionType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetWeightFunction  ) 
 

Gets the weight function

template<class TSample>
WeightArrayType* itk::Statistics::WeightedCovarianceCalculator< TSample >::GetWeights  ) 
 

Gets the weights array

template<class TSample>
Pointer itk::Statistics::WeightedCovarianceCalculator< TSample >::New  )  [static]
 

Standard Macros

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample>
void itk::Statistics::WeightedCovarianceCalculator< 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::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample>
void itk::Statistics::WeightedCovarianceCalculator< TSample >::SetMean MeanType mean  ) 
 

Sets the mean (input)

template<class TSample>
void itk::Statistics::WeightedCovarianceCalculator< TSample >::SetWeightFunction WeightFunctionType func  ) 
 

Sets the weights using an function the function should have a method, Evaluate(MeasurementVectorType&).

template<class TSample>
void itk::Statistics::WeightedCovarianceCalculator< TSample >::SetWeights WeightArrayType array  ) 
 

Sets the weights using an array


The documentation for this class was generated from the following file:
Generated at Thu May 25 03:17:26 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000