itkOptimizer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkOptimizer_h
#define itkOptimizer_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkArray.h"
#include "itkOptimizerParameters.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
class ITKOptimizers_EXPORT Optimizer : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Optimizer);

  using Self = Optimizer;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(Optimizer);

  using ParametersType = OptimizerParameters<double>;

  using ScalesType = Array<double>;

  virtual void
  SetInitialPosition(const ParametersType & param);

  itkGetConstReferenceMacro(InitialPosition, ParametersType);

  void
  SetScales(const ScalesType & scales);

  itkGetConstReferenceMacro(Scales, ScalesType);
  itkGetConstReferenceMacro(InverseScales, ScalesType);

  itkGetConstReferenceMacro(CurrentPosition, ParametersType);

  virtual void
  StartOptimization()
  {}

  virtual std::string
  GetStopConditionDescription() const;
 
protected:
  Optimizer();
  ~Optimizer() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual void
  SetCurrentPosition(const ParametersType & param);
 
  bool m_ScalesInitialized{ false };
 
  // Keep m_CurrentPosition as a protected var so that subclasses can
  // have fast access.  This is important when optimizing high-dimensional
  // spaces, e.g. bspline transforms.
  ParametersType m_CurrentPosition{};
 
private:
  ParametersType m_InitialPosition{};
  ScalesType     m_Scales{};
  ScalesType     m_InverseScales{};
};
} // end namespace itk
 
#endif