File: itkMeanSquaresPointSetToPointSetIntensityMetricv4.h

package info (click to toggle)
ants 2.5.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,672 kB
  • sloc: cpp: 85,685; sh: 15,850; perl: 863; xml: 115; python: 111; makefile: 68
file content (218 lines) | stat: -rw-r--r-- 8,519 bytes parent folder | download
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
/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkMeanSquaresPointSetToPointSetIntensityMetricv4_h
#define itkMeanSquaresPointSetToPointSetIntensityMetricv4_h

#include "itkPointSetToPointSetMetricv4.h"

namespace itk
{
/** \class MeanSquaresPointSetToPointSetIntensityMetricv4
 * \brief Computes a mean-squares intensity metric between two point sets.
 *
 *  We only have to handle the individual point case as the parent
 *  class handles the aggregation.
 *
 *  The PointSet::PixelType contains both the intensity and gradient
 *  information at each point and the surrounding neighborhood.  The ordering
 *  is based on the itk::Neighborhood data structure:
 *
 *  http://www.itk.org/Doxygen/html/classitk_1_1Neighborhood.html
 *
 *  pixelData = [intensity_0, gradientX_0, gradientY_0, gradientZ_0,       // GetOffset( 0 )
 *               intensity_1, gradientX_1, gradientY_1, gradientZ_1,       // GetOffset( 1 )
 *               ...        , ...        , ...        , ...        ,         ...
 *               intensity_N, gradientX_N, gradientY_N, gradientZ_N]       // GetOffset( N )
 *
 *
 * \ingroup ITKMetricsv4
 */
template <typename TFixedPointSet,
          typename TMovingPointSet = TFixedPointSet,
          typename TInternalComputationValueType = double>
class MeanSquaresPointSetToPointSetIntensityMetricv4 final
  : public PointSetToPointSetMetricv4<TFixedPointSet, TMovingPointSet, TInternalComputationValueType>
{
public:
  /** Standard class typedefs. */
  typedef MeanSquaresPointSetToPointSetIntensityMetricv4                                             Self;
  typedef PointSetToPointSetMetricv4<TFixedPointSet, TMovingPointSet, TInternalComputationValueType> Superclass;
  typedef SmartPointer<Self>                                                                         Pointer;
  typedef SmartPointer<const Self>                                                                   ConstPointer;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information (and related methods). */
  itkTypeMacro(MeanSquaresPointSetToPointSetIntensityMetricv4, PointSetToPointSetMetricv4);

  /**  Type of the fixed point set. */
  typedef TFixedPointSet                              FixedPointSetType;
  typedef typename TFixedPointSet::PointType          FixedPointType;
  typedef typename TFixedPointSet::PixelType          FixedPixelType;
  typedef typename TFixedPointSet::PointsContainer    FixedPointsContainer;
  typedef typename TFixedPointSet::PointDataContainer FixedPointDataContainer;

  /** Dimension type */
  typedef typename Superclass::DimensionType DimensionType;

  static constexpr DimensionType FixedPointDimension = Superclass::FixedDimension;

  /**  Type of the moving point set. */
  typedef TMovingPointSet                              MovingPointSetType;
  typedef typename TMovingPointSet::PointType          MovingPointType;
  typedef typename TMovingPointSet::PixelType          MovingPixelType;
  typedef typename TMovingPointSet::PointsContainer    MovingPointsContainer;
  typedef typename TMovingPointSet::PointDataContainer MovingPointDataContainer;

  static constexpr DimensionType MovingPointDimension = Superclass::MovingDimension;

  /** Transform types from Superclass*/
  typedef typename Superclass::FixedTransformType  FixedTransformType;
  typedef typename Superclass::MovingTransformType MovingTransformType;

  static constexpr DimensionType PointDimension = Superclass::PointDimension;

  /** Types transferred from the base class */
  typedef typename Superclass::MeasureType         MeasureType;
  typedef typename Superclass::DerivativeType      DerivativeType;
  typedef typename Superclass::LocalDerivativeType LocalDerivativeType;
  typedef typename Superclass::PointType           PointType;
  typedef typename Superclass::PixelType           PixelType;
  typedef typename Superclass::PointIdentifier     PointIdentifier;
  typedef typename Superclass::PointsConstIterator PointsConstIterator;

  typedef CovariantVector<TInternalComputationValueType, PointDimension> CovariantVectorType;

  /**
   * Set/get estimate intensity distance sigma automatically based on reasonable
   * heuristics.
   */
  itkSetMacro(EstimateIntensityDistanceSigmaAutomatically, bool);
  itkGetConstMacro(EstimateIntensityDistanceSigmaAutomatically, bool);
  itkBooleanMacro(EstimateIntensityDistanceSigmaAutomatically);

  /**
   * Set/get estimate Euclidean distance sigma automatically based on reasonable
   * heuristics.
   */
  itkSetMacro(EstimateEuclideanDistanceSigmaAutomatically, bool);
  itkGetConstMacro(EstimateEuclideanDistanceSigmaAutomatically, bool);
  itkBooleanMacro(EstimateEuclideanDistanceSigmaAutomatically);

  /**
   * Set/get intensity sigma -- modulate the intensity distance contribution in the
   * metric formulation.  Default = sqrt( 5.0 ).
   */
  itkSetMacro(IntensityDistanceSigma, TInternalComputationValueType);
  itkGetConstMacro(IntensityDistanceSigma, TInternalComputationValueType);

  /**
   * Set/get distance sigma -- modulate the Euclidean distance contribution in the
   * metric formulation.   Default = sqrt( 5.0 ).
   */
  itkSetMacro(EuclideanDistanceSigma, TInternalComputationValueType);
  itkGetConstMacro(EuclideanDistanceSigma, TInternalComputationValueType);

  /**
   * Initialize the metric by estimating the intensity and distance sigmas
   */
  void
  Initialize(void) override;

  /**
   * Prepare point sets for use.
   */
  void
  InitializePointSets() const override;

  /**
   * Calculates the local metric value for a single point.
   */
  MeasureType
  GetLocalNeighborhoodValue(const PointType &, const PixelType &) const override;

  /** Helper method allows for code reuse while skipping the metric value
   * calculation when appropriate */
  void
  CalculateValueAndDerivative(MeasureType & value, DerivativeType & derivative, bool calculateValue) const;

  /**
   * Calculates the local value and derivative for a single point.
   */
  void
  GetLocalNeighborhoodValueAndDerivative(const PointType &,
                                         MeasureType &,
                                         LocalDerivativeType &,
                                         const PixelType &) const override;

  /** Clone method will clone the existing instance of this type,
   *  including its internal member variables. */
  typename LightObject::Pointer
  InternalClone() const override;

protected:
  MeanSquaresPointSetToPointSetIntensityMetricv4();
  ~MeanSquaresPointSetToPointSetIntensityMetricv4() override;

  /**
   * Estimate the intensity distance sigma based on simple heuristic
   */
  void
  EstimateIntensityDistanceSigma();

  /**
   * Estimate the Euclidean distance sigma based on simple heuristic
   */
  void
  EstimateEuclideanDistanceSigma();

  /**
   * Warp the fixed point set gradients based on the fixed transform.
   */
  void
  TransformFixedPointSetGradients() const;

  /**
   * Warp the moving point set gradients based on the moving transform.
   */
  void
  TransformMovingPointSetGradients() const;


  /** PrintSelf function */
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

private:
  MeanSquaresPointSetToPointSetIntensityMetricv4(const Self &); // purposely not implemented
  void
  operator=(const Self &); // purposely not implemented

  bool                          m_EstimateIntensityDistanceSigmaAutomatically;
  bool                          m_EstimateEuclideanDistanceSigmaAutomatically;
  TInternalComputationValueType m_IntensityDistanceSigma;
  TInternalComputationValueType m_EuclideanDistanceSigma;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMeanSquaresPointSetToPointSetIntensityMetricv4.hxx"
#endif

#endif