ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType > Class Template Referenceabstract

#include <itkObjectToObjectMetricBase.h>

+ Inheritance diagram for itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >:
+ Collaboration diagram for itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType = double>
class itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >

Base class for all object-to-object similarlity metrics added in ITKv4.

This is the abstract base class for a hierarchy of similarity metrics that may, in derived classes, operate on meshes, images, etc. This class computes a value that measures the similarity between the two objects.

Derived classes must provide implementations for: GetValue GetDerivative GetValueAndDerivative Initialize GetNumberOfParameters GetNumberOfLocalParameters GetParameters SetParameters HasLocalSupport UpdateTransformParameters

Definition at line 50 of file itkObjectToObjectMetricBase.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
TInternalComputationValueType 
CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef DerivativeType::ValueType DerivativeValueType
 
enum  GradientSourceType {
  GRADIENT_SOURCE_FIXED =0,
  GRADIENT_SOURCE_MOVING,
  GRADIENT_SOURCE_BOTH
}
 
typedef Superclass::MeasureType MeasureType
 
enum  MetricCategoryType {
  UNKNOWN_METRIC = 0,
  OBJECT_METRIC = 1,
  IMAGE_METRIC = 2,
  POINT_SET_METRIC = 3,
  MULTI_METRIC = 4
}
 
typedef unsigned int NumberOfParametersType
 
typedef ObjectType::ConstPointer ObjectConstPointer
 
typedef Object ObjectType
 
typedef Superclass::ParametersType ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef
ObjectToObjectMetricBaseTemplate 
Self
 
typedef
SingleValuedCostFunctionv4Template
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< TInternalComputationValueType > 
DerivativeType
 
typedef
TInternalComputationValueType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedCostFunctionv4Template 
Self
 
typedef CostFunctionTemplate
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunctionTemplate Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

MeasureType GetCurrentValue () const
 
virtual void GetDerivative (DerivativeType &) const =0
 
virtual GradientSourceType GetGradientSource () const
 
bool GetGradientSourceIncludesFixed () const
 
bool GetGradientSourceIncludesMoving () const
 
virtual MetricCategoryType GetMetricCategory () const
 
virtual const char * GetNameOfClass () const
 
virtual const ParametersTypeGetParameters () const =0
 
virtual MeasureType GetValue () const override=0
 
virtual void GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override=0
 
virtual bool HasLocalSupport () const =0
 
virtual void Initialize (void)=0 throw ( ExceptionObject )
 
virtual void SetGradientSource (GradientSourceType _arg)
 
virtual void SetParameters (ParametersType &params)=0
 
virtual void UpdateTransformParameters (const DerivativeType &derivative, ParametersValueType factor=NumericTraits< ParametersValueType >::OneValue())=0
 
virtual void SetFixedObject (const ObjectType *_arg)
 
virtual const ObjectTypeGetFixedObject () const
 
virtual void SetMovingObject (const ObjectType *_arg)
 
virtual const ObjectTypeGetMovingObject () const
 
virtual NumberOfParametersType GetNumberOfParameters () const override=0
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const =0
 
- Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
virtual void GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 ObjectToObjectMetricBaseTemplate ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ObjectToObjectMetricBaseTemplate ()
 
- Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 SingleValuedCostFunctionv4Template ()
 
virtual ~SingleValuedCostFunctionv4Template ()
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ObjectConstPointer m_FixedObject
 
GradientSourceType m_GradientSource
 
ObjectConstPointer m_MovingObject
 
