go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::CombinationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkCombinationImageToImageMetric.h>

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >

Combines multiple metrics.

This metric is meant to be used in the MultiMetricMultiResolutionImageRegistrationMethod.

NB: while it may seem not logical that the SetInterpolator(arg) sets the interpolator in all submetrics whereas the GetInterpolator(void) returns GetInterpolator(0) it is logical. If you set the interpolator the same in all metrics, you will receive the correct interpolator with GetInterpolator(0). If you set the interpolator differently in all metrics, the most logical action is to return GetInterpolator(0) when GetInterpolator() is invoked.

Note: If you use Set{Transform,Interpolator etc}(0) or Set{Transform,Interpolator}(), the member variables of the superclass m_{Transform,Interpolator} are set as well. So, it is not strictly necessary to reimplement the functions Get{Transform,Interpolator}(), which return Get{Transform,Interpolator}(0), which would result in the same as returning m_{Transform,Interpolator} anyway. However, if Metric[0] is changed externally the m_{Transform, Interpolator} are not up to date anymore. That's why we chose to reimplement the Get{Transform,Interpolator}() methods.

Definition at line 59 of file itkCombinationImageToImageMetric.h.

+ Inheritance diagram for itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >:

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CoordinateRepresentationType CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::DerivativeValueType DerivativeValueType
 
typedef Superclass::FixedImageConstPointer FixedImageConstPointer
 
typedef Superclass::FixedImageMaskPointer FixedImageMaskPointer
 
typedef Superclass::FixedImageMaskType FixedImageMaskType
 
typedef FixedImageType::PixelType FixedImagePixelType
 
typedef Superclass::FixedImageRegionType FixedImageRegionType
 
typedef Superclass::FixedImageType FixedImageType
 
typedef PointSet< CoordinateRepresentationType, TFixedImage::ImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, TFixedImage::ImageDimension, TFixedImage::ImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > > FixedPointSetType
 
typedef Superclass::GradientImageFilterPointer GradientImageFilterPointer
 
typedef Superclass::GradientImageFilterType GradientImageFilterType
 
typedef Superclass::GradientImagePointer GradientImagePointer
 
typedef Superclass::GradientImageType GradientImageType
 
typedef Superclass::GradientPixelType GradientPixelType
 
typedef Superclass::HessianType HessianType
 
typedef Superclass::HessianValueType HessianValueType
 
typedef ImageMetricType::Pointer ImageMetricPointer
 
typedef Superclass ImageMetricType
 
typedef Superclass::InputPointType InputPointType
 
typedef Superclass::InterpolatorPointer InterpolatorPointer
 
typedef Superclass::InterpolatorType InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::MovingImageConstPointer MovingImageConstPointer
 
typedef FixedArray< double, itkGetStaticConstMacro(MovingImageDimension) > MovingImageDerivativeScalesType
 
typedef Superclass::MovingImageMaskPointer MovingImageMaskPointer
 
typedef Superclass::MovingImageMaskType MovingImageMaskType
 
typedef Superclass::MovingImagePixelType MovingImagePixelType
 
typedef MovingImageType::RegionType MovingImageRegionType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef PointSet< CoordinateRepresentationType, TMovingImage::ImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, TMovingImage::ImageDimension, TMovingImage::ImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > > MovingPointSetType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef SingleValuedPointSetToPointSetMetric< FixedPointSetType, MovingPointSetTypePointSetMetricType
 
typedef Superclass::RealType RealType
 
typedef CombinationImageToImageMetric Self
 
typedef SingleValuedCostFunctionType::Pointer SingleValuedCostFunctionPointer
 
typedef SingleValuedCostFunction SingleValuedCostFunctionType
 
typedef AdvancedImageToImageMetric< TFixedImage, TMovingImage > Superclass
 
typedef Superclass::ThreaderType ThreaderType
 
typedef Superclass::ThreadInfoType ThreadInfoType
 
typedef Superclass::TransformJacobianType TransformJacobianType
 
typedef Superclass::TransformParametersType TransformParametersType
 
typedef TransformType::Pointer TransformPointer
 
typedef Superclass::AdvancedTransformType TransformType
 
- Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
typedef AdvancedTransform< ScalarType, FixedImageDimension, MovingImageDimension > AdvancedTransformType
 
typedef BSplineOrder1TransformType::Pointer BSplineOrder1TransformPointer
 
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 1 > BSplineOrder1TransformType
 
typedef BSplineOrder2TransformType::Pointer BSplineOrder2TransformPointer
 
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 2 > BSplineOrder2TransformType
 
typedef BSplineOrder3TransformType::Pointer BSplineOrder3TransformPointer
 
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 3 > BSplineOrder3TransformType
 
typedef AdvancedCombinationTransform< ScalarType, FixedImageDimension > CombinationTransformType
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CoordinateRepresentationType CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef DerivativeType::ValueType DerivativeValueType
 
typedef Superclass::FixedImageConstPointer FixedImageConstPointer
 
typedef FixedImageLimiterType::OutputType FixedImageLimiterOutputType
 
typedef FixedImageLimiterType::Pointer FixedImageLimiterPointer
 
typedef LimiterFunctionBase< RealType, FixedImageDimension > FixedImageLimiterType
 
typedef Superclass::FixedImageMaskPointer FixedImageMaskPointer
 
typedef ImageMaskSpatialObject< itkGetStaticConstMacro(FixedImageDimension) > FixedImageMaskSpatialObject2Type
 
typedef Superclass::FixedImageMaskType FixedImageMaskType
 
typedef FixedImageType::PixelType FixedImagePixelType
 
typedef FixedImageType::Pointer FixedImagePointer
 
typedef Superclass::FixedImageRegionType FixedImageRegionType
 
