itkLineSearchOptimizer.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 __itkLineSearchOptimizer_h
#define __itkLineSearchOptimizer_h
 
#include "itkSingleValuedNonLinearOptimizer.h"
 
#include "itkIntTypes.h" //tmp
 
namespace itk
{
 
class LineSearchOptimizer : public SingleValuedNonLinearOptimizer
{
public:
 
  typedef LineSearchOptimizer            Self;
  typedef SingleValuedNonLinearOptimizer Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;
 
  //itkNewMacro(Self); because this is an abstract base class.
  itkTypeMacro( LineSearchOptimizer, SingleValuedNonLinearOptimizer );
 
  typedef Superclass::MeasureType      MeasureType;
  typedef Superclass::ParametersType   ParametersType;
  typedef Superclass::DerivativeType   DerivativeType;
  typedef Superclass::CostFunctionType CostFunctionType;
 
  virtual void SetLineSearchDirection( const ParametersType & arg )
  {
    this->m_LineSearchDirection = arg;
    this->Modified();
  }
 
 
  itkGetConstReferenceMacro( LineSearchDirection, ParametersType );
 
  virtual void SetInitialDerivative(
    const DerivativeType & itkNotUsed( derivative ) ) {}
  virtual void SetInitialValue( MeasureType itkNotUsed( value ) ) {}
 
  virtual void GetCurrentValueAndDerivative(
    MeasureType & value, DerivativeType & derivative ) const = 0;
 
  virtual void GetCurrentDerivative( DerivativeType & derivative ) const = 0;
 
  virtual MeasureType GetCurrentValue( void ) const = 0;
 
  itkGetConstMacro( CurrentStepLength, double );
 
  itkSetMacro( MinimumStepLength, double );
  itkGetConstMacro( MinimumStepLength, double );
  itkSetMacro( MaximumStepLength, double );
  itkGetConstMacro( MaximumStepLength, double );
  itkSetMacro( InitialStepLengthEstimate, double );
  itkGetConstMacro( InitialStepLengthEstimate, double );
 
protected:
 
  LineSearchOptimizer();
  ~LineSearchOptimizer() override {}
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  double m_CurrentStepLength;
 
  virtual void SetCurrentStepLength( double step );
 
  double DirectionalDerivative( const DerivativeType & derivative ) const;
 
private:
 
  LineSearchOptimizer( const Self & ); // purposely not implemented
  void operator=( const Self & );      // purposely not implemented
 
  ParametersType m_LineSearchDirection;
 
  double m_MinimumStepLength;
  double m_MaximumStepLength;
  double m_InitialStepLengthEstimate;
 
};
 
} // end namespace itk
 
#endif // #ifndef __itkLineSearchOptimizer_h