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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkSingleValuedCostFunction.h,v $
Language: C++
Date: $Date: 2007-03-22 21:39:38 $
Version: $Revision: 1.9 $
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkSingleValuedCostFunction_h
#define __itkSingleValuedCostFunction_h
#include "itkCostFunction.h"
#include "itkArray.h"
#include "itkObjectFactory.h"
#include "itkNumericTraits.h"
namespace itk
{
/** \class SingleValuedCostFunction
* \brief This class is a base for the CostFunctions returning a
* single value
*
* \ingroup Numerics Optimizers
*/
class ITK_EXPORT SingleValuedCostFunction :
public CostFunction
{
public:
/** Standard class typedefs. */
typedef SingleValuedCostFunction Self;
typedef CostFunction Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Run-time type information (and related methods). */
itkTypeMacro( SingleValuedCostFunction, CostFunction );
/** MeasureType typedef.
* It defines a type used to return the cost function value. */
typedef double MeasureType;
/** DerivativeType typedef.
* It defines a type used to return the cost function derivative. */
typedef Array<double> DerivativeType;
/** ParametersType typedef.
* It defines a position in the optimization search space. */
typedef Superclass::ParametersType ParametersType;
/** This method returns the value of the cost function corresponding
* to the specified parameters. */
virtual MeasureType GetValue( const ParametersType & parameters ) const = 0;
/** This method returns the derivative of the cost function corresponding
* to the specified parameters. */
virtual void GetDerivative( const ParametersType & parameters,
DerivativeType & derivative ) const = 0;
/** This method returns the value and derivative of the cost function corresponding
* to the specified parameters */
virtual void GetValueAndDerivative( const ParametersType & parameters,
MeasureType & value,
DerivativeType & derivative ) const
{
value = this->GetValue( parameters );
this->GetDerivative( parameters, derivative );
}
protected:
SingleValuedCostFunction() {};
virtual ~SingleValuedCostFunction() {};
private:
SingleValuedCostFunction(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
};
} // end namespace itk
#endif
|