typedef Superclass::FixedImageType FixedImageType
 
typedef Superclass::GradientImageFilterPointer GradientImageFilterPointer
 
typedef Superclass::GradientImageFilterType GradientImageFilterType
 
typedef Superclass::GradientImagePointer GradientImagePointer
 
typedef Superclass::GradientImageType GradientImageType
 
typedef Superclass::GradientPixelType GradientPixelType
 
typedef vnl_sparse_matrix< HessianValueTypeHessianType
 
typedef DerivativeType::ValueType HessianValueType
 
typedef ImageSamplerType::OutputVectorContainerPointer ImageSampleContainerPointer
 
typedef ImageSamplerType::OutputVectorContainerType ImageSampleContainerType
 
typedef ImageSamplerType::Pointer ImageSamplerPointer
 
typedef ImageSamplerBase< FixedImageTypeImageSamplerType
 
typedef Superclass::InputPointType InputPointType
 
typedef Superclass::InterpolatorPointer InterpolatorPointer
 
typedef Superclass::InterpolatorType InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::MovingImageConstPointer MovingImageConstPointer
 
typedef FixedArray< double, Self::MovingImageDimension > MovingImageDerivativeScalesType
 
typedef MovingImageLimiterType::OutputType MovingImageLimiterOutputType
 
typedef MovingImageLimiterType::Pointer MovingImageLimiterPointer
 
typedef LimiterFunctionBase< RealType, MovingImageDimension > MovingImageLimiterType
 
typedef Superclass::MovingImageMaskPointer MovingImageMaskPointer
 
typedef ImageMaskSpatialObject< itkGetStaticConstMacro(MovingImageDimension) > MovingImageMaskSpatialObject2Type
 
typedef Superclass::MovingImageMaskType MovingImageMaskType
 
typedef Superclass::MovingImagePixelType MovingImagePixelType
 
typedef MovingImageType::Pointer MovingImagePointer
 
typedef MovingImageType::RegionType MovingImageRegionType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef AdvancedTransformType::NumberOfParametersType NumberOfParametersType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef TransformType::ScalarType ScalarType
 
typedef AdvancedImageToImageMetric Self
 
typedef ImageToImageMetric< TFixedImage, TMovingImage > Superclass
 
typedef itk::PlatformMultiThreader ThreaderType
 
typedef ThreaderType::WorkUnitInfo ThreadInfoType
 
typedef Superclass::TransformJacobianType TransformJacobianType
 
typedef Superclass::TransformParametersType TransformParametersType
 
typedef Superclass::TransformPointer TransformPointer
 
typedef Superclass::TransformType TransformType
 

Public Member Functions

virtual const char * GetClassName () const
 
void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
 
virtual const FixedImageTypeGetFixedImage (unsigned int pos) const
 
const FixedImageTypeGetFixedImage (void) const override
 
virtual const FixedImageMaskTypeGetFixedImageMask (unsigned int pos) const
 
const FixedImageMaskTypeGetFixedImageMask (void) const override
 
virtual const FixedImageRegionTypeGetFixedImageRegion (unsigned int pos) const
 
const FixedImageRegionTypeGetFixedImageRegion (void) const override
 
virtual const InterpolatorTypeGetInterpolator (unsigned int pos) const
 
const InterpolatorTypeGetInterpolator (void) const override
 
SingleValuedCostFunctionTypeGetMetric (unsigned int count) const
 
double GetMetricComputationTime (unsigned int pos) const
 
const DerivativeTypeGetMetricDerivative (unsigned int pos) const
 
double GetMetricDerivativeMagnitude (unsigned int pos) const
 
double GetMetricRelativeWeight (unsigned int pos) const
 
MeasureType GetMetricValue (unsigned int pos) const
 
double GetMetricWeight (unsigned int pos) const
 
virtual const MovingImageTypeGetMovingImage (unsigned int pos) const
 
const MovingImageTypeGetMovingImage (void) const override
 
virtual const MovingImageMaskTypeGetMovingImageMask (unsigned int pos) const
 
const MovingImageMaskTypeGetMovingImageMask (void) const override
 
ModifiedTimeType GetMTime () const override
 
virtual unsigned int GetNumberOfMetrics () const
 
const SizeValueType & GetNumberOfPixelsCounted (void) const override
 
void GetSelfHessian (const TransformParametersType &parameters, HessianType &H) const override
 
virtual const TransformTypeGetTransform (unsigned int pos) const
 
const TransformTypeGetTransform (void) const override
 
bool GetUseMetric (const unsigned int pos) const
 
virtual bool GetUseRelativeWeights ()
 
MeasureType GetValue (const ParametersType &parameters) const override
 
void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override
 
void Initialize (void) override
 
 itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
 
 itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
 
void SetFixedImage (const FixedImageType *_arg) override
 
virtual void SetFixedImage (const FixedImageType *_arg, unsigned int pos)
 
void SetFixedImageMask (FixedImageMaskType *_arg) override
 
virtual void SetFixedImageMask (FixedImageMaskType *_arg, unsigned int pos)
 
void SetFixedImageRegion (const FixedImageRegionType _arg) override
 
virtual void SetFixedImageRegion (const FixedImageRegionType _arg, unsigned int pos)
 
void SetInterpolator (InterpolatorType *_arg) override
 
virtual void SetInterpolator (InterpolatorType *_arg, unsigned int pos)
 
void SetMetric (SingleValuedCostFunctionType *metric, unsigned int pos)
 
void SetMetricRelativeWeight (double weight, unsigned int pos)
 
void SetMetricWeight (double weight, unsigned int pos)
 
void SetMovingImage (const MovingImageType *_arg) override
 
