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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkRegistrationParameterScalesFromShiftBase_h
#define itkRegistrationParameterScalesFromShiftBase_h
#include "itkRegistrationParameterScalesEstimator.h"
namespace itk
{
/**
* \class RegistrationParameterScalesFromShiftBase
* \brief Registration helper base class for estimating scales of
* transform parameters from the maximum voxel shift caused by a parameter
* change.
*
* Derived classes provide estimation using physical or index space.
*
* The scale of a parameter is estimated from the maximum voxel shift produced
* from a small variation of this parameter. The maximization is done by checking
* sample points within the metric's virtual domain. Sample points are generated
* differently depending on the type of metric transform or metric type.
* See RegistrationParameterScalesEstimator documentation.
*
* \sa RegistrationParameterScalesEstimator
* \ingroup ITKOptimizersv4
*/
template <typename TMetric>
class ITK_TEMPLATE_EXPORT RegistrationParameterScalesFromShiftBase
: public RegistrationParameterScalesEstimator<TMetric>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(RegistrationParameterScalesFromShiftBase);
/** Standard class type aliases. */
using Self = RegistrationParameterScalesFromShiftBase;
using Superclass = RegistrationParameterScalesEstimator<TMetric>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(RegistrationParameterScalesFromShiftBase);
/** Type of scales */
using typename Superclass::ScalesType;
/** Type of parameters of the optimizer */
using typename Superclass::ParametersType;
using ParametersValueType = typename ParametersType::ValueType;
/** Type of float */
using typename Superclass::FloatType;
using typename Superclass::VirtualPointType;
using typename Superclass::VirtualIndexType;
using typename Superclass::MovingTransformType;
using typename Superclass::FixedTransformType;
using typename Superclass::JacobianType;
using typename Superclass::VirtualImageConstPointer;
/** Estimate parameter scales */
void
EstimateScales(ScalesType & parameterScales) override;
/** Estimate the scale of a step */
FloatType
EstimateStepScale(const ParametersType & step) override;
/** Estimate the scales of local steps */
void
EstimateLocalStepScales(const ParametersType & step, ScalesType & localStepScales) override;
/** Set/get small parameter variation */
itkSetMacro(SmallParameterVariation, ParametersValueType);
itkGetConstMacro(SmallParameterVariation, ParametersValueType);
protected:
RegistrationParameterScalesFromShiftBase();
~RegistrationParameterScalesFromShiftBase() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Compute the shift in voxels when deltaParameters is applied onto the
* current parameters. */
virtual FloatType
ComputeMaximumVoxelShift(const ParametersType & deltaParameters);
/** Compute the sample shifts.
*/
virtual void
ComputeSampleShifts(const ParametersType & deltaParameters, ScalesType & localShifts) = 0;
private:
// A small variation of parameters
ParametersValueType m_SmallParameterVariation{};
}; // class RegistrationParameterScalesFromShiftBase
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkRegistrationParameterScalesFromShiftBase.hxx"
#endif
#endif /* itkRegistrationParameterScalesFromShiftBase_h */
|
