ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::HistogramImageToImageMetric< TFixedImage, TMovingImage > Class Template Referenceabstract

#include <itkHistogramImageToImageMetric.h>

+ Inheritance diagram for itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >:
+ Collaboration diagram for itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >:

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >

Computes similarity between two objects to be registered.

This class is templated over the type of the fixed and moving images to be compared.

The metric computes the similarity measure between pixels in the moving image and pixels in the fixed image using a histogram.

Definition at line 39 of file itkHistogramImageToImageMetric.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
Superclass::FixedImageConstPointer 
FixedImageConstPointerType
 
typedef
Superclass::FixedImageType::PixelType 
FixedImagePixelType
 
typedef Superclass::FixedImageType FixedImageType
 
typedef
Superclass::GradientPixelType 
GradientPixelType
 
typedef HistogramType::Pointer HistogramPointer
 
typedef HistogramType::SizeType HistogramSizeType
 
typedef Statistics::Histogram
< double > 
HistogramType
 
typedef Superclass::InputPointType InputPointType
 
typedef
HistogramType::MeasurementVectorType 
MeasurementVectorType
 
typedef Superclass::MeasureType MeasureType
 
typedef
Superclass::MovingImageConstPointer 
MovingImageConstPointerType
 
typedef
Superclass::MovingImageType::PixelType 
MovingImagePixelType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef Array< double > ScalesType
 
typedef HistogramImageToImageMetric Self
 
typedef ImageToImageMetric
< TFixedImage, TMovingImage > 
Superclass
 
typedef
Superclass::TransformJacobianType 
TransformJacobianType
 
typedef
Superclass::TransformParametersType 
TransformParametersType
 
typedef
Superclass::TransformPointer 
TransformPointer
 
typedef Superclass::TransformType TransformType
 
- Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ParametersValueType 
CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
FixedImageType::ConstPointer 
FixedImageConstPointer
 
typedef std::vector
< FixedImageIndexType
FixedImageIndexContainer
 
typedef FixedImageType::IndexType FixedImageIndexType
 
typedef
FixedImageIndexType::IndexValueType 
FixedImageIndexValueType
 
typedef
FixedImageMaskType::ConstPointer 
FixedImageMaskConstPointer
 
typedef FixedImageMaskType::Pointer FixedImageMaskPointer
 
typedef SpatialObject
< itkGetStaticConstMacro(FixedImageDimension) > 
FixedImageMaskType
 
typedef TFixedImage::PixelType FixedImagePixelType
 
typedef
TransformType::InputPointType 
FixedImagePointType
 
typedef FixedImageType::RegionType FixedImageRegionType
 
typedef TFixedImage FixedImageType
 
typedef
TransformType::InputPointType 
InputPointType
 
typedef InterpolatorType::Pointer InterpolatorPointer
 
typedef
InterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType
InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef
MovingImageType::ConstPointer 
MovingImageConstPointer
 
typedef MovingImageType::IndexType MovingImageIndexType
 
typedef
MovingImageMaskType::ConstPointer 
MovingImageMaskConstPointer
 
typedef
MovingImageMaskType::Pointer 
MovingImageMaskPointer
 
typedef SpatialObject
< itkGetStaticConstMacro(MovingImageDimension) > 
MovingImageMaskType
 
typedef TMovingImage::PixelType MovingImagePixelType
 
typedef
TransformType::OutputPointType 
MovingImagePointType
 
typedef TMovingImage MovingImageType
 
typedef MultiThreader MultiThreaderType
 
typedef
TransformType::OutputPointType 
OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageMetric Self
 
typedef SingleValuedCostFunction Superclass
 
typedef TransformType::JacobianType TransformJacobianType
 
typedef
TransformType::ParametersType 
TransformParametersType
 
typedef TransformType::Pointer TransformPointer
 
typedef Transform
< CoordinateRepresentationType,
itkGetStaticConstMacro(MovingImageDimension),
itkGetStaticConstMacro(FixedImageDimension) > 
TransformType
 
typedef NumericTraits
< MovingImagePixelType >
::RealType 
RealType
 
typedef CovariantVector
< RealType,
itkGetStaticConstMacro(MovingImageDimension) > 
GradientPixelType
 
typedef Image
< GradientPixelType,
itkGetStaticConstMacro(MovingImageDimension) > 
GradientImageType
 
typedef SmartPointer
< GradientImageType
GradientImagePointer
 
