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 <typename TElastix>
class ITK_TEMPLATE_EXPORT OptimizerBase : public BaseComponentSE<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OptimizerBase);

  using Self = OptimizerBase;
  using Superclass = BaseComponentSE<TElastix>;

  itkOverrideGetNameOfClassMacro(OptimizerBase);

  using typename Superclass::ElastixType;
  using typename Superclass::RegistrationType;

  using ITKBaseType = itk::Optimizer;

  using ParametersType = typename ITKBaseType::ParametersType;

  ITKBaseType *
  GetAsITKBaseType()
  {
    return &(this->GetSelf());
  }
 

  const ITKBaseType *
  GetAsITKBaseType() const
  {
    return &(this->GetSelf());
  }
 

  virtual void
  SetCurrentPositionPublic(const ParametersType & param);

  void
  BeforeEachResolutionBase() override;

  void
  AfterRegistrationBase() override;

  virtual void
  SetSinusScales(double amplitude, double frequency, unsigned long numberOfParameters);
 
protected:
  OptimizerBase() = default;
  ~OptimizerBase() override = default;

  virtual void
  SelectNewSamples();

  virtual bool
  GetNewSamplesEveryIteration() const;
 
  struct SettingsType
  {
    double a, A, alpha, fmax, fmin, omega;
  };
  using SettingsVectorType = typename std::vector<SettingsType>;

  static void
  PrintSettingsVector(const SettingsVectorType & settings);
 
private:
  elxDeclarePureVirtualGetSelfMacro(ITKBaseType);

  bool m_NewSamplesEveryIteration{ false };
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxOptimizerBase.hxx"
#endif
 
#endif // end #ifndef elxOptimizerBase_h