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
|
/*=========================================================================
*
* 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 itkOptimizerParameters_h
#define itkOptimizerParameters_h
#include "itkArray.h"
#include "itkOptimizerParametersHelper.h"
#include <memory> // For unique_ptr.
namespace itk
{
/** \class OptimizerParameters
* \brief Class to hold and manage different parameter types used during
* optimization.
*
* \ingroup ITKCommon
*/
template <typename TParametersValueType>
class ITK_TEMPLATE_EXPORT OptimizerParameters : public Array<TParametersValueType>
{
public:
/** The element type stored at each location in the Array. */
using ValueType = TParametersValueType;
using Self = OptimizerParameters;
using Superclass = Array<TParametersValueType>;
using ArrayType = Superclass;
using VnlVectorType = typename Superclass::VnlVectorType;
using typename Superclass::SizeValueType;
/** Helper class for managing different types of parameter
* data. */
using OptimizerParametersHelperType = OptimizerParametersHelper<TParametersValueType>;
/** Default constructor. It is created with an empty array
* it has to be allocated later by assignment */
OptimizerParameters() = default;
/** Copy constructor. Uses VNL copy constructor with correct
* setting for memory management.
* The vnl vector copy constructor creates new memory
* no matter the setting of let array manage memory of rhs.
*/
OptimizerParameters(const OptimizerParameters & rhs)
: Array<TParametersValueType>(rhs)
{
// Note: don't copy the OptimizerParametersHelper.
// The Array copy constructor will allocate new memory
// and copy the data to it. So we end up here with a generic
// OptimizerParameters data object even if 'rhs' points to
// something different.
}
/** Constructor with size. Size can only be changed by assignment.
* \note This constructor may not initialize its elements.
*/
explicit OptimizerParameters(SizeValueType dimension)
: Array<TParametersValueType>(dimension)
{}
/** Constructor with Array assignment */
OptimizerParameters(const ArrayType & array)
: Array<TParametersValueType>(array)
{}
/** Constructor with size and initial value for each element. */
explicit OptimizerParameters(const SizeValueType dimension, const ValueType & value)
: Array<TParametersValueType>(dimension, value)
{}
/** Constructor with input data and size (number of elements). */
explicit OptimizerParameters(const ValueType * const inputData, const SizeValueType dimension)
: Array<TParametersValueType>(inputData, dimension)
{}
/** Initialize. Initialization called by constructors. */
void
Initialize()
{
// Set the default OptimizerParametersHelper
this->m_Helper = std::make_unique<OptimizerParametersHelperType>();
}
/** Set a new data pointer for the parameter data, pointing it to a different
* memory block. The size of the new memory block must equal the current
* size, in elements of TParametersValueType.
* This call is passed to the assigned OptimizerParametersHelper.
* \warning Memory must be managed by caller after this call. */
virtual void
MoveDataPointer(TParametersValueType * pointer)
{
if (m_Helper == nullptr)
{
itkGenericExceptionMacro("OptimizerParameters::MoveDataPointer: "
"m_Helper must be set.");
}
this->m_Helper->MoveDataPointer(this, pointer);
}
/** Set an object that holds the parameters. Used by the helper of
* derived classes that use an object other than itkArray to hold parameter
* data. The helper class must check that the object is the correct type.
* The call is passed to the assigned OptimizerParametersHelper. */
virtual void
SetParametersObject(LightObject * object)
{
if (m_Helper == nullptr)
{
itkGenericExceptionMacro("OptimizerParameters::SetParameterObject: "
"m_Helper must be set.");
}
this->m_Helper->SetParametersObject(this, object);
}
/** Assign a helper. OptimizerParameters manages the helper once
* its been assigned. The generic helper, OptimizerParametersHelper,
* is set in constructor.
* Classes that need a specialized helper should allocate
* one themselves and assign it with this method. */
virtual void
SetHelper(OptimizerParametersHelperType * helper)
{
this->m_Helper.reset(helper);
}
/** Get the helper in use. */
OptimizerParametersHelperType *
GetHelper()
{
return m_Helper.get();
}
/** Copy operators
*
* TODO Determine behavior when copying from obj pointing to image parameters.
* By default should copy image param data into Array portion of new object,
* i.e. into data_block. Is that what we want? */
Self &
operator=(const Self & rhs)
{
// Note: there's no need to copy the OptimizerParametersHelper.
// Call the superclass implementation.
this->ArrayType::operator=(rhs);
return *this;
}
Self &
operator=(const ArrayType & rhs)
{
// Call the superclass implementation
this->ArrayType::operator=(rhs);
return *this;
}
Self &
operator=(const VnlVectorType & rhs)
{
// Call the superclass implementation
this->ArrayType::operator=(rhs);
return *this;
}
~OptimizerParameters() override = default;
private:
std::unique_ptr<OptimizerParametersHelperType> m_Helper{ std::make_unique<OptimizerParametersHelperType>() };
};
} // namespace itk
#endif
|
