ITK  5.2.0
Insight Toolkit
itkOptimizerParameters.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkOptimizerParameters_h
19 #define itkOptimizerParameters_h
20 
21 #include "itkArray.h"
23 
24 namespace itk
25 {
33 template <typename TParametersValueType>
34 class ITK_TEMPLATE_EXPORT OptimizerParameters : public Array<TParametersValueType>
35 {
36 public:
38  using ValueType = TParametersValueType;
44 
48 
52 
59 
61  explicit OptimizerParameters(SizeValueType dimension);
62 
64  OptimizerParameters(const ArrayType & array);
65 
67  void
68  Initialize();
69 
75  virtual void
76  MoveDataPointer(TParametersValueType * pointer);
77 
82  virtual void
83  SetParametersObject(LightObject * object);
84 
90  virtual void
91  SetHelper(OptimizerParametersHelperType * helper);
92 
96  {
97  return m_Helper;
98  }
99 
105  const Self &
106  operator=(const Self & rhs);
107 
108  const Self &
109  operator=(const ArrayType & rhs);
110 
111  const Self &
112  operator=(const VnlVectorType & rhs);
113 
114  ~OptimizerParameters() override;
115 
116 private:
118 };
119 
120 } // namespace itk
121 
122 #ifndef ITK_MANUAL_INSTANTIATION
123 # include "itkOptimizerParameters.hxx"
124 #endif
125 
126 #endif
itkOptimizerParametersHelper.h
itk::OptimizerParameters
Class to hold and manage different parameter types used during optimization.
Definition: itkOptimizerParameters.h:34
itk::OptimizerParameters::m_Helper
OptimizerParametersHelperType * m_Helper
Definition: itkOptimizerParameters.h:117
itk::Array< TInternalComputationValueType >::SizeValueType
typename vnl_vector< TInternalComputationValueType >::size_type SizeValueType
Definition: itkArray.h:55
itk::Array< TInternalComputationValueType >::VnlVectorType
vnl_vector< TInternalComputationValueType > VnlVectorType
Definition: itkArray.h:54
itk::OptimizerParametersHelper
Basic helper class to manage parameter data as an Array type, the default type.
Definition: itkOptimizerParametersHelper.h:34
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkArray.h
itk::Array< TInternalComputationValueType >::ValueType
TInternalComputationValueType ValueType
Definition: itkArray.h:52
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Array
Array class with size defined at construction time.
Definition: itkArray.h:47
itk::OptimizerParameters::GetHelper
OptimizerParametersHelperType * GetHelper()
Definition: itkOptimizerParameters.h:95
itk::SizeValueType
unsigned long SizeValueType
Definition: itkIntTypes.h:83