Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
itk::Statistics::CovarianceCalculator

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

#include <itkCovarianceCalculator.h>

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Calculates the covariance matrix of the target sample data.

If there is a mean vector provided by the SetMean method, this calculator will do the caculation 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 componet of the $\vec\mu$ , and the $\sigma_{ij}$ is the $ij$ th componet $\Sigma$ , $\sigma_{ij} = (x_{i} - \mu_{i})(x_{j} - \mu_{j})$

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

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.

Definition at line 53 of file itkCovarianceCalculator.h.

Public Types

typedef SmartPointer< const
Self > 		ConstPointer
typedef TSample InputSampleType
typedef Array< double > MeanType
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType MeasurementVectorType
typedef VariableSizeMatrix<
double > 		OutputType
typedef SmartPointer< Self > Pointer
typedef CovarianceCalculator Self
typedef SampleAlgorithmBase<
TSample > 		Superclass

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
Command * GetCommand (unsigned long tag)
bool GetDebug () const
const TSample * GetInputSample () const
MeanType * GetMean ()
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
const MetaDataDictionary & GetMetaDataDictionary (void) const
MetaDataDictionary & GetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
Standard Macros *virtual const
char * 		GetNameOfClass () const
const OutputType * GetOutput () const
virtual int GetReferenceCount () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
Stores the sample pointer
*void 		SetInputSample (const TSample *sample)
void SetMean (MeanType *mean)
virtual void SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
void Update ()

Static Public Member Functions

static void BreakOnError ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
This is a global flag that
controls whether any warning
*or error messages are displayed
*static void 		SetGlobalWarningDisplay (bool flag)

Public Attributes

Allow people to add remove
invoke observers(callbacks)
to any ITK *object.This is
an implementation of the subject/observer design *pattern.An
observer is added by specifying
an event to respond to *and
an itk unsigned lon 		AddObserver )(const EventObject &event, Command *) const
This is a global flag that
controls whether any 		debug

Protected Member Functions

void ComputeCovarianceWithGivenMean ()
void ComputeCovarianceWithoutGivenMean ()
 CovarianceCalculator ()
void GenerateData ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 SampleAlgorithmBase ()
virtual ~CovarianceCalculator ()

Protected Attributes

int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
Methods invoked by virtual
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.*/virtual
void PrintSelf(std voi 		PrintHeader )(std::ostream &os, Indent indent) const

Member Typedef Documentation

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

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

Definition at line 61 of file itkCovarianceCalculator.h.

typedef TSample itk::Statistics::SampleAlgorithmBase< TSample >::InputSampleType [inherited]
 

Sample typedefs alias

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >, and itk::Statistics::SampleMeanShiftBlurringFilter< TSample >.

Definition at line 59 of file itkSampleAlgorithmBase.h.

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

Typedef for the mean output

Definition at line 75 of file itkCovarianceCalculator.h.

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

Length of a measurement vector

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

Definition at line 65 of file itkCovarianceCalculator.h.

template<class TSample>
typedef Superclass::MeasurementVectorType itk::Statistics::CovarianceCalculator< TSample >::MeasurementVectorType
 

Measurement vector type

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

Definition at line 72 of file itkCovarianceCalculator.h.

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

Typedef for Covariance output

Definition at line 78 of file itkCovarianceCalculator.h.

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

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

Definition at line 60 of file itkCovarianceCalculator.h.

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

Standard class typedefs.

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

Definition at line 58 of file itkCovarianceCalculator.h.

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

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

Definition at line 59 of file itkCovarianceCalculator.h.

Constructor & Destructor Documentation

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

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

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]
 

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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

Calculates the covariance matrix using the given mean

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

Calculates the covariance matrix and the mean in a single pass

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]
 

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

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]
 

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]
 

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]
 

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

Calculates the covariance and save it. This method calls ComputeCovarianceWithGivenMean, if the user provides mean vector using SetMean method. Otherwise, it calls ComputeCovarianceWithoutGivenMethod depending on

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

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]
 

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]
 

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]
 

const TSample * itk::Statistics::SampleAlgorithmBase< TSample >::GetInputSample (   )  const [inline, inherited]
 

Definition at line 82 of file itkSampleAlgorithmBase.h.

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

Returns the sample pointer

virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TSample >::GetMeasurementVectorSize (   )  const [virtual, inherited]
 

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]
 

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]
 

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]
 

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TSample>
Standard Macros* virtual const char* itk::Statistics::CovarianceCalculator< TSample >::GetNameOfClass (   )  const [virtual]
 

Standard part of all itk objects.

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

template<class TSample>
const OutputType* itk::Statistics::CovarianceCalculator< TSample >::GetOutput (   )  const
 

Returns the covariance matrix of the target sample data

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]
 

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]
 

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]
 

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]
 

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]
 

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]
 

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]
 

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Method for creation through the object factory.

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

void itk::LightObject::Print (  std::ostream &  os,
Indent  indent = 0
)  const [inherited]
 

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os,
Indent  indent
)  const [protected, inherited]
 

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

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os,
Indent  indent
)  const [protected, virtual, inherited]
 

virtual void itk::Object::Register (   )  const [virtual, inherited]
 

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]
 

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]
 

Remove the observer with this tag value.

itk::Statistics::SampleAlgorithmBase< TSample >::SampleAlgorithmBase (   )  [protected, inherited]
 

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]
 

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]
 

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

Stores the sample pointer* void itk::Statistics::SampleAlgorithmBase< TSample >::SetInputSample (  const TSample *  sample  )  [inline, inherited]
 

Definition at line 63 of file itkSampleAlgorithmBase.h.

template<class TSample>
void itk::Statistics::CovarianceCalculator< TSample >::SetMean (  MeanType *  mean  ) 
 

Stores the sample pointer

virtual void itk::Statistics::SampleAlgorithmBase< TSample >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual, inherited]
 

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]
 

Returns:
Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]
 

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]
 

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

void itk::Statistics::SampleAlgorithmBase< TSample >::Update (  void   )  [inline, inherited]
 

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming

Definition at line 88 of file itkSampleAlgorithmBase.h.

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]
 

This is a global flag that controls whether any itk::Object::debug [inherited]
 

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]
 

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]
 

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]
 

The documentation for this class was generated from the following file:
Generated at Mon Jul 10 00:21:10 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000