virtual void SetMovingImage (const MovingImageType *_arg, unsigned int pos)
 
void SetMovingImageMask (MovingImageMaskType *_arg) override
 
virtual void SetMovingImageMask (MovingImageMaskType *_arg, unsigned int pos)
 
void SetNumberOfMetrics (unsigned int count)
 
void SetTransform (TransformType *_arg) override
 
virtual void SetTransform (TransformType *_arg, unsigned int pos)
 
void SetUseAllMetrics (void)
 
void SetUseMetric (const bool use, const unsigned int pos)
 
virtual void SetUseRelativeWeights (bool _arg)
 
- Public Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
virtual void BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) const
 
virtual const char * GetClassName () const
 
virtual const FixedImageLimiterTypeGetFixedImageLimiter ()
 
virtual double GetFixedLimitRangeRatio () const
 
virtual ImageSamplerTypeGetImageSampler (void) const
 
virtual const MovingImageDerivativeScalesTypeGetMovingImageDerivativeScales ()
 
virtual const MovingImageLimiterTypeGetMovingImageLimiter ()
 
virtual double GetMovingLimitRangeRatio () const
 
virtual double GetRequiredRatioOfValidSamples () const
 
virtual bool GetScaleGradientWithRespectToMovingImageOrientation () const
 
virtual void GetSelfHessian (const TransformParametersType &parameters, HessianType &H) const
 
const AdvancedTransformTypeGetTransform (void) const override
 
virtual bool GetUseFixedImageLimiter () const
 
virtual bool GetUseImageSampler () const
 
virtual const boolGetUseMetricSingleThreaded ()
 
virtual bool GetUseMovingImageDerivativeScales () const
 
virtual bool GetUseMovingImageLimiter () const
 
virtual const boolGetUseMultiThread ()
 
void Initialize (void) override
 
 itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
 
 itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
 
virtual void SetFixedImageLimiter (FixedImageLimiterType *_arg)
 
virtual void SetFixedLimitRangeRatio (double _arg)
 
virtual void SetImageSampler (ImageSamplerType *_arg)
 
virtual void SetMovingImageDerivativeScales (MovingImageDerivativeScalesType _arg)
 
virtual void SetMovingImageLimiter (MovingImageLimiterType *_arg)
 
virtual void SetMovingLimitRangeRatio (double _arg)
 
virtual void SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
 
virtual void SetRequiredRatioOfValidSamples (double _arg)
 
virtual void SetScaleGradientWithRespectToMovingImageOrientation (bool _arg)
 
virtual void SetTransform (AdvancedTransformType *arg)
 
virtual void SetUseMetricSingleThreaded (bool _arg)
 
virtual void SetUseMovingImageDerivativeScales (bool _arg)
 
virtual void SetUseMultiThread (bool _arg)
 
virtual void UseMetricSingleThreadedOff ()
 
virtual void UseMetricSingleThreadedOn ()
 
virtual void UseMultiThreadOff ()
 
virtual void UseMultiThreadOn ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 CombinationImageToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~CombinationImageToImageMetric () override
 
- Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
 AdvancedImageToImageMetric ()
 
virtual void AfterThreadedGetValue (MeasureType &value) const
 
virtual void AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const
 
virtual void CheckForAdvancedTransform (void)
 
virtual void CheckForBSplineInterpolator (void)
 
virtual void CheckForBSplineTransform (void) const
 
virtual void CheckNumberOfSamples (unsigned long wanted, unsigned long found) const
 
virtual bool EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) const
 
virtual bool EvaluateTransformJacobian (const FixedImagePointType &fixedImagePoint, TransformJacobianType &jacobian, NonZeroJacobianIndicesType &nzji) const
 
virtual void EvaluateTransformJacobianInnerProduct (const TransformJacobianType &jacobian, const MovingImageDerivativeType &movingImageDerivative, DerivativeType &imageJacobian) const
 
virtual void InitializeImageSampler (void)
 
virtual void InitializeLimiters (void)
 
virtual void InitializeThreadingParameters (void) const
 
virtual bool IsInsideMovingMask (const MovingImagePointType &point) const
 
 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct, AlignedGetValueAndDerivativePerThreadStruct)
 
 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValuePerThreadStruct, AlignedGetValuePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct, PaddedGetValueAndDerivativePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValuePerThreadStruct, PaddedGetValuePerThreadStruct)
 
void LaunchGetValueAndDerivativeThreaderCallback (void) const
 
void LaunchGetValueThreaderCallback (void) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetUseFixedImageLimiter (bool _arg)
 
virtual void SetUseImageSampler (bool _arg)
 
virtual void SetUseMovingImageLimiter (bool _arg)
 
virtual void ThreadedGetValue (ThreadIdType threadID)
 
virtual void ThreadedGetValueAndDerivative (ThreadIdType threadID)
 
virtual bool TransformPoint (const FixedImagePointType &fixedImagePoint, MovingImagePointType &mappedPoint) const
 
 ~AdvancedImageToImageMetric () override
 

Protected Attributes

std::vector< doublem_MetricComputationTime
 
std::vector< DerivativeTypem_MetricDerivatives
 
std::vector< doublem_MetricDerivativesMagnitude
 
std::vector< doublem_MetricRelativeWeights
 
std::vector< SingleValuedCostFunctionPointerm_Metrics
 
std::vector< MeasureTypem_MetricValues
 
std::vector< doublem_MetricWeights
 
DerivativeType m_NullDerivative
 
FixedImageRegionType m_NullFixedImageRegion
 
unsigned int m_NumberOfMetrics
 
std::vector< boolm_UseMetric
 
bool m_UseRelativeWeights
 