typedef
GradientRecursiveGaussianImageFilter
< MovingImageType,
GradientImageType
GradientImageFilterType
 
typedef
GradientImageFilterType::Pointer 
GradientImageFilterPointer
 
- Public Types inherited from itk::SingleValuedCostFunction
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< ParametersValueType
DerivativeType
 
typedef double MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef SingleValuedCostFunction Self
 
typedef CostFunction 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

void GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const override
 
virtual double GetDerivativeStepLength () const
 
virtual const ScalesTypeGetDerivativeStepLengthScales () const
 
virtual const HistogramPointerGetHistogram () const
 
virtual const HistogramSizeTypeGetHistogramSize () const
 
const MeasurementVectorTypeGetLowerBound () const
 
virtual const char * GetNameOfClass () const
 
virtual const FixedImagePixelTypeGetPaddingValue () const
 
const MeasurementVectorTypeGetUpperBound () const
 
MeasureType GetValue (const TransformParametersType &parameters) const override
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
 
void Initialize () override
 
virtual void SetDerivativeStepLength (double _arg)
 
virtual void SetDerivativeStepLengthScales (ScalesType _arg)
 
virtual void SetHistogramSize (HistogramSizeType _arg)
 
void SetLowerBound (const MeasurementVectorType &bound)
 
virtual void SetPaddingValue (FixedImagePixelType _arg)
 
void SetTransform (TransformType *transform) override
 
void SetUpperBound (const MeasurementVectorType &bound)
 
virtual void SetUpperBoundIncreaseFactor (double _arg)
 
virtual double GetUpperBoundIncreaseFactor () const
 
virtual void SetUsePaddingValue (bool _arg)
 
virtual bool GetUsePaddingValue () const
 
- Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void ComputeGradient ()
 
virtual const
FixedImageRegionType
GetFixedImageRegion () const
 
virtual const FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold () const
 
virtual const GradientImageTypeGetGradientImage () const
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual TransformTypeGetModifiableTransform ()
 
SizeValueType GetNumberOfMovingImageSamples (void)
 
virtual unsigned int GetNumberOfParameters (void) const override
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
SizeValueType GetNumberOfSpatialSamples (void)
 
virtual const TransformTypeGetTransform () const
 
virtual const bool & GetUseAllPixels () const
 
virtual const bool & GetUseFixedImageIndexes () const
 
virtual const bool & GetUseFixedImageSamplesIntensityThreshold () const
 
virtual const bool & GetUseSequentialSampling () const
 
virtual void MultiThreadingInitialize (void)
 
void SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
 
virtual void SetFixedImageRegion (const FixedImageRegionType reg)
 
void SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
void SetNumberOfSpatialSamples (SizeValueType num)
 
virtual void SetTransform (TransformType *_arg)
 
void SetTransformParameters (const ParametersType &parameters) const
 
void SetUseAllPixels (bool useAllPixels)
 
void SetUseFixedImageIndexes (bool useIndex)
 
void SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
 
void SetUseSequentialSampling (bool sequentialSampling)
 
void UseAllPixelsOff (void)
 
void UseAllPixelsOn (void)
 
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
 
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask () const
 
void SetNumberOfThreads (ThreadIdType numberOfThreads)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void ComputeGradientOff ()
 
virtual void SetNumberOfFixedImageSamples (SizeValueType numSamples)
 
virtual const SizeValueTypeGetNumberOfFixedImageSamples () const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int seed)
 
virtual void SetUseCachingOfBSplineWeights (bool _arg)
 
virtual const bool & GetUseCachingOfBSplineWeights () const
 
virtual void UseCachingOfBSplineWeightsOn ()
 
virtual void UseCachingOfBSplineWeightsOff ()
 
virtual MultiThreaderTypeGetModifiableThreader ()
 
virtual const MultiThreaderTypeGetThreader () const
 
const TransformPointerGetThreaderTransform ()
 
- Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
- 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

void ComputeHistogram (const TransformParametersType &parameters, HistogramType &histogram) const
 
void ComputeHistogram (const TransformParametersType &parameters, unsigned int parameter, double step, HistogramType &histogram) const
 
void CopyHistogram (HistogramType &target, HistogramType &source) const
 
virtual MeasureType EvaluateMeasure (HistogramType &histogram) const =0
 
 HistogramImageToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~HistogramImageToImageMetric () override
 
- Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const
 
void GetValueAndDerivativeMultiThreadedInitiate () const
 
void GetValueAndDerivativeMultiThreadedPostProcessInitiate () const
 
