elxOptimizerBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
 
#ifndef __elxOptimizerBase_h
#define __elxOptimizerBase_h
 
#include "elxMacro.h"
 
#include "elxBaseComponentSE.h"
#include "itkOptimizer.h"
 
namespace elastix
{
 
template< class TElastix >
class OptimizerBase : public BaseComponentSE< TElastix >
{
public:
 
  typedef OptimizerBase               Self;
  typedef BaseComponentSE< TElastix > Superclass;
 
  itkTypeMacro( OptimizerBase, BaseComponentSE );
 
  typedef typename Superclass::ElastixType          ElastixType;
  typedef typename Superclass::ElastixPointer       ElastixPointer;
  typedef typename Superclass::ConfigurationType    ConfigurationType;
  typedef typename Superclass::ConfigurationPointer ConfigurationPointer;
  typedef typename Superclass::RegistrationType     RegistrationType;
  typedef typename Superclass::RegistrationPointer  RegistrationPointer;
 
  typedef itk::Optimizer ITKBaseType;
 
  typedef typename ITKBaseType::ParametersType ParametersType;
 
  virtual ITKBaseType * GetAsITKBaseType( void )
  {
    return dynamic_cast< ITKBaseType * >( this );
  }
 
 
  virtual const ITKBaseType * GetAsITKBaseType( void ) const
  {
    return dynamic_cast< const ITKBaseType * >( this );
  }
 
 
  virtual void SetCurrentPositionPublic( const ParametersType & param );
 
  void BeforeEachResolutionBase() override;
 
  void AfterRegistrationBase( void ) override;
 
  virtual void SetSinusScales( double amplitude, double frequency,
    unsigned long numberOfParameters );
 
protected:
 
  OptimizerBase();
  ~OptimizerBase() override {}
 
  virtual void SelectNewSamples( void );
 
  virtual bool GetNewSamplesEveryIteration( void ) const;
 
private:
 
  OptimizerBase( const Self & );   // purposely not implemented
  void operator=( const Self & );  // purposely not implemented
 
  bool m_NewSamplesEveryIteration;
 
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "elxOptimizerBase.hxx"
#endif
 
#endif // end #ifndef __elxOptimizerBase_h