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:
 
  typedef RSGDEachParameterApartBaseOptimizer Self;
  typedef SingleValuedNonLinearOptimizer      Superclass;
  typedef SmartPointer< Self >                Pointer;
  typedef SmartPointer< const Self >          ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( RSGDEachParameterApartBaseOptimizer,
    SingleValuedNonLinearOptimizer );
 
  typedef enum {
    GradientMagnitudeTolerance = 1,
    StepTooSmall,
    ImageNotAvailable,
    SamplesNotAvailable,
    MaximumNumberOfIterations,
    MetricError
  } StopConditionType;
 
  itkSetMacro( Maximize, bool );
  itkGetConstMacro( Maximize, bool );
  itkBooleanMacro( Maximize );
  bool GetMinimize() const
  { return !m_Maximize; }
  void SetMinimize( bool v )
  { this->SetMaximize( !v ); }
  void    MinimizeOn( void )
  { SetMaximize( false ); }
  void    MinimizeOff( void )
  { SetMaximize( true ); }
 
  void    StartOptimization( void ) override;
 
  void    ResumeOptimization( void );
 
  void    StopOptimization( void );
 
  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 {}
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  virtual void AdvanceOneStep( void );
 
  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:
 
  RSGDEachParameterApartBaseOptimizer( const Self & );  // purposely not implemented
  void operator=( const Self & );                       // purposely not implemented
 
protected:
 
  DerivativeType m_Gradient;
  DerivativeType m_PreviousGradient;
 
  bool        m_Stop;
  bool        m_Maximize;
  MeasureType m_Value;
  double      m_GradientMagnitudeTolerance;
  double      m_MaximumStepLength;
  double      m_MinimumStepLength;
 
  DerivativeType m_CurrentStepLengths;
  double m_CurrentStepLength;
 
  StopConditionType m_StopCondition;
  unsigned long     m_NumberOfIterations;
  unsigned long     m_CurrentIteration;
 
  double m_GradientMagnitude;
 
};
 
} // end namespace itk
 
#endif // end #ifndef __itkRSGDEachParameterApartBaseOptimizer_h