- Protected Attributes inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
AdvancedTransformType::Pointer m_AdvancedTransform
 
BSplineInterpolatorPointer m_BSplineInterpolator
 
BSplineInterpolatorFloatPointer m_BSplineInterpolatorFloat
 
CentralDifferenceGradientFilterPointer m_CentralDifferenceGradientFilter
 
FixedImageLimiterPointer m_FixedImageLimiter
 
FixedImageLimiterOutputType m_FixedImageMaxLimit
 
FixedImageLimiterOutputType m_FixedImageMinLimit
 
FixedImagePixelType m_FixedImageTrueMax
 
FixedImagePixelType m_FixedImageTrueMin
 
double m_FixedLimitRangeRatio
 
AlignedGetValueAndDerivativePerThreadStruct * m_GetValueAndDerivativePerThreadVariables
 
ThreadIdType m_GetValueAndDerivativePerThreadVariablesSize
 
AlignedGetValuePerThreadStruct * m_GetValuePerThreadVariables
 
ThreadIdType m_GetValuePerThreadVariablesSize
 
ImageSamplerPointer m_ImageSampler
 
bool m_InterpolatorIsBSpline
 
bool m_InterpolatorIsBSplineFloat
 
bool m_InterpolatorIsLinear
 
bool m_InterpolatorIsReducedBSpline
 
LinearInterpolatorPointer m_LinearInterpolator
 
MovingImageLimiterPointer m_MovingImageLimiter
 
MovingImageLimiterOutputType m_MovingImageMaxLimit
 
MovingImageLimiterOutputType m_MovingImageMinLimit
 
MovingImagePixelType m_MovingImageTrueMax
 
MovingImagePixelType m_MovingImageTrueMin
 
double m_MovingLimitRangeRatio
 
ReducedBSplineInterpolatorPointer m_ReducedBSplineInterpolator
 
MultiThreaderParameterType m_ThreaderMetricParameters
 
bool m_TransformIsAdvanced
 
bool m_TransformIsBSpline
 
bool m_UseMetricSingleThreaded
 
bool m_UseMultiThread
 
bool m_UseOpenMP
 

Private Member Functions

 CombinationImageToImageMetric (const Self &)
 
double GetFinalMetricWeight (unsigned int pos) const
 
void InitializeThreadingParameters (void) const override
 
void operator= (const Self &)
 

Additional Inherited Members

- Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
typedef BSplineInterpolatorFloatType::Pointer BSplineInterpolatorFloatPointer
 
typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, floatBSplineInterpolatorFloatType
 
typedef BSplineInterpolatorType::Pointer BSplineInterpolatorPointer
 
typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, doubleBSplineInterpolatorType
 
typedef CentralDifferenceGradientFilterType::Pointer CentralDifferenceGradientFilterPointer
 
typedef GradientImageFilter< MovingImageType, RealType, RealTypeCentralDifferenceGradientFilterType
 
typedef FixedImageType::IndexType FixedImageIndexType
 
typedef FixedImageIndexType::IndexValueType FixedImageIndexValueType
 
typedef TransformType::InputPointType FixedImagePointType
 
typedef LinearInterpolatorType::Pointer LinearInterpolatorPointer
 
typedef AdvancedLinearInterpolateImageFunction< MovingImageType, CoordinateRepresentationTypeLinearInterpolatorType
 
typedef InterpolatorType::ContinuousIndexType MovingImageContinuousIndexType
 
typedef BSplineInterpolatorType::CovariantVectorType MovingImageDerivativeType
 
typedef MovingImageType::IndexType MovingImageIndexType
 
typedef TransformType::OutputPointType MovingImagePointType
 
typedef AdvancedTransformType::NonZeroJacobianIndicesType NonZeroJacobianIndicesType
 
typedef ReducedBSplineInterpolatorType::Pointer ReducedBSplineInterpolatorPointer
 
typedef ReducedDimensionBSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, doubleReducedBSplineInterpolatorType
 
- Static Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION AccumulateDerivativesThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueThreaderCallback (void *arg)
 

Member Typedef Documentation

◆ ConstPointer

template<class TFixedImage , class TMovingImage >
typedef SmartPointer< const Self > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Definition at line 69 of file itkCombinationImageToImageMetric.h.

◆ CoordinateRepresentationType

template<class TFixedImage , class TMovingImage >
typedef Superclass::CoordinateRepresentationType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType

Typedefs from the superclass.

Definition at line 84 of file itkCombinationImageToImageMetric.h.

◆ DerivativeType

template<class TFixedImage , class TMovingImage >
typedef Superclass::DerivativeType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Definition at line 112 of file itkCombinationImageToImageMetric.h.

◆ DerivativeValueType

template<class TFixedImage , class TMovingImage >
typedef Superclass::DerivativeValueType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeValueType

Definition at line 113 of file itkCombinationImageToImageMetric.h.

◆ FixedImageConstPointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::FixedImageConstPointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 91 of file itkCombinationImageToImageMetric.h.

◆ FixedImageMaskPointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::FixedImageMaskPointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskPointer

Definition at line 108 of file itkCombinationImageToImageMetric.h.

◆ FixedImageMaskType

template<class TFixedImage , class TMovingImage >
typedef Superclass::FixedImageMaskType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskType

Definition at line 107 of file itkCombinationImageToImageMetric.h.

◆ FixedImagePixelType

template<class TFixedImage , class TMovingImage >
typedef FixedImageType::PixelType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType

Definition at line 139 of file itkCombinationImageToImageMetric.h.

◆ FixedImageRegionType

template<class TFixedImage , class TMovingImage >
typedef Superclass::FixedImageRegionType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageRegionType

Definition at line 92 of file itkCombinationImageToImageMetric.h.