void GetValueAndDerivativeMultiThreadedPreProcessInitiate () const
 
virtual void GetValueAndDerivativeThread (ThreadIdType threadId) const
 
virtual void GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const
 
virtual void GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const
 
virtual bool GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const
 
void GetValueMultiThreadedInitiate () const
 
void GetValueMultiThreadedPostProcessInitiate () const
 
void GetValueMultiThreadedPreProcessInitiate () const
 
virtual void GetValueThread (ThreadIdType threadId) const
 
virtual void GetValueThreadPostProcess (ThreadIdType, bool) const
 
virtual void GetValueThreadPreProcess (ThreadIdType, bool) const
 
virtual bool GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const
 
 ImageToImageMetric ()
 
virtual void PreComputeTransformValues ()
 
virtual void SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
 
virtual void SampleFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void SynchronizeTransforms () const
 
virtual void TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadId) const
 
virtual void TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, ThreadIdType threadId) const
 
virtual ~ImageToImageMetric () override
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()
 
virtual ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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

HistogramSizeType m_HistogramSize
 
MeasurementVectorType m_LowerBound
 
bool m_LowerBoundSetByUser
 
MeasurementVectorType m_UpperBound
 
double m_UpperBoundIncreaseFactor
 
bool m_UpperBoundSetByUser
 
- Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer m_BSplineInterpolator
 
BSplineParametersOffsetType m_BSplineParametersOffset
 
MovingImagePointArrayType m_BSplinePreTransformPointsArray
 
BSplineTransformType::Pointer m_BSplineTransform
 
BSplineTransformIndexArrayType m_BSplineTransformIndices
 
BSplineTransformIndicesArrayType m_BSplineTransformIndicesArray
 
BSplineTransformWeightsType m_BSplineTransformWeights
 
BSplineTransformWeightsArrayType m_BSplineTransformWeightsArray
 
bool m_ComputeGradient
 
DerivativeFunctionType::Pointer m_DerivativeCalculator
 
FixedImageConstPointer m_FixedImage
 
FixedImageIndexContainer m_FixedImageIndexes
 
FixedImageMaskConstPointer m_FixedImageMask
 
FixedImageSampleContainer m_FixedImageSamples
 
FixedImagePixelType m_FixedImageSamplesIntensityThreshold
 
GradientImagePointer m_GradientImage
 
InterpolatorPointer m_Interpolator
 
bool m_InterpolatorIsBSpline
 
MovingImageConstPointer m_MovingImage
 
MovingImageMaskConstPointer m_MovingImageMask
 
SizeValueType m_NumberOfFixedImageSamples
 
SizeValueType m_NumberOfParameters
 
SizeValueType m_NumberOfPixelsCounted
 
ThreadIdType m_NumberOfThreads
 
SizeValueType m_NumBSplineWeights
 
int m_RandomSeed
 
bool m_ReseedIterator
 
MultiThreaderType::Pointer m_Threader
 
BSplineTransformIndexArrayTypem_ThreaderBSplineTransformIndices
 
BSplineTransformWeightsTypem_ThreaderBSplineTransformWeights
 
unsigned int * m_ThreaderNumberOfMovingImageSamples
 
MultiThreaderParameterType m_ThreaderParameter
 
TransformPointerm_ThreaderTransform
 
TransformPointer m_Transform
 
bool m_TransformIsBSpline
 
bool m_UseAllPixels
 
bool m_UseCachingOfBSplineWeights
 
bool m_UseFixedImageIndexes
 
bool m_UseFixedImageSamplesIntensityThreshold
 
bool m_UseSequentialSampling
 
BooleanArrayType m_WithinBSplineSupportRegionArray
 
bool m_WithinThreadPostProcess
 
bool m_WithinThreadPreProcess
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Attributes

double m_DerivativeStepLength
 
ScalesType m_DerivativeStepLengthScales
 
HistogramPointer m_Histogram
 
FixedImagePixelType m_PaddingValue
 
bool m_UsePaddingValue
 

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 ()
 
- Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
static const unsigned int FixedImageDimension = TFixedImage::ImageDimension
 
- Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
typedef std::vector< bool > BooleanArrayType
 
typedef
BSplineInterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType
BSplineInterpolatorType
 
typedef FixedArray
< SizeValueType,
FixedImageType::ImageDimension > 
BSplineParametersOffsetType
 
typedef
BSplineTransformType::ParameterIndexArrayType 
BSplineTransformIndexArrayType
 
