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
|
/*=========================================================================
*
* 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 itkOptimizerParameters_h
#define itkOptimizerParameters_h
#include "itkArray.h"
#include "itkOptimizerParametersHelper.h"
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. */
typedef TParametersValueType ValueType;
typedef OptimizerParameters Self;
typedef Array<TParametersValueType> Superclass;
typedef Superclass ArrayType;
typedef typename Superclass::VnlVectorType VnlVectorType;
typedef typename Superclass::SizeValueType SizeValueType;
/** Helper class for managing different types of parameter
* data. */
typedef OptimizerParametersHelper<TParametersValueType> OptimizerParametersHelperType;
/** Default constructor. It is created with an empty array
* it has to be allocated later by assignment */
OptimizerParameters();
/** Copy constructor. Uses VNL copy construtor 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);
/** Constructor with size. Size can only be changed by assignment */
explicit OptimizerParameters(SizeValueType dimension);
/** Constructor with Array assignment */
OptimizerParameters( const ArrayType& array );
/** Initialize. Initialization called by constructors. */
void Initialize();
/** 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 );
/** 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 );
/** 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 );
/** Get the helper in use. */
OptimizerParametersHelperType* GetHelper()
{ return m_Helper; }
/** Copy opertors
*
* 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? */
const Self & operator=(const Self & rhs);
const Self & operator=(const ArrayType & rhs);
const Self & operator=(const VnlVectorType & rhs);
virtual ~OptimizerParameters();
private:
OptimizerParametersHelperType* m_Helper;
};
}//namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkOptimizerParameters.hxx"
#endif
#endif
|