MeasureType m_Value
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 ObjectToObjectMetricBaseTemplate (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

template<typename TInternalComputationValueType = double>
typedef SmartPointer< const Self > itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ConstPointer

Definition at line 58 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef TInternalComputationValueType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::CoordinateRepresentationType

Type used for representing object components

Definition at line 61 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef Superclass::DerivativeType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::DerivativeType

Type of the derivative.

Definition at line 70 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef DerivativeType::ValueType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::DerivativeValueType

Definition at line 71 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef Superclass::MeasureType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::MeasureType

Type of the measure.

Definition at line 67 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef unsigned int itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::NumberOfParametersType

Type to represent the number of parameters that are being optimized at any given iteration of the optimizer.

Definition at line 128 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef ObjectType::ConstPointer itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ObjectConstPointer

Definition at line 79 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef Object itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ObjectType

Type of object.

Definition at line 78 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef Superclass::ParametersType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ParametersType

Type of the parameters.

Definition at line 74 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef TInternalComputationValueType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ParametersValueType

Definition at line 75 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef SmartPointer< Self > itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::Pointer

Definition at line 57 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef ObjectToObjectMetricBaseTemplate itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::Self

Standard class typedefs.

Definition at line 55 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
typedef SingleValuedCostFunctionv4Template<TInternalComputationValueType> itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::Superclass

Definition at line 56 of file itkObjectToObjectMetricBase.h.

Member Enumeration Documentation

template<typename TInternalComputationValueType = double>
enum itk::ObjectToObjectMetricBaseTemplate::GradientSourceType

Source of the gradient(s) used by the metric (e.g. image gradients, in the case of image to image metrics). Defaults to Moving.

Enumerator
GRADIENT_SOURCE_FIXED 
GRADIENT_SOURCE_MOVING 
GRADIENT_SOURCE_BOTH 

Definition at line 94 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
enum itk::ObjectToObjectMetricBaseTemplate::MetricCategoryType
Enumerator
UNKNOWN_METRIC 
OBJECT_METRIC 
IMAGE_METRIC 
POINT_SET_METRIC 
MULTI_METRIC 

Definition at line 177 of file itkObjectToObjectMetricBase.h.

Constructor & Destructor Documentation

template<typename TInternalComputationValueType = double>
itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ObjectToObjectMetricBaseTemplate ( )
protected
template<typename TInternalComputationValueType = double>
virtual itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::~ObjectToObjectMetricBaseTemplate ( )
protectedvirtual
template<typename TInternalComputationValueType = double>
itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::ObjectToObjectMetricBaseTemplate ( const Self )
private

Member Function Documentation

template<typename TInternalComputationValueType = double>
MeasureType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetCurrentValue ( ) const

Get the current metric value stored in m_Value. This is only meaningful after a call to GetValue() or GetValueAndDerivative(). Note that this would normally be called GetValue, but that name is used for historical reasons by GetValue() to compute the current metric value and store it in m_Value.

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetDerivative ( DerivativeType ) const
pure virtual
template<typename TInternalComputationValueType = double>
virtual const ObjectType* itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetFixedObject ( ) const
virtual

Get/Set the Fixed Object.

template<typename TInternalComputationValueType = double>
virtual GradientSourceType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetGradientSource ( ) const
virtual

Get gradient source. See GetGradientSourceIncludesFixed and GetGradientSourceIncludesMoving for convenience methods.

template<typename TInternalComputationValueType = double>
bool itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetGradientSourceIncludesFixed ( ) const

Return true of m_GradientSource is either GRADIENT_SOURCE_FIXED or GRADIENT_SOURCE_BOTH. Convenience method.

template<typename TInternalComputationValueType = double>
bool itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetGradientSourceIncludesMoving ( ) const

Return true of m_GradientSource is either GRADIENT_SOURCE_MOVING or GRADIENT_SOURCE_BOTH. Convenience method.

template<typename TInternalComputationValueType = double>
virtual MetricCategoryType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetMetricCategory ( ) const
inlinevirtual
template<typename TInternalComputationValueType = double>
virtual const ObjectType* itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetMovingObject ( ) const
virtual

Get/Set the Moving Object.

template<typename TInternalComputationValueType = double>
virtual const char* itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::PointDimension >, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >, itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, and itk::MeanSquaresImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >.

template<typename TInternalComputationValueType = double>
virtual NumberOfParametersType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetNumberOfLocalParameters ( ) const
pure virtual
template<typename TInternalComputationValueType = double>
virtual NumberOfParametersType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetNumberOfParameters ( ) const
overridepure virtual
template<typename TInternalComputationValueType = double>
virtual const ParametersType& itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetParameters ( ) const
pure virtual
template<typename TInternalComputationValueType = double>
virtual MeasureType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetValue ( ) const
overridepure virtual
template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::GetValueAndDerivative ( MeasureType value,
DerivativeType derivative 
) const
overridepure virtual

This method returns the derivative and value based on the current transformation(s).

template<typename TInternalComputationValueType = double>
virtual bool itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::HasLocalSupport ( ) const
pure virtual
template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::Initialize ( void  )
throw (ExceptionObject
)
pure virtual

Initialize the Metric by making sure that all the components are present and plugged together correctly, and initializing internal variables as required. This is for one-time initialization, e.g. before starting an optimization process.

Implemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::PointDimension >, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, and itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>
void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::operator= ( const Self )
private
template<typename TInternalComputationValueType = double>
void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::CostFunctionTemplate< TInternalComputationValueType >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage, TInternalComputationValueType >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::PointDimension >, TInternalComputationValueType >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::MeanSquaresImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, and itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::SetFixedObject ( const ObjectType _arg)
virtual
template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::SetGradientSource ( GradientSourceType  _arg)
virtual

Set source of gradient. This variable allows the user to switch between calculating the gradient with respect to the fixed object or moving object.

See Also
GradientSourceType
template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::SetMovingObject ( const ObjectType _arg)
virtual
template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::SetParameters ( ParametersType params)
pure virtual
template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::UpdateTransformParameters ( const DerivativeType derivative,
ParametersValueType  factor = NumericTraitsParametersValueType >::OneValue() 
)
pure virtual

Member Data Documentation

template<typename TInternalComputationValueType = double>
ObjectConstPointer itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::m_FixedObject
protected

Fixed and Moving Objects

Definition at line 198 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
GradientSourceType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::m_GradientSource
protected

Definition at line 201 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
ObjectConstPointer itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::m_MovingObject
protected

Definition at line 199 of file itkObjectToObjectMetricBase.h.

template<typename TInternalComputationValueType = double>
MeasureType itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >::m_Value
mutableprotected

Metric value, stored after evaluating

Definition at line 204 of file itkObjectToObjectMetricBase.h.


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