ITK  4.8.0
Insight Segmentation and Registration Toolkit
itkSingleValuedCostFunction.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 itkSingleValuedCostFunction_h
19 #define itkSingleValuedCostFunction_h
20 
21 #include "itkCostFunction.h"
22 #include "itkNumericTraits.h"
23 #include "ITKOptimizersExport.h"
24 
25 namespace itk
26 {
34 class ITKOptimizers_EXPORT SingleValuedCostFunction:
35  public CostFunction
36 {
37 public:
43 
46 
49  typedef double MeasureType;
50 
54  typedef Superclass::ParametersValueType ParametersValueType;
55 
59 
62  virtual MeasureType GetValue(const ParametersType & parameters) const = 0;
63 
66  virtual void GetDerivative(const ParametersType & parameters,
67  DerivativeType & derivative) const = 0;
68 
71  virtual void GetValueAndDerivative(const ParametersType & parameters,
72  MeasureType & value,
73  DerivativeType & derivative) const;
74 
75 protected:
77  virtual ~SingleValuedCostFunction();
78 
79 private:
80  SingleValuedCostFunction(const Self &); //purposely not implemented
81  void operator=(const Self &); //purposely not implemented
82 };
83 } // end namespace itk
84 
85 #endif
Array class with size defined at construction time.
Definition: itkArray.h:50
This class is a base for the CostFunctions returning a single value.
Array< ParametersValueType > DerivativeType
Class to hold and manage different parameter types used during optimization.
Superclass::ParametersType ParametersType
Superclass::ParametersValueType ParametersValueType
SmartPointer< const Self > ConstPointer