itkRSGDEachParameterApartBaseOptimizer.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 itkRSGDEachParameterApartBaseOptimizer_h
#define itkRSGDEachParameterApartBaseOptimizer_h
 
#include "itkSingleValuedNonLinearOptimizer.h"
 
namespace itk
{
 
class RSGDEachParameterApartBaseOptimizer : public SingleValuedNonLinearOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RSGDEachParameterApartBaseOptimizer);
 
  using Self = RSGDEachParameterApartBaseOptimizer;
  using Superclass = SingleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(RSGDEachParameterApartBaseOptimizer, SingleValuedNonLinearOptimizer);
 
  enum StopConditionType
  {
    GradientMagnitudeTolerance = 1,
    StepTooSmall,
    ImageNotAvailable,
    SamplesNotAvailable,
    MaximumNumberOfIterations,
    MetricError
  };
 
  itkSetMacro(Maximize, bool);
  itkGetConstMacro(Maximize, bool);
  itkBooleanMacro(Maximize);
  bool
  GetMinimize() const
  {
    return !m_Maximize;
  }
  void
  SetMinimize(bool v)
  {
    this->SetMaximize(!v);
  }
  void
  MinimizeOn()
  {
    SetMaximize(false);
  }
  void
  MinimizeOff()
  {
    SetMaximize(true);
  }
 
  void
  StartOptimization() override;
 
  void
  ResumeOptimization();
 
  void
  StopOptimization();
 
  itkSetMacro(MaximumStepLength, double);
  itkSetMacro(MinimumStepLength, double);
  itkSetMacro(NumberOfIterations, unsigned long);
  itkSetMacro(GradientMagnitudeTolerance, double);
  itkGetConstMacro(MaximumStepLength, double);
  itkGetConstMacro(MinimumStepLength, double);
  itkGetConstMacro(NumberOfIterations, unsigned long);
  itkGetConstMacro(GradientMagnitudeTolerance, double);
  itkGetConstMacro(CurrentIteration, unsigned long);
  itkGetConstMacro(StopCondition, StopConditionType);
  itkGetConstMacro(Value, MeasureType);
  itkGetConstReferenceMacro(Gradient, DerivativeType);
 
  itkGetConstReferenceMacro(CurrentStepLengths, DerivativeType);
 
  itkGetConstMacro(CurrentStepLength, double);
 
  itkGetConstMacro(GradientMagnitude, double);
 
protected:
  RSGDEachParameterApartBaseOptimizer();
  ~RSGDEachParameterApartBaseOptimizer() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  virtual void
  AdvanceOneStep();
 
  virtual void
  StepAlongGradient(const DerivativeType &, const DerivativeType &)
  {
    ExceptionObject ex;
    ex.SetLocation(__FILE__);
    ex.SetDescription("This method MUST be overloaded in derived classes");
    throw ex;
  }
 
 
private:
  DerivativeType m_Gradient{};
  DerivativeType m_PreviousGradient{};
 
  bool        m_Stop{ false };
  bool        m_Maximize{ false };
  MeasureType m_Value{ 0.0 };
  double      m_GradientMagnitudeTolerance{ 1e-4 };
  double      m_MaximumStepLength{ 1.0 };
  double      m_MinimumStepLength{ 1e-3 };
 
  DerivativeType m_CurrentStepLengths{};
  double m_CurrentStepLength{ 0 };
 
  StopConditionType m_StopCondition{ MaximumNumberOfIterations };
  unsigned long     m_NumberOfIterations{ 100 };
  unsigned long     m_CurrentIteration{ 0 };
 
  double m_GradientMagnitude{ 0.0 };
};
 
} // end namespace itk
 
#endif // end #ifndef itkRSGDEachParameterApartBaseOptimizer_h