◆ FixedImageType

template<class TFixedImage , class TMovingImage >
typedef Superclass::FixedImageType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Definition at line 89 of file itkCombinationImageToImageMetric.h.

◆ FixedPointSetType

template<class TFixedImage , class TMovingImage >
typedef PointSet< CoordinateRepresentationType, TFixedImage::ImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, TFixedImage::ImageDimension, TFixedImage::ImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::FixedPointSetType

Typedef for the PointSetMetric.

Definition at line 152 of file itkCombinationImageToImageMetric.h.

◆ GradientImageFilterPointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::GradientImageFilterPointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterPointer

Definition at line 106 of file itkCombinationImageToImageMetric.h.

◆ GradientImageFilterType

template<class TFixedImage , class TMovingImage >
typedef Superclass::GradientImageFilterType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterType

Definition at line 105 of file itkCombinationImageToImageMetric.h.

◆ GradientImagePointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::GradientImagePointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GradientImagePointer

Definition at line 104 of file itkCombinationImageToImageMetric.h.

◆ GradientImageType

template<class TFixedImage , class TMovingImage >
typedef Superclass::GradientImageType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GradientImageType

Definition at line 103 of file itkCombinationImageToImageMetric.h.

◆ GradientPixelType

template<class TFixedImage , class TMovingImage >
typedef Superclass::GradientPixelType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType

Definition at line 102 of file itkCombinationImageToImageMetric.h.

◆ HessianType

template<class TFixedImage , class TMovingImage >
typedef Superclass::HessianType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::HessianType

Definition at line 118 of file itkCombinationImageToImageMetric.h.

◆ HessianValueType

template<class TFixedImage , class TMovingImage >
typedef Superclass::HessianValueType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::HessianValueType

Some typedefs for computing the SelfHessian

Definition at line 117 of file itkCombinationImageToImageMetric.h.

◆ ImageMetricPointer

template<class TFixedImage , class TMovingImage >
typedef ImageMetricType::Pointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::ImageMetricPointer

Definition at line 135 of file itkCombinationImageToImageMetric.h.

◆ ImageMetricType

template<class TFixedImage , class TMovingImage >
typedef Superclass itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::ImageMetricType

typedef typename Superclass::ImageSamplerType ImageSamplerType; typedef typename Superclass::ImageSamplerPointer ImageSamplerPointer; typedef typename Superclass::ImageSampleContainerType ImageSampleContainerType; typedef typename Superclass::ImageSampleContainerPointer ImageSampleContainerPointer; typedef typename Superclass::FixedImageLimiterType FixedImageLimiterType; typedef typename Superclass::FixedImageLimiterOutputType FixedImageLimiterOutputType; typedef typename Superclass::MovingImageLimiterType MovingImageLimiterType; typedef typename Superclass::MovingImageLimiterOutputType MovingImageLimiterOutputType; typedef typename Superclass::ScalarType ScalarType; typedef typename Superclass::AdvancedTransformType AdvancedTransformType; Typedefs for the metrics.

Definition at line 134 of file itkCombinationImageToImageMetric.h.

◆ InputPointType

template<class TFixedImage , class TMovingImage >
typedef Superclass::InputPointType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::InputPointType

Definition at line 95 of file itkCombinationImageToImageMetric.h.

◆ InterpolatorPointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::InterpolatorPointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorPointer

Definition at line 100 of file itkCombinationImageToImageMetric.h.

◆ InterpolatorType

template<class TFixedImage , class TMovingImage >
typedef Superclass::InterpolatorType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Definition at line 99 of file itkCombinationImageToImageMetric.h.

◆ MeasureType

template<class TFixedImage , class TMovingImage >
typedef Superclass::MeasureType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Definition at line 111 of file itkCombinationImageToImageMetric.h.

◆ MovingImageConstPointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::MovingImageConstPointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 88 of file itkCombinationImageToImageMetric.h.

◆ MovingImageDerivativeScalesType

template<class TFixedImage , class TMovingImage >
typedef FixedArray< double, itkGetStaticConstMacro( MovingImageDimension ) > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeScalesType

Definition at line 142 of file itkCombinationImageToImageMetric.h.

◆ MovingImageMaskPointer

template<class TFixedImage , class TMovingImage >
typedef Superclass::MovingImageMaskPointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskPointer

Definition at line 110 of file itkCombinationImageToImageMetric.h.

◆ MovingImageMaskType

template<class TFixedImage , class TMovingImage >
typedef Superclass::MovingImageMaskType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskType

Definition at line 109 of file itkCombinationImageToImageMetric.h.

◆ MovingImagePixelType

template<class TFixedImage , class TMovingImage >
typedef Superclass::MovingImagePixelType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType

Definition at line 86 of file itkCombinationImageToImageMetric.h.

◆ MovingImageRegionType

template<class TFixedImage , class TMovingImage >
typedef MovingImageType::RegionType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageRegionType

Definition at line 140 of file itkCombinationImageToImageMetric.h.

◆ MovingImageType

template<class TFixedImage , class TMovingImage >
typedef Superclass::MovingImageType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Definition at line 85 of file itkCombinationImageToImageMetric.h.

◆ MovingPointSetType

template<class TFixedImage , class TMovingImage >
typedef PointSet< CoordinateRepresentationType, TMovingImage::ImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, TMovingImage::ImageDimension, TMovingImage::ImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::MovingPointSetType

Definition at line 160 of file itkCombinationImageToImageMetric.h.

◆ OutputPointType

template<class TFixedImage , class TMovingImage >
typedef Superclass::OutputPointType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType

Definition at line 96 of file itkCombinationImageToImageMetric.h.

