/usr/include/InsightToolkit/Algorithms/itkHistogramImageToImageMetric.h is in libinsighttoolkit3-dev 3.20.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | /*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkHistogramImageToImageMetric.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkHistogramImageToImageMetric_h
#define __itkHistogramImageToImageMetric_h
#include "itkHistogram.h"
#include "itkImageToImageMetric.h"
namespace itk
{
/** \class HistogramImageToImageMetric
\brief 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.
\ingroup RegistrationMetrics */
template <class TFixedImage, class TMovingImage>
class ITK_EXPORT HistogramImageToImageMetric :
public ImageToImageMetric<TFixedImage, TMovingImage>
{
public:
/** Standard class typedefs. */
typedef HistogramImageToImageMetric Self;
typedef ImageToImageMetric<TFixedImage, TMovingImage> Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Run-time type information (and related methods). */
itkTypeMacro(HistogramImageToImageMetric, ImageToImageMetric);
/** Types transferred from the base class */
typedef typename Superclass::RealType RealType;
typedef typename Superclass::TransformType TransformType;
typedef typename Superclass::TransformPointer TransformPointer;
typedef typename Superclass::TransformParametersType
TransformParametersType;
typedef typename Superclass::TransformJacobianType
TransformJacobianType;
typedef typename Superclass::GradientPixelType GradientPixelType;
typedef typename Superclass::InputPointType InputPointType;
typedef typename Superclass::OutputPointType OutputPointType;
typedef typename Superclass::MeasureType MeasureType;
typedef typename Superclass::DerivativeType DerivativeType;
typedef typename Superclass::FixedImageType FixedImageType;
typedef typename Superclass::FixedImageType::PixelType FixedImagePixelType;
typedef typename Superclass::MovingImageType MovingImageType;
typedef typename Superclass::MovingImageType::PixelType MovingImagePixelType;
typedef typename Superclass::FixedImageConstPointer
FixedImageConstPointerType;
typedef typename Superclass::MovingImageConstPointer
MovingImageConstPointerType;
/** 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. */
#ifdef ITK_USE_REVIEW_STATISTICS
typedef Statistics::Histogram<double> HistogramType;
#else
typedef Statistics::Histogram<double, 2> HistogramType;
#endif
typedef typename HistogramType::MeasurementVectorType MeasurementVectorType;
typedef typename HistogramType::SizeType HistogramSizeType;
typedef typename HistogramType::Pointer HistogramPointer;
/** Initializes the metric. */
void Initialize() throw (ExceptionObject);
/** Define the transform and thereby the parameter space of the metric
* and the space of its derivatives */
void SetTransform( TransformType * transform );
/** Sets the histogram size. Note this function must be called before
\c Initialize(). */
itkSetMacro( HistogramSize, HistogramSizeType );
/** Gets the histogram size. */
itkGetConstReferenceMacro( HistogramSize, HistogramSizeType );
/** Factor to increase the upper bound for the samples in the histogram.
Default value is 0.001 */
itkSetMacro( UpperBoundIncreaseFactor, double );
itkGetConstMacro( UpperBoundIncreaseFactor, double );
/** The padding value. */
itkSetMacro( PaddingValue, FixedImagePixelType );
/** Returns the padding value. */
itkGetConstReferenceMacro( PaddingValue, FixedImagePixelType );
/** 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. */
itkGetConstReferenceMacro( Histogram, HistogramPointer );
/** 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. */
itkSetMacro( UsePaddingValue, bool );
itkGetConstMacro( UsePaddingValue, bool );
/** Sets the step length used to calculate the derivative. */
itkSetMacro( DerivativeStepLength, double );
/** Returns the step length used to calculate the derivative. */
itkGetConstMacro( DerivativeStepLength, double );
/** The scales type. */
typedef Array<double> ScalesType;
/** Sets the derivative step length scales. */
itkSetMacro( DerivativeStepLengthScales, ScalesType );
/** Returns the derivate step length scales. */
itkGetConstReferenceMacro(DerivativeStepLengthScales, ScalesType);
/** Get the value for single valued optimizers. */
MeasureType GetValue(const TransformParametersType& parameters) const;
/** Get the derivatives of the match measure. */
void GetDerivative(const TransformParametersType & parameters,
DerivativeType & derivative) const;
/** Get value and derivatives for multiple valued optimizers. */
void GetValueAndDerivative(const TransformParametersType & parameters,
MeasureType& Value,
DerivativeType& Derivative) const;
/** 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. */
void SetLowerBound( 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. */
void SetUpperBound( const MeasurementVectorType & bound );
protected:
/** Constructor is protected to ensure that \c New() function is used to
create instances. */
HistogramImageToImageMetric();
virtual ~HistogramImageToImageMetric() {};
/** The histogram size. */
HistogramSizeType m_HistogramSize;
/** The lower bound for samples in the histogram. */
mutable MeasurementVectorType m_LowerBound;
/** The upper bound for samples in the histogram. */
mutable MeasurementVectorType m_UpperBound;
/** The increase in the upper bound. */
double m_UpperBoundIncreaseFactor;
/** Boolean flag to indicate whether the user supplied lower bounds or
* whether they should be computed from the min of image intensities */
bool m_LowerBoundSetByUser;
/** Boolean flag to indicate whether the user supplied upper bounds or
* whether they should be computed from the max of image intensities */
bool m_UpperBoundSetByUser;
/** Computes the joint histogram from the transformation parameters
passed to the function. */
void ComputeHistogram(const TransformParametersType & parameters,
HistogramType& histogram) const;
/** Computes the joint histogram from the transformation parameters
passed to the function. */
void ComputeHistogram(const TransformParametersType & parameters,
unsigned int parameter,
double step,
HistogramType& histogram) const;
/** Copies a histogram. */
void CopyHistogram(HistogramType& target, HistogramType& source) const;
/** Evaluates the similarity measure using the given histogram. All
subclasses must reimplement this method. */
virtual MeasureType EvaluateMeasure(HistogramType& histogram) const = 0;
/** PrintSelf funtion */
void PrintSelf(std::ostream& os, Indent indent) const;
private:
HistogramImageToImageMetric(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
/** The padding value. */
FixedImagePixelType m_PaddingValue;
/** True if those pixels in the fixed image with the same value as the
padding value should be ignored when calculating the similarity
measure. */
bool m_UsePaddingValue;
/** The step length used to calculate the derivative. */
double m_DerivativeStepLength;
/** The derivative step length scales. */
ScalesType m_DerivativeStepLengthScales;
/** Pointer to the joint histogram. This is updated during every call to
* GetValue() */
HistogramPointer m_Histogram;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkHistogramImageToImageMetric.txx"
#endif
#endif // __itkHistogramImageToImageMetric_h
|