typedef Array2D< IndexValueTypeBSplineTransformIndicesArrayType
 
typedef BSplineBaseTransform
< CoordinateRepresentationType,
FixedImageType::ImageDimension,
itkGetStaticConstMacro(DeformationSplineOrder) > 
BSplineTransformType
 
typedef Array2D< WeightsValueTypeBSplineTransformWeightsArrayType
 
typedef
BSplineTransformType::WeightsType 
BSplineTransformWeightsType
 
typedef
CentralDifferenceImageFunction
< MovingImageType,
CoordinateRepresentationType
DerivativeFunctionType
 
typedef std::vector
< FixedImageSamplePoint
FixedImageSampleContainer
 
typedef CovariantVector
< double,
itkGetStaticConstMacro(MovingImageDimension) > 
ImageDerivativesType
 
typedef
BSplineTransformIndexArrayType::ValueType 
IndexValueType
 
typedef std::vector
< MovingImagePointType
MovingImagePointArrayType
 
typedef
BSplineTransformWeightsType::ValueType 
WeightsValueType
 
- Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeMultiThreadedPostProcess (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeMultiThreadedPreProcess (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueMultiThreadedPostProcess (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueMultiThreadedPreProcess (void *arg)
 
- Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static const unsigned int DeformationSplineOrder = 3
 

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage >
typedef SmartPointer< const Self > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Definition at line 47 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::DerivativeType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Definition at line 62 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageConstPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointerType

Definition at line 68 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageType::PixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType

Definition at line 64 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::FixedImageType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Definition at line 63 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::GradientPixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType

Definition at line 58 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef HistogramType::Pointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramPointer

Definition at line 79 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef HistogramType::SizeType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramSizeType

Definition at line 78 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Statistics::Histogram< double > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramType

Typedefs for histogram. This should have been defined as Histogram<RealType,2> but a bug in VC++7 produced an internal compiler error with such declaration.

Definition at line 75 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::InputPointType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::InputPointType

Definition at line 59 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef HistogramType::MeasurementVectorType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MeasurementVectorType

Definition at line 77 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Definition at line 61 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImageConstPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointerType

Definition at line 70 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImageType::PixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType

Definition at line 66 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::MovingImageType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Definition at line 65 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::OutputPointType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType

Definition at line 60 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef SmartPointer< Self > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Definition at line 46 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::RealType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::RealType

Types transferred from the base class

Definition at line 50 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Array< double > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ScalesType

The scales type.

Definition at line 123 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef HistogramImageToImageMetric itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Definition at line 44 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef ImageToImageMetric< TFixedImage, TMovingImage > itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Definition at line 45 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformJacobianType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 57 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformParametersType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Definition at line 56 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 55 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef Superclass::TransformType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Definition at line 54 of file itkHistogramImageToImageMetric.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage >
itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::HistogramImageToImageMetric ( )
protected

Constructor is protected to ensure that New() function is used to create instances.

template<typename TFixedImage , typename TMovingImage >
virtual itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::~HistogramImageToImageMetric ( )
inlineoverrideprotectedvirtual

Definition at line 166 of file itkHistogramImageToImageMetric.h.

Member Function Documentation

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ComputeHistogram ( const TransformParametersType parameters,
HistogramType histogram 
) const
protected

Computes the joint histogram from the transformation parameters passed to the function.

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::ComputeHistogram ( const TransformParametersType parameters,
unsigned int  parameter,
double  step,
HistogramType histogram 
) const
protected

Computes the joint histogram from the transformation parameters passed to the function.

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::CopyHistogram ( HistogramType target,
HistogramType source 
) const
protected

Copies a histogram.

template<typename TFixedImage , typename TMovingImage >
virtual MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::EvaluateMeasure ( HistogramType histogram) const
protectedpure virtual
template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const TransformParametersType parameters,
DerivativeType derivative 
) const
override

Get the derivatives of the match measure.

template<typename TFixedImage , typename TMovingImage >
virtual double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetDerivativeStepLength ( ) const
virtual

Returns the step length used to calculate the derivative.

template<typename TFixedImage , typename TMovingImage >
virtual const ScalesType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetDerivativeStepLengthScales ( ) const
virtual

Returns the derivate step length scales.

template<typename TFixedImage , typename TMovingImage >
virtual const HistogramPointer& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetHistogram ( ) const
virtual

Return the joint histogram. This is updated during every call to the GetValue() method. The histogram can for instance be used by itk::HistogramToImageFilter to plot the joint histogram.

template<typename TFixedImage , typename TMovingImage >
virtual const HistogramSizeType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetHistogramSize ( ) const
virtual

Gets the histogram size.

template<typename TFixedImage , typename TMovingImage >
const MeasurementVectorType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetLowerBound ( ) const

Returns the current state of m_LowerBound.

template<typename TFixedImage , typename TMovingImage >
virtual const char* itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const
virtual
template<typename TFixedImage , typename TMovingImage >
virtual const FixedImagePixelType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetPaddingValue ( ) const
virtual

Returns the padding value.

template<typename TFixedImage , typename TMovingImage >
const MeasurementVectorType& itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetUpperBound ( ) const

Returns the current state of m_UpperBound.

template<typename TFixedImage , typename TMovingImage >
virtual double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetUpperBoundIncreaseFactor ( ) const
virtual

Factor to increase the upper bound for the samples in the histogram. Default value is 0.001

template<typename TFixedImage , typename TMovingImage >
virtual bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetUsePaddingValue ( ) const
virtual

Set whether the padding value should be used to determine which pixels should be ignored when calculating the similarity measure. Those pixels in the fixed image which have the padding value will be ignored.

template<typename TFixedImage , typename TMovingImage >
MeasureType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const TransformParametersType parameters) const
override

Get the value for single valued optimizers.

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const TransformParametersType parameters,
MeasureType Value,
DerivativeType Derivative 
) const
override