◆ ParametersType

template<class TFixedImage , class TMovingImage >
typedef Superclass::ParametersType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::ParametersType

Definition at line 114 of file itkCombinationImageToImageMetric.h.

◆ Pointer

template<class TFixedImage , class TMovingImage >
typedef SmartPointer< Self > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Definition at line 68 of file itkCombinationImageToImageMetric.h.

◆ PointSetMetricType

template<class TFixedImage , class TMovingImage >
typedef SingleValuedPointSetToPointSetMetric< FixedPointSetType, MovingPointSetType > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::PointSetMetricType

Definition at line 162 of file itkCombinationImageToImageMetric.h.

◆ RealType

template<class TFixedImage , class TMovingImage >
typedef Superclass::RealType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::RealType

Definition at line 101 of file itkCombinationImageToImageMetric.h.

◆ Self

template<class TFixedImage , class TMovingImage >
typedef CombinationImageToImageMetric itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Definition at line 65 of file itkCombinationImageToImageMetric.h.

◆ SingleValuedCostFunctionPointer

template<class TFixedImage , class TMovingImage >
typedef SingleValuedCostFunctionType::Pointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SingleValuedCostFunctionPointer

Definition at line 137 of file itkCombinationImageToImageMetric.h.

◆ SingleValuedCostFunctionType

template<class TFixedImage , class TMovingImage >
typedef SingleValuedCostFunction itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SingleValuedCostFunctionType

Definition at line 136 of file itkCombinationImageToImageMetric.h.

◆ Superclass

template<class TFixedImage , class TMovingImage >
typedef AdvancedImageToImageMetric< TFixedImage, TMovingImage > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Definition at line 67 of file itkCombinationImageToImageMetric.h.

◆ ThreaderType

template<class TFixedImage , class TMovingImage >
typedef Superclass::ThreaderType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::ThreaderType

Typedefs for multi-threading.

Definition at line 165 of file itkCombinationImageToImageMetric.h.

◆ ThreadInfoType

template<class TFixedImage , class TMovingImage >
typedef Superclass::ThreadInfoType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::ThreadInfoType

Definition at line 166 of file itkCombinationImageToImageMetric.h.

◆ TransformJacobianType

template<class TFixedImage , class TMovingImage >
typedef Superclass::TransformJacobianType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 98 of file itkCombinationImageToImageMetric.h.

◆ TransformParametersType

template<class TFixedImage , class TMovingImage >
typedef Superclass::TransformParametersType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Definition at line 97 of file itkCombinationImageToImageMetric.h.

◆ TransformPointer

template<class TFixedImage , class TMovingImage >
typedef TransformType::Pointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 94 of file itkCombinationImageToImageMetric.h.

◆ TransformType

template<class TFixedImage , class TMovingImage >
typedef Superclass::AdvancedTransformType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Definition at line 93 of file itkCombinationImageToImageMetric.h.

Constructor & Destructor Documentation

◆ CombinationImageToImageMetric() [1/2]

template<class TFixedImage , class TMovingImage >
itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::CombinationImageToImageMetric ( )
protected

◆ ~CombinationImageToImageMetric()

template<class TFixedImage , class TMovingImage >
itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::~CombinationImageToImageMetric ( )
inlineoverrideprotected

Definition at line 406 of file itkCombinationImageToImageMetric.h.

◆ CombinationImageToImageMetric() [2/2]

template<class TFixedImage , class TMovingImage >
itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::CombinationImageToImageMetric ( const Self )
private

Member Function Documentation

◆ GetClassName()

template<class TFixedImage , class TMovingImage >
virtual const char * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetDerivative()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const ParametersType parameters,
DerivativeType derivative 
) const
override

The GetDerivative()-method.

◆ GetFinalMetricWeight()

template<class TFixedImage , class TMovingImage >
double itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFinalMetricWeight ( unsigned int  pos) const
private

Compute the current metric weight, given the user selected strategy and derivative magnitude.

◆ GetFixedImage() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const FixedImageType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImage ( unsigned int  pos) const
virtual

Returns the fixedImage set in a specific metric. If the submetric is a singlevalued costfunction a zero pointer will be returned

◆ GetFixedImage() [2/2]

template<class TFixedImage , class TMovingImage >
const FixedImageType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImage ( void  ) const
inlineoverride

Return FixedImage 0

Definition at line 289 of file itkCombinationImageToImageMetric.h.

◆ GetFixedImageMask() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const FixedImageMaskType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageMask ( unsigned int  pos) const
virtual

Returns the fixedImageMask set in a specific metric. If the submetric is a singlevalued costfunction a zero pointer will be returned

◆ GetFixedImageMask() [2/2]

template<class TFixedImage , class TMovingImage >
const FixedImageMaskType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageMask ( void  ) const
inlineoverride

Return FixedImageMask 0

Definition at line 307 of file itkCombinationImageToImageMetric.h.

◆ GetFixedImageRegion() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const FixedImageRegionType & itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageRegion ( unsigned int  pos) const
virtual

Returns the fixedImageRegion set in a specific metric. If the submetric is a singlevalued costfunction a region with size zero will be returned

◆ GetFixedImageRegion() [2/2]

template<class TFixedImage , class TMovingImage >
const FixedImageRegionType & itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetFixedImageRegion ( void  ) const
inlineoverride

Return FixedImageRegion 0

Definition at line 325 of file itkCombinationImageToImageMetric.h.

◆ GetInterpolator() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const InterpolatorType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetInterpolator ( unsigned int  pos) const
virtual

Returns the interpolator set in a specific metric. If the submetric is a singlevalued costfunction a zero pointer will be returned.

◆ GetInterpolator() [2/2]

