ITK  5.2.0
Insight Toolkit
itkMultipleValuedCostFunction.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 itkMultipleValuedCostFunction_h
19 #define itkMultipleValuedCostFunction_h
20 
21 #include "itkCostFunction.h"
22 #include "itkArray2D.h"
23 #include "itkNumericTraits.h"
24 #include "ITKOptimizersExport.h"
25 
26 namespace itk
27 {
35 class ITKOptimizers_EXPORT MultipleValuedCostFunction : public CostFunction
36 {
37 public:
38  ITK_DISALLOW_COPY_AND_ASSIGN(MultipleValuedCostFunction);
39 
45 
48 
52 
56 
60 
64  virtual MeasureType
65  GetValue(const ParametersType & parameters) const = 0;
66 
70  virtual unsigned int
71  GetNumberOfValues() const = 0;
72 
76  virtual void
77  GetDerivative(const ParametersType & parameters, DerivativeType & derivative) const = 0;
78 
79 protected:
80  MultipleValuedCostFunction() = default;
81  ~MultipleValuedCostFunction() override;
82 };
83 } // end namespace itk
84 
85 #endif
itk::MultipleValuedCostFunction
This class is a base for the CostFunctions returning a multiple values.
Definition: itkMultipleValuedCostFunction.h:35
itk::OptimizerParameters< TInternalComputationValueType >
itk::CostFunction
CostFunctionTemplate< double > CostFunction
Definition: itkCostFunction.h:69
itk::SmartPointer< Self >
itkCostFunction.h
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::CostFunctionTemplate
Definition: itkCostFunction.h:36
itkArray2D.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Array< double >
itkNumericTraits.h
itk::Array2D
Array2D class representing a 2D array with size defined at construction time.
Definition: itkArray2D.h:45