Get value and derivatives for multiple valued optimizers.

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( )
overridevirtual
template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual
template<typename TFixedImage , typename TMovingImage >
virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetDerivativeStepLength ( double  _arg)
virtual

Sets the step length used to calculate the derivative.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetDerivativeStepLengthScales ( ScalesType  _arg)
virtual

Sets the derivative step length scales.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetHistogramSize ( HistogramSizeType  _arg)
virtual

Sets the histogram size. Note this function must be called before Initialize().

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetLowerBound ( const MeasurementVectorType bound)

Set the lower bounds of the intensities to be considered for computing the histogram. This option allows to focus the computation of the Metric in a particular range of intensities that correspond to features of interest.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetPaddingValue ( FixedImagePixelType  _arg)
virtual

The padding value.

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTransform ( TransformType transform)
override

Define the transform and thereby the parameter space of the metric and the space of its derivatives

template<typename TFixedImage , typename TMovingImage >
void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetUpperBound ( const MeasurementVectorType bound)

Set the upper bounds of the intensities to be considered for computing the histogram. This option allows to focus the computation of the Metric in a particular range of intensities that correspond to features of interest.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetUpperBoundIncreaseFactor ( double  _arg)
virtual

Factor to increase the upper bound for the samples in the histogram. Default value is 0.001

template<typename TFixedImage , typename TMovingImage >
virtual void itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetUsePaddingValue ( bool  _arg)
virtual

Set whether the padding value should be used to determine which pixels should be ignored when calculating the similarity measure. Those pixels in the fixed image which have the padding value will be ignored.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage >
double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_DerivativeStepLength
private

The step length used to calculate the derivative.

Definition at line 222 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
ScalesType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_DerivativeStepLengthScales
private

The derivative step length scales.

Definition at line 225 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
HistogramPointer itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_Histogram
private

Pointer to the joint histogram. This is updated during every call to GetValue()

Definition at line 229 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
HistogramSizeType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_HistogramSize
protected

The histogram size.

Definition at line 169 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
MeasurementVectorType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_LowerBound
mutableprotected

The lower bound for samples in the histogram.

Definition at line 172 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_LowerBoundSetByUser
protected

Boolean flag to indicate whether the user supplied lower bounds or whether they should be computed from the min of image intensities

Definition at line 182 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
FixedImagePixelType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_PaddingValue
private

The padding value.

Definition at line 211 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
MeasurementVectorType itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UpperBound
mutableprotected

The upper bound for samples in the histogram.

Definition at line 175 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
double itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UpperBoundIncreaseFactor
protected

The increase in the upper bound.

Definition at line 178 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UpperBoundSetByUser
protected

Boolean flag to indicate whether the user supplied upper bounds or whether they should be computed from the max of image intensities

Definition at line 186 of file itkHistogramImageToImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
bool itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::m_UsePaddingValue
private

True if those pixels in the fixed image with the same value as the padding value should be ignored when calculating the similarity measure.

Definition at line 219 of file itkHistogramImageToImageMetric.h.


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