template<class TFixedImage , class TMovingImage >
const InterpolatorType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetInterpolator ( void  ) const
inlineoverride

Return Interpolator 0

Definition at line 271 of file itkCombinationImageToImageMetric.h.

◆ GetMetric()

template<class TFixedImage , class TMovingImage >
SingleValuedCostFunctionType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetric ( unsigned int  count) const

Get metric i.

◆ GetMetricComputationTime()

template<class TFixedImage , class TMovingImage >
double itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetricComputationTime ( unsigned int  pos) const

Get the last computed computation time for metric i.

◆ GetMetricDerivative()

template<class TFixedImage , class TMovingImage >
const DerivativeType & itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetricDerivative ( unsigned int  pos) const

Get the last computed derivative for metric i.

◆ GetMetricDerivativeMagnitude()

template<class TFixedImage , class TMovingImage >
double itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetricDerivativeMagnitude ( unsigned int  pos) const

Get the last computed derivative magnitude for metric i.

◆ GetMetricRelativeWeight()

template<class TFixedImage , class TMovingImage >
double itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetricRelativeWeight ( unsigned int  pos) const

Get the relative weight for metric i.

◆ GetMetricValue()

template<class TFixedImage , class TMovingImage >
MeasureType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetricValue ( unsigned int  pos) const

Get the last computed value for metric i.

◆ GetMetricWeight()

template<class TFixedImage , class TMovingImage >
double itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMetricWeight ( unsigned int  pos) const

Get the weight for metric i.

◆ GetMovingImage() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const MovingImageType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImage ( unsigned int  pos) const
virtual

Returns the movingImage set in a specific metric. If the submetric is a singlevalued costfunction a zero pointer will be returned

◆ GetMovingImage() [2/2]

template<class TFixedImage , class TMovingImage >
const MovingImageType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImage ( void  ) const
inlineoverride

Return MovingImage 0

Definition at line 343 of file itkCombinationImageToImageMetric.h.

◆ GetMovingImageMask() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const MovingImageMaskType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageMask ( unsigned int  pos) const
virtual

Returns the movingImageMask set in a specific metric. If the submetric is a singlevalued costfunction a zero pointer will be returned

◆ GetMovingImageMask() [2/2]

template<class TFixedImage , class TMovingImage >
const MovingImageMaskType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMovingImageMask ( void  ) const
inlineoverride

Return MovingImageMask 0

Definition at line 361 of file itkCombinationImageToImageMetric.h.

◆ GetMTime()

template<class TFixedImage , class TMovingImage >
ModifiedTimeType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetMTime ( ) const
override

Method to return the latest modified time of this object or any of its cached ivars.

◆ GetNumberOfMetrics()

template<class TFixedImage , class TMovingImage >
virtual unsigned int itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfMetrics ( ) const
virtual

Get the number of metrics to combine.

◆ GetNumberOfPixelsCounted()

template<class TFixedImage , class TMovingImage >
const SizeValueType & itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetNumberOfPixelsCounted ( void  ) const
override

Get the number of pixels considered in the computation. Return the sum of pixels counted by all metrics.

◆ GetSelfHessian()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetSelfHessian ( const TransformParametersType parameters,
HessianType H 
) const
overridevirtual

Experimental feature: compute SelfHessian.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

◆ GetTransform() [1/2]

template<class TFixedImage , class TMovingImage >
virtual const TransformType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetTransform ( unsigned int  pos) const
virtual

Returns the transform set in a specific metric. If the submetric is a singlevalued costfunction a zero pointer will be returned.

◆ GetTransform() [2/2]

template<class TFixedImage , class TMovingImage >
const TransformType * itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetTransform ( void  ) const
inlineoverride

Return Transform 0

Definition at line 253 of file itkCombinationImageToImageMetric.h.

◆ GetUseMetric()

template<class TFixedImage , class TMovingImage >
bool itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetUseMetric ( const unsigned int  pos) const

Get if this metric is used.

◆ GetUseRelativeWeights()

template<class TFixedImage , class TMovingImage >
virtual bool itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetUseRelativeWeights ( )
virtual

◆ GetValue()

template<class TFixedImage , class TMovingImage >
MeasureType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const ParametersType parameters) const
override

Combine all sub metrics by adding them. The GetValue()-method.

◆ GetValueAndDerivative()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const ParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const
override

◆ Initialize()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( void  )
override

Pass initialization to all sub metrics.

◆ InitializeThreadingParameters()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::InitializeThreadingParameters ( void  ) const
overrideprivatevirtual

Initialize some multi-threading related parameters. Overrides function in AdvancedImageToImageMetric, because here we use other parameters.

Reimplemented from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >.

◆ itkStaticConstMacro() [1/2]

template<class TFixedImage , class TMovingImage >
itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned int  ,
TFixedImage::ImageDimension   
)

◆ itkStaticConstMacro() [2/2]

template<class TFixedImage , class TMovingImage >
itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned int  ,
TMovingImage::ImageDimension   
)

Constants for the image dimensions

◆ New()

template<class TFixedImage , class TMovingImage >
static Pointer itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::New ( )
static

Define the New() method

◆ operator=()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::operator= ( const Self )
private

◆ PrintSelf()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

◆ SetFixedImage() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType _arg)
override

Pass the fixed image to all sub metrics.

◆ SetFixedImage() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType _arg,
unsigned int  pos 
)
virtual

Pass a fixed image to a specific metric

◆ SetFixedImageMask() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask ( FixedImageMaskType _arg)
override

Pass the fixed image mask to all sub metrics.

◆ SetFixedImageMask() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageMask ( FixedImageMaskType _arg,
unsigned int  pos 
)
virtual

