ITK  4.3.0
Insight Segmentation and Registration Toolkit
itkSingleValuedNonLinearVnlOptimizer.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 __itkSingleValuedNonLinearVnlOptimizer_h
19 #define __itkSingleValuedNonLinearVnlOptimizer_h
20 
23 #include "itkCommand.h"
24 
25 namespace itk
26 {
38 {
39 public:
45 
48  SingleValueNonLinearOptimizer);
49 
55 
62  virtual void SetCostFunction(SingleValuedCostFunction *costFunction) = 0;
63 
69  itkGetConstReferenceMacro(Maximize, bool);
70  itkSetMacro(Maximize, bool);
71  itkBooleanMacro(Maximize);
72  bool GetMinimize() const
73  { return !m_Maximize; }
74  void SetMinimize(bool v)
75  { this->SetMaximize(!v); }
76  void MinimizeOn()
77  { this->MaximizeOff(); }
78  void MinimizeOff()
79  { this->MaximizeOn(); }
81 
87  itkGetConstReferenceMacro(CachedValue, MeasureType);
88  itkGetConstReferenceMacro(CachedDerivative, DerivativeType);
89  itkGetConstReferenceMacro(CachedCurrentPosition, ParametersType);
91 
92 protected:
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 
109  void PrintSelf(std::ostream & os, Indent indent) const;
110 
111 private:
113  void IterationReport(const EventObject & event);
114 
115  SingleValuedNonLinearVnlOptimizer(const Self &); //purposely not implemented
116  void operator=(const Self &); //purposely not implemented
117 
119 
121 
123 
127 };
128 } // end namespace itk
129 
130 #endif
131