mitkMetric Class Reference

mitkMetric - an abstract class specifies interface for computing similarity between regions of two volumes More...

#include <mitkMetric.h>

Inherits mitkProcessObject.

Inherited by mitkMeanSquaresMetric, mitkNormalizedCorrelationMetric, and mitkPointSetMetric.

Inheritance diagram for mitkMetric:

[legend]Collaboration diagram for mitkMetric:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
void	SetFixedVolume (mitkVolume *fixedVolume)
mitkVolume *	GetFixedVolume ()
void	SetMovingVolume (mitkVolume *movingVolume)
mitkVolume *	GetMovingVolume ()
void	SetInterpolator (mitkInterpolateFilter *interpolator)
mitkInterpolateFilter *	GetInterpolator ()
void	SetTransform (mitkTransform *transform)
mitkTransform *	GetTransform ()
void	SetTransformParameters (const VectorParameterType &parameters)
VectorParameterType &	GetTransformParameters ()
virtual void	Update ()
ScalarParameterType	GetSimilarity ()
virtual bool	GetSimilarity (const mitkMatrixType *matrix, ScalarParameterType &similarity)
virtual bool	GetSimilarity (const VectorParameterType &parameters, ScalarParameterType &similarity)
virtual bool	GetSimilarityAndDerivative (const VectorParameterType &parameters, ScalarParameterType &similarity, VectorParameterType &derivative)
mitkInterpolateFilter *	GetGradientImageInterpolator ()
void	SetComputeImageGradientFlag (bool flag)
void	SetInitialTransformMatrix ()
void	SetInitialTransformMatrix (mitkMatrixScalarType *matrix)

---

Detailed Description

mitkMetric - an abstract class specifies interface for computing similarity between regions of two volumes

mitkMetric is an abstract class specifies interface for computing similarity between regions of two volumes. This Class expects a Transform and an Interpolator to be plugged in. This particular class is the base class for a hierarchy of similarity metrics.

This class computes a value that measures the similarity between the Fixed image and the transformed Moving image. The Interpolator is used to compute intensity values on non-grid positions resulting from mapping points through the Transform.

---

Member Function Documentation

mitkVolume* mitkMetric::GetFixedVolume (   )  [inline]

Get the Fixed Volume. Returns: Return the pointer to the fixed volume.

mitkInterpolateFilter* mitkMetric::GetGradientImageInterpolator (   )

Get the Gaussian Derivative Interpolator. Returns: Return the pointer to the Gaussian Derivative Interpolator.

mitkInterpolateFilter* mitkMetric::GetInterpolator (   )

Get the Interpolator. Returns: Return the pointer to the Interpolator.

mitkVolume* mitkMetric::GetMovingVolume (   )  [inline]

Get the Moving Volume. Returns: Return the pointer to the moving volume.

virtual bool mitkMetric::GetSimilarity (  const VectorParameterType &  parameters, ScalarParameterType &  similarity )  [virtual]

Get Similarity between regions of two volumes. Parameters: parameters  The vector pointer to the transform parameters. similarity  The metric results. Returns: Return true if the metric computation is performed without error. Reimplemented in mitkMeanSquaresMetric, and mitkNormalizedCorrelationMetric.

virtual bool mitkMetric::GetSimilarity (  const mitkMatrixType *  matrix, ScalarParameterType &  similarity )  [virtual]

Get Similarity between fixed input and moving input. Parameters: matrix  The vector pointer to the transform matrix. similarity  The metric results. Returns: Return true if the metric computation is performed without error.

ScalarParameterType mitkMetric::GetSimilarity (   )  [inline]

Get Similarity between fixed input and moving input. Returns: Return the similarity.

virtual bool mitkMetric::GetSimilarityAndDerivative (  const VectorParameterType &  parameters, ScalarParameterType &  similarity, VectorParameterType &  derivative )  [virtual]

Get Similarity And Gradient Value between regions of two volumes. Parameters: transformParameters  The vector pointer to the transform parameters. similarity  Return the similarity. derivative  Return the gradient value in all dimensions. Returns: Return true if the metric computation is performed without error. Reimplemented in mitkMeanSquaresMetric, and mitkNormalizedCorrelationMetric.

mitkTransform* mitkMetric::GetTransform (   )

Get the Transform. Returns: Return the pointer to the Transform.

VectorParameterType& mitkMetric::GetTransformParameters (   )

Get the transform parameters. Returns: Return the vector pointer to the transform parameters.

virtual void mitkMetric::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkProcessObject. Reimplemented in mitkEuclideanDistanceMetric, mitkMeanSquaresMetric, mitkNormalizedCorrelationMetric, and mitkPointSetMetric.

void mitkMetric::SetComputeImageGradientFlag (  bool  flag  )

Set the Compute Derivative flag. Parameters: flag  Perform derivative computing if the value is true.

void mitkMetric::SetFixedVolume (  mitkVolume *  fixedVolume  )  [inline]

Set the Fixed Volume. Parameters: fixedVolume  The pointer to the fixed volume.

void mitkMetric::SetInitialTransformMatrix (  mitkMatrixScalarType *  matrix  )

Set the initial transform matrix. Parameters: matrix  The pointer to initial transform matrix.

void mitkMetric::SetInitialTransformMatrix (   )

Initial the transform matrix to identity matrix.

void mitkMetric::SetInterpolator (  mitkInterpolateFilter *  interpolator  )  [inline]

Set the Interpolator. Parameters: interpolator  The pointer to the Interpolator.

void mitkMetric::SetMovingVolume (  mitkVolume *  movingVolume  )  [inline]

Set the Moving Volume. Parameters: movingVolume  The pointer to the moving volume.

void mitkMetric::SetTransform (  mitkTransform *  transform  )  [inline]

Set the Transform. Parameters: transform  The pointer to the Transform.

void mitkMetric::SetTransformParameters (  const VectorParameterType &  parameters  )

Set the Transform parameters. Parameters: parameters  The vector pointer to the transform parameters.

virtual void mitkMetric::Update (   )  [virtual]

Initialize the Metric by making sure that all the components are present and plugged together correctly. Perform before Run() function. Reimplemented in mitkPointSetMetric.

---

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

• mitkMetric.h

---