ITK  5.3.0
Insight Toolkit
itkSingleValuedCostFunctionv4.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 itkSingleValuedCostFunctionv4_h
19 #define itkSingleValuedCostFunctionv4_h
20 
21 #include "itkCostFunction.h"
22 #include "itkNumericTraits.h"
23 
24 namespace itk
25 {
49 template <typename TInternalComputationValueType>
50 class ITK_TEMPLATE_EXPORT SingleValuedCostFunctionv4Template
51  : public CostFunctionTemplate<TInternalComputationValueType>
52 {
53 public:
54  ITK_DISALLOW_COPY_AND_MOVE(SingleValuedCostFunctionv4Template);
55 
61 
64 
67  using MeasureType = TInternalComputationValueType;
68 
71  using typename Superclass::ParametersType;
72 
76 
79  virtual MeasureType
80  GetValue() const = 0;
81 
85  virtual void
86  GetValueAndDerivative(MeasureType & value, DerivativeType & derivative) const = 0;
87 
88 protected:
90  ~SingleValuedCostFunctionv4Template() override = default;
91 };
92 
95 
96 } // end namespace itk
97 
98 #endif
itk::SmartPointer< Self >
itkCostFunction.h
itk::SingleValuedCostFunctionv4Template< TParametersValueType >::MeasureType
TParametersValueType MeasureType
Definition: itkSingleValuedCostFunctionv4.h:67
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::CostFunctionTemplate
Definition: itkCostFunction.h:36
itk::SingleValuedCostFunctionv4Template
This class is a base for a CostFunction that returns a single value.
Definition: itkSingleValuedCostFunctionv4.h:50
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Array< TParametersValueType >
itkNumericTraits.h