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
|
/*=========================================================================
*
* 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 itkCostFunction_h
#define itkCostFunction_h
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkArray.h"
#include "itkOptimizerParameters.h"
namespace itk
{
/** \class CostFunction
* \brief Base class for cost functions intended to be used with Optimizers.
*
* \ingroup Numerics Optimizers
*
* \ingroup ITKOptimizers
*/
template <typename TInternalComputationValueType>
class ITK_TEMPLATE_EXPORT CostFunctionTemplate : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(CostFunctionTemplate);
/** Standard class type aliases. */
using Self = CostFunctionTemplate;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(CostFunctionTemplate);
/** ParametersType type alias.
* It defines a position in the optimization search space. */
using ParametersValueType = TInternalComputationValueType;
using ParametersType = OptimizerParameters<TInternalComputationValueType>;
/** Return the number of parameters required to compute
* this cost function.
* This method MUST be overloaded by derived classes. */
virtual unsigned int
GetNumberOfParameters() const = 0;
protected:
CostFunctionTemplate() = default;
~CostFunctionTemplate() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
};
/** This helps to meet backward compatibility */
using CostFunction = CostFunctionTemplate<double>;
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkCostFunction.hxx"
#endif
#endif
|
