ITK  4.3.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 
24 namespace itk
25 {
33 class ITK_EXPORT SingleValuedCostFunction:
34  public CostFunction
35 {
36 public:
42 
45 
48  typedef double MeasureType;
49 
53  typedef Superclass::ParametersValueType ParametersValueType;
54 
58 
61  virtual MeasureType GetValue(const ParametersType & parameters) const = 0;
62 
65  virtual void GetDerivative(const ParametersType & parameters,
66  DerivativeType & derivative) const = 0;
67 
70  virtual void GetValueAndDerivative(const ParametersType & parameters,
71  MeasureType & value,
72  DerivativeType & derivative) const
73  {
74  value = this->GetValue(parameters);
75  this->GetDerivative(parameters, derivative);
76  }
78 
79 protected:
82 
83 private:
84  SingleValuedCostFunction(const Self &); //purposely not implemented
85  void operator=(const Self &); //purposely not implemented
86 };
87 } // end namespace itk
88 
89 #endif
90