go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
elxOptimizerBase.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright UMC Utrecht and contributors
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 
19 #ifndef __elxOptimizerBase_h
20 #define __elxOptimizerBase_h
21 
23 #include "elxMacro.h"
24 
25 #include "elxBaseComponentSE.h"
26 #include "itkOptimizer.h"
27 
28 namespace elastix
29 {
30 
52 template< class TElastix >
53 class OptimizerBase : public BaseComponentSE< TElastix >
54 {
55 public:
56 
60 
62  itkTypeMacro( OptimizerBase, BaseComponentSE );
63 
71 
73  typedef itk::Optimizer ITKBaseType;
74 
76  typedef typename ITKBaseType::ParametersType ParametersType;
77 
79  virtual ITKBaseType * GetAsITKBaseType( void )
80  {
81  return dynamic_cast< ITKBaseType * >( this );
82  }
83 
84 
86  virtual const ITKBaseType * GetAsITKBaseType( void ) const
87  {
88  return dynamic_cast< const ITKBaseType * >( this );
89  }
90 
91 
93  virtual void SetCurrentPositionPublic( const ParametersType & param );
94 
98  virtual void BeforeEachResolutionBase() ITK_OVERRIDE;
99 
103  virtual void AfterRegistrationBase( void ) ITK_OVERRIDE;
104 
108  virtual void SetSinusScales( double amplitude, double frequency,
109  unsigned long numberOfParameters );
110 
111 protected:
112 
116  virtual ~OptimizerBase() {}
117 
121  virtual void SelectNewSamples( void );
122 
124  virtual bool GetNewSamplesEveryIteration( void ) const;
125 
126 private:
127 
129  OptimizerBase( const Self & ); // purposely not implemented
131  void operator=( const Self & ); // purposely not implemented
132 
137 
138 };
139 
140 } // end namespace elastix
141 
142 #ifndef ITK_MANUAL_INSTANTIATION
143 #include "elxOptimizerBase.hxx"
144 #endif
145 
146 #endif // end #ifndef __elxOptimizerBase_h
elastix::OptimizerBase::m_NewSamplesEveryIteration
bool m_NewSamplesEveryIteration
Definition: elxOptimizerBase.h:136
elastix::OptimizerBase::RegistrationPointer
Superclass::RegistrationPointer RegistrationPointer
Definition: elxOptimizerBase.h:70
elastix::OptimizerBase::GetAsITKBaseType
virtual const ITKBaseType * GetAsITKBaseType(void) const
Definition: elxOptimizerBase.h:86
elastix::OptimizerBase::BeforeEachResolutionBase
virtual void BeforeEachResolutionBase() ITK_OVERRIDE
elastix::OptimizerBase::Self
OptimizerBase Self
Definition: elxOptimizerBase.h:58
elastix::OptimizerBase::RegistrationType
Superclass::RegistrationType RegistrationType
Definition: elxOptimizerBase.h:69
elastix::OptimizerBase::ConfigurationPointer
Superclass::ConfigurationPointer ConfigurationPointer
Definition: elxOptimizerBase.h:68
elastix::BaseComponentSE::RegistrationPointer
RegistrationType * RegistrationPointer
Definition: elxBaseComponentSE.h:63
elastix::BaseComponentSE::ElastixType
TElastix ElastixType
Definition: elxBaseComponentSE.h:52
elastix::BaseComponentSE::ConfigurationPointer
ElastixType::ConfigurationPointer ConfigurationPointer
Definition: elxBaseComponentSE.h:57
elastix::BaseComponentSE
The BaseComponentSE class is a base class for elastix components that provides some basic functionali...
Definition: elxBaseComponentSE.h:44
elastix::OptimizerBase::SetSinusScales
virtual void SetSinusScales(double amplitude, double frequency, unsigned long numberOfParameters)
elastix::OptimizerBase::GetNewSamplesEveryIteration
virtual bool GetNewSamplesEveryIteration(void) const
elastix::OptimizerBase::operator=
void operator=(const Self &)
elxBaseComponentSE.h
elastix::OptimizerBase
This class is the elastix base class for all Optimizers.
Definition: elxOptimizerBase.h:54
elastix::OptimizerBase::ConfigurationType
Superclass::ConfigurationType ConfigurationType
Definition: elxOptimizerBase.h:67
elastix::OptimizerBase::GetAsITKBaseType
virtual ITKBaseType * GetAsITKBaseType(void)
Definition: elxOptimizerBase.h:79
elastix::OptimizerBase::Superclass
BaseComponentSE< TElastix > Superclass
Definition: elxOptimizerBase.h:59
elastix::OptimizerBase::ElastixPointer
Superclass::ElastixPointer ElastixPointer
Definition: elxOptimizerBase.h:66
elastix::OptimizerBase::ParametersType
ITKBaseType::ParametersType ParametersType
Definition: elxOptimizerBase.h:76
elastix::BaseComponentSE::ElastixPointer
itk::WeakPointer< ElastixType > ElastixPointer
Definition: elxBaseComponentSE.h:53
elastix::OptimizerBase::SetCurrentPositionPublic
virtual void SetCurrentPositionPublic(const ParametersType &param)
elastix::OptimizerBase::OptimizerBase
OptimizerBase(const Self &)
elastix::OptimizerBase::SelectNewSamples
virtual void SelectNewSamples(void)
elastix::OptimizerBase::ITKBaseType
itk::Optimizer ITKBaseType
Definition: elxOptimizerBase.h:73
elxMacro.h
elastix::BaseComponentSE::ConfigurationType
ElastixType::ConfigurationType ConfigurationType
Definition: elxBaseComponentSE.h:56
elastix::OptimizerBase::AfterRegistrationBase
virtual void AfterRegistrationBase(void) ITK_OVERRIDE
elastix::OptimizerBase::ElastixType
Superclass::ElastixType ElastixType
Definition: elxOptimizerBase.h:62
elastix
Definition: elxFixedGenericPyramid.h:25
elastix::BaseComponentSE::RegistrationType
ElastixType::RegistrationBaseType RegistrationType
Definition: elxBaseComponentSE.h:62


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo