forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkTransformParametersAdaptorBase.h
107 lines (94 loc) · 3.98 KB
/
itkTransformParametersAdaptorBase.h
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
/*=========================================================================
*
* 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
*
* 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 itkTransformParametersAdaptorBase_h
#define itkTransformParametersAdaptorBase_h
#include "itkObject.h"
#include "itkObjectFactory.h"
namespace itk
{
/** \class TransformParametersAdaptorBase
* \brief Base helper class intended for multi-resolution image registration.
*
* During multi-resolution image registration, it is often useful to expand
* the number of parameters describing the transform when going from one level
* to the next. For example, in B-spline registration, one often wants to
* increase the mesh size (or, equivalently, the control point grid size) for
* increased flexibility in optimizing the transform. This requires the
* propagation of the current transform solution to the next level where the
* solution is identical but with an increase in the number of parameters.
* This base class and those derived classes are meant to handle these types of
* situations.
*
* Basic usage will involve the user specifying the required fixed parameters, i.e.
*
\code
transformAdaptor->SetTransform( transform );
transformAdaptor->SetRequiredFixedParameters( fixedParameters );
transformAdaptor->AdaptTransformParameters();
\endcode
*
* which will adjust the transform based on the new fixed parameters.
*
* \author Nick Tustison
* \author Marius Staring
*
* \ingroup ITKRegistrationCommon
*/
template <typename TTransform>
class TransformParametersAdaptorBase : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(TransformParametersAdaptorBase);
/** Standard class type aliases. */
using Self = TransformParametersAdaptorBase;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Run-time type information (and related methods). */
itkTypeMacro(TransformParametersAdaptorBase, Object);
/** Typedefs associated with the transform */
using TransformBaseType = TTransform;
using TransformBasePointer = typename TransformBaseType::Pointer;
using ParametersType = typename TransformBaseType::ParametersType;
using ParametersValueType = typename ParametersType::ValueType;
using FixedParametersType = typename TransformBaseType::FixedParametersType;
using FixedParametersValueType = typename TransformBaseType::FixedParametersValueType;
// note: the void pointer is use to ensure this method has lower
// overloaded priority and avoid an ambiguous overloaded method
virtual void
SetTransform(TransformBaseType * _arg, void * priorityLower = nullptr) = 0;
/** Set the fixed parameters */
itkSetMacro(RequiredFixedParameters, FixedParametersType);
/** Get the fixed parameters */
itkGetConstReferenceMacro(RequiredFixedParameters, FixedParametersType);
/** Initialize the transform using the specified fixed parameters */
virtual void
AdaptTransformParameters() = 0;
protected:
TransformParametersAdaptorBase() = default;
~TransformParametersAdaptorBase() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override
{
Superclass::PrintSelf(os, indent);
os << "Fixed parameters" << this->m_RequiredFixedParameters << std::endl;
}
FixedParametersType m_RequiredFixedParameters;
}; // class TransformParametersAdaptorBase
} // namespace itk
#endif /* itkTransformParametersAdaptorBase_h */