ITK  4.3.0
Insight Segmentation and Registration Toolkit
itkObjectToObjectOptimizerBase.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 __itkObjectToObjectOptimizerBase_h
19 #define __itkObjectToObjectOptimizerBase_h
20 
21 #include "itkOptimizerParameters.h"
23 #include "itkIntTypes.h"
24 
25 namespace itk
26 {
67 class ITK_EXPORT ObjectToObjectOptimizerBase : public Object
68 {
69 public:
72  typedef Object Superclass;
75 
78 
81 
84 
88 
91 
94 
97 
99  itkGetObjectMacro( Metric, MetricType );
100  itkSetObjectMacro( Metric, MetricType );
102 
106  itkGetConstReferenceMacro( CurrentMetricValue, MeasureType );
107 
113  const MeasureType & GetValue();
114 
116  itkSetMacro( Scales, ScalesType );
117 
119  itkGetConstReferenceMacro( Scales, ScalesType );
120 
122  itkGetConstReferenceMacro( ScalesAreIdentity, bool );
123 
125  itkSetMacro( Weights, ScalesType );
126 
129  itkGetConstReferenceMacro( Weights, ScalesType );
130 
132  itkGetConstReferenceMacro( WeightsAreIdentity, bool );
133 
137  virtual void SetNumberOfThreads( ThreadIdType number );
138 
140  itkGetConstReferenceMacro( NumberOfThreads, ThreadIdType );
141 
145  const ParametersType & GetCurrentPosition();
146 
154  virtual void StartOptimization( bool doOnlyInitialization = false );
155 
156 protected:
157 
160  virtual ~ObjectToObjectOptimizerBase();
162 
165 
168 
172 
178 
181 
184 
185  virtual void PrintSelf(std::ostream & os, Indent indent) const;
186 
187 private:
188 
189  //purposely not implemented
191  //purposely not implemented
192  void operator=( const Self& );
193 
194 };
195 
196 } // end namespace itk
197 
198 #endif
199