Pass a fixed image mask to a specific metric

◆ SetFixedImageRegion() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType  _arg)
override

Pass the fixed image region to all sub metrics.

◆ SetFixedImageRegion() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType  _arg,
unsigned int  pos 
)
virtual

Pass a fixed image region to a specific metric.

◆ SetInterpolator() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType _arg)
override

Pass the interpolator to all sub metrics.

◆ SetInterpolator() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType _arg,
unsigned int  pos 
)
virtual

Pass an interpolator to a specific metric

◆ SetMetric()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMetric ( SingleValuedCostFunctionType metric,
unsigned int  pos 
)

Set metric i. It may be a SingleValuedCostFunction, instead of a ImageToImageMetric, but the first one should be an ImageToImageMetric in all cases.

◆ SetMetricRelativeWeight()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMetricRelativeWeight ( double  weight,
unsigned int  pos 
)

Set the relative weight for metric i.

◆ SetMetricWeight()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMetricWeight ( double  weight,
unsigned int  pos 
)

Set the weight for metric i.

◆ SetMovingImage() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType _arg)
override

Pass the moving image to all sub metrics.

◆ SetMovingImage() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType _arg,
unsigned int  pos 
)
virtual

Pass a moving image to a specific metric

◆ SetMovingImageMask() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageMask ( MovingImageMaskType _arg)
override

Pass the moving image mask to all sub metrics.

◆ SetMovingImageMask() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetMovingImageMask ( MovingImageMaskType _arg,
unsigned int  pos 
)
virtual

Pass a moving image mask to a specific metric

◆ SetNumberOfMetrics()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetNumberOfMetrics ( unsigned int  count)

Get and set the metrics and their weights. Set the number of metrics to combine.

◆ SetTransform() [1/2]

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetTransform ( TransformType _arg)
override

Set/Get functions for the metric components Pass the transform to all sub metrics.

◆ SetTransform() [2/2]

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetTransform ( TransformType _arg,
unsigned int  pos 
)
virtual

Pass a transform to a specific metric. Only use this if you really know what you are doing.

In fact, in general it makes no sense to specify a different transform for every metric, because in the GetValue/GetDerivative methods, the same set of parameters will be used in all cases. Also, SetTransformParameters and GetNumberOfParameters may give unpredictable results if you use this method. They only refer to the first transform.

◆ SetUseAllMetrics()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetUseAllMetrics ( void  )

Use all metrics.

◆ SetUseMetric()

template<class TFixedImage , class TMovingImage >
void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetUseMetric ( const bool  use,
const unsigned int  pos 
)

Select which metrics are used. This is useful in case you want to compute a certain measure, but not actually use it during the registration. By default all metrics that are set, are also used.

◆ SetUseRelativeWeights()

template<class TFixedImage , class TMovingImage >
virtual void itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::SetUseRelativeWeights ( bool  _arg)
virtual

Set and Get the UseRelativeWeights variable.

Field Documentation

◆ m_MetricComputationTime

template<class TFixedImage , class TMovingImage >
std::vector< double > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_MetricComputationTime
mutableprotected

Definition at line 419 of file itkCombinationImageToImageMetric.h.

◆ m_MetricDerivatives

template<class TFixedImage , class TMovingImage >
std::vector< DerivativeType > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_MetricDerivatives
mutableprotected

Definition at line 417 of file itkCombinationImageToImageMetric.h.

◆ m_MetricDerivativesMagnitude

template<class TFixedImage , class TMovingImage >
std::vector< double > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_MetricDerivativesMagnitude
mutableprotected

Definition at line 418 of file itkCombinationImageToImageMetric.h.

◆ m_MetricRelativeWeights

template<class TFixedImage , class TMovingImage >
std::vector< double > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_MetricRelativeWeights
protected

Definition at line 413 of file itkCombinationImageToImageMetric.h.

◆ m_Metrics

template<class TFixedImage , class TMovingImage >
std::vector< SingleValuedCostFunctionPointer > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_Metrics
protected

Definition at line 411 of file itkCombinationImageToImageMetric.h.

◆ m_MetricValues

template<class TFixedImage , class TMovingImage >
std::vector< MeasureType > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_MetricValues
mutableprotected

Definition at line 416 of file itkCombinationImageToImageMetric.h.

◆ m_MetricWeights

template<class TFixedImage , class TMovingImage >
std::vector< double > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_MetricWeights
protected

Definition at line 412 of file itkCombinationImageToImageMetric.h.

◆ m_NullDerivative

template<class TFixedImage , class TMovingImage >
DerivativeType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_NullDerivative
protected

Definition at line 423 of file itkCombinationImageToImageMetric.h.

◆ m_NullFixedImageRegion

template<class TFixedImage , class TMovingImage >
FixedImageRegionType itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_NullFixedImageRegion
protected

Dummy image region and derivatives.

Definition at line 422 of file itkCombinationImageToImageMetric.h.

◆ m_NumberOfMetrics

template<class TFixedImage , class TMovingImage >
unsigned int itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_NumberOfMetrics
protected

Store the metrics and the corresponding weights.

Definition at line 410 of file itkCombinationImageToImageMetric.h.

◆ m_UseMetric

template<class TFixedImage , class TMovingImage >
std::vector< bool > itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_UseMetric
protected

Definition at line 415 of file itkCombinationImageToImageMetric.h.

◆ m_UseRelativeWeights

template<class TFixedImage , class TMovingImage >
bool itk::CombinationImageToImageMetric< TFixedImage, TMovingImage >::m_UseRelativeWeights
protected

Definition at line 414 of file itkCombinationImageToImageMetric.h.



Generated on 1667476801 for elastix by doxygen 1.9.4 elastix logo