ITK  4.6.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 
53 
60  virtual void SetCostFunction(MultipleValuedCostFunction *costFunction) = 0;
61 
65  void SetUseCostFunctionGradient(bool);
66 
68  {
69  this->SetUseCostFunctionGradient(true);
70  }
71 
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  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
95 
97 
99 
101 
103 
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
MultipleValuedVnlCostFunctionAdaptor CostFunctionAdaptorType
Light weight base class for most itk classes.
void SetCostFunctionAdaptor(CostFunctionAdaptorType *adaptor)
This class is a base for the Optimization methods that optimize a multi-valued function.
This class is a base for the CostFunctions returning a multiple values.
void IterationReport(const EventObject &event)
Array2D class representing a 2D array with size defined at construction time.
Definition: itkArray2D.h:44
This class is a base for the Optimization methods that optimize a multiple valued function...
A Command subclass that calls a pointer to a member function.
Definition: itkCommand.h:168
Abstraction of the Events used to communicating among filters and with GUIs.
CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor(void) const
virtual void SetCostFunction(MultipleValuedCostFunction *costFunction)=0
virtual void PrintSelf(std::ostream &os, Indent indent) const ITK_OVERRIDE
Control indentation during Print() invocation.
Definition: itkIndent.h:49
This class is an Adaptor that allows to pass itk::MultipleValuedCostFunctions to vnl_optimizers expec...
const CostFunctionAdaptorType * GetCostFunctionAdaptor(void) const