ITK  4.3.0
Insight Segmentation and Registration Toolkit
itkMultipleValuedNonLinearVnlOptimizer.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 __itkMultipleValuedNonLinearVnlOptimizer_h
19 #define __itkMultipleValuedNonLinearVnlOptimizer_h
20 
23 #include "itkCommand.h"
24 
25 namespace itk
26 {
38 {
39 public:
45 
48  MultipleValueNonLinearOptimizer);
49 
52  typedef Superclass::ParametersType ParametersType;
53 
60  virtual void SetCostFunction(MultipleValuedCostFunction *costFunction) = 0;
61 
65  void SetUseCostFunctionGradient(bool);
66 
67  void UseCostFunctionGradientOn()
68  {
69  this->SetUseCostFunctionGradient(true);
70  }
71 
72  void UseCostFunctionGradientOff()
73  {
74  this->SetUseCostFunctionGradient(false);
75  }
76 
77  bool GetUseCostFunctionGradient() const;
78 
85  itkGetConstReferenceMacro(CachedValue, MeasureType);
86  itkGetConstReferenceMacro(CachedDerivative, DerivativeType);
87  itkGetConstReferenceMacro(CachedCurrentPosition, ParametersType);
89 
90 protected:
93 
94  void PrintSelf(std::ostream & os, Indent indent) const;
95 
97 
98  void SetCostFunctionAdaptor(CostFunctionAdaptorType *adaptor);
99 
100  const CostFunctionAdaptorType * GetCostFunctionAdaptor(void) const;
101 
102  CostFunctionAdaptorType * GetCostFunctionAdaptor(void);
103 
106  CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor(void) const;
107 
113 
114 private:
115  MultipleValuedNonLinearVnlOptimizer(const Self &); //purposely not implemented
116  void operator=(const Self &); //purposely not implemented
117 
119  void IterationReport(const EventObject & event);
120 
123 
125 
129 };
130 } // end namespace itk
131 
132 #endif
133