FREE::VectorSampleCharacteristicsCalculator< TVectorField > Class Template Reference
[Evaluation tools]

Calculate the global mean vector and variance vector. More...

#include <freVectorSampleCharacteristicsCalculator.h>

List of all members.

Public Types
typedef VectorSampleCharacteristicsCalculator	Self
typedef TVectorField	VectorFieldType
typedef VectorFieldType::ValueType	VectorType
typedef itk::VariableSizeMatrix < typename VectorType::ComponentType >	CovarianceMatrixType
typedef itk::Array < typename VectorType::ComponentType >	MeanType
Public Member Functions
void	Compute ()
void	ComputeMean ()
void	ComputeCovariance (const MeanType &mean)
MeanType	GetMean () const
MeanType	GetVariance () const
CovarianceMatrixType	GetCovariance () const
void	SetVectorField (const VectorFieldType *pField)
	VectorSampleCharacteristicsCalculator ()
Private Attributes
VectorFieldType::ConstPointer	m_smpImage
MeanType	m_Mean
CovarianceMatrixType	m_CovarianceMatrix
unsigned int	m_iMatrixSize

---

Detailed Description

template<class TVectorField>
class FREE::VectorSampleCharacteristicsCalculator< TVectorField >

Calculate the global mean vector and variance vector.

The class calculates a mean and a variance vector from the given image. The class asumes the passed image has an itk:Vector as value type.

Definition at line 40 of file freVectorSampleCharacteristicsCalculator.h.

---

Member Typedef Documentation

template<class TVectorField>

typedef VectorSampleCharacteristicsCalculator FREE::VectorSampleCharacteristicsCalculator< TVectorField >::Self

Standard class typedefs.

Definition at line 44 of file freVectorSampleCharacteristicsCalculator.h.

template<class TVectorField>

typedef TVectorField FREE::VectorSampleCharacteristicsCalculator< TVectorField >::VectorFieldType

Definition at line 45 of file freVectorSampleCharacteristicsCalculator.h.

template<class TVectorField>

typedef VectorFieldType::ValueType FREE::VectorSampleCharacteristicsCalculator< TVectorField >::VectorType

Definition at line 46 of file freVectorSampleCharacteristicsCalculator.h.

template<class TVectorField>

typedef itk::VariableSizeMatrix<typename VectorType::ComponentType> FREE::VectorSampleCharacteristicsCalculator< TVectorField >::CovarianceMatrixType

Definition at line 47 of file freVectorSampleCharacteristicsCalculator.h.

template<class TVectorField>

typedef itk::Array<typename VectorType::ComponentType> FREE::VectorSampleCharacteristicsCalculator< TVectorField >::MeanType

Definition at line 48 of file freVectorSampleCharacteristicsCalculator.h.

---

Constructor & Destructor Documentation

template<class TVectorField>

FREE::VectorSampleCharacteristicsCalculator< TVectorField >::VectorSampleCharacteristicsCalculator

(

)

[inline]

Definition at line 139 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_CovarianceMatrix, FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_iMatrixSize, and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_Mean.

---

Member Function Documentation

template<class TVectorField>

void FREE::VectorSampleCharacteristicsCalculator< TVectorField >::Compute

(

)

[inline]

Computes the mean and the covariance in one turn and caches them.

Definition at line 38 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_CovarianceMatrix, FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_iMatrixSize, FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_Mean, and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_smpImage.

template<class TVectorField>

void FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeMean

(

)

[inline]

Computes the mean and caches it.

Definition at line 60 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_Mean, and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_smpImage.

template<class TVectorField>

void FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeCovariance

(

const MeanType &

mean

)

[inline]

Computes the covariance with the passed mean and caches the covariance matrix.

Definition at line 80 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_CovarianceMatrix, FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_iMatrixSize, FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_Mean, and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_smpImage.

template<class TVectorField>

VectorSampleCharacteristicsCalculator< TVectorField >::MeanType FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetMean

(

)

const [inline]

Definition at line 104 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_Mean.

template<class TVectorField>

VectorSampleCharacteristicsCalculator< TVectorField >::MeanType FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetVariance

(

)

const [inline]

Definition at line 112 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_CovarianceMatrix, and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_iMatrixSize.

template<class TVectorField>

VectorSampleCharacteristicsCalculator< TVectorField >::CovarianceMatrixType FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetCovariance

(

)

const [inline]

Definition at line 124 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_CovarianceMatrix.

template<class TVectorField>

void FREE::VectorSampleCharacteristicsCalculator< TVectorField >::SetVectorField

(

const VectorFieldType *

pField

)

[inline]

Definition at line 132 of file freVectorSampleCharacteristicsCalculator.txx.

References FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_smpImage.

---

Member Data Documentation

template<class TVectorField>

VectorFieldType::ConstPointer FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_smpImage [private]

Definition at line 70 of file freVectorSampleCharacteristicsCalculator.h.

Referenced by FREE::VectorSampleCharacteristicsCalculator< TVectorField >::Compute(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeCovariance(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeMean(), and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::SetVectorField().

template<class TVectorField>

MeanType FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_Mean [private]

Definition at line 72 of file freVectorSampleCharacteristicsCalculator.h.

Referenced by FREE::VectorSampleCharacteristicsCalculator< TVectorField >::Compute(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeCovariance(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeMean(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetMean(), and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::VectorSampleCharacteristicsCalculator().

template<class TVectorField>

CovarianceMatrixType FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_CovarianceMatrix [private]

Definition at line 74 of file freVectorSampleCharacteristicsCalculator.h.

Referenced by FREE::VectorSampleCharacteristicsCalculator< TVectorField >::Compute(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeCovariance(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetCovariance(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetVariance(), and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::VectorSampleCharacteristicsCalculator().

template<class TVectorField>

unsigned int FREE::VectorSampleCharacteristicsCalculator< TVectorField >::m_iMatrixSize [private]

Must be used because the itk implementation of itk::VariableSizeMatrix::Cols() is non const and cannot be used in GetVariance()

Definition at line 77 of file freVectorSampleCharacteristicsCalculator.h.

Referenced by FREE::VectorSampleCharacteristicsCalculator< TVectorField >::Compute(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::ComputeCovariance(), FREE::VectorSampleCharacteristicsCalculator< TVectorField >::GetVariance(), and FREE::VectorSampleCharacteristicsCalculator< TVectorField >::VectorSampleCharacteristicsCalculator().

---

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

• freVectorSampleCharacteristicsCalculator.h
• freVectorSampleCharacteristicsCalculator.txx

---