itkScaledSingleValuedNonLinearOptimizer.h

Go to the documentation of this file.

/*======================================================================

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php for
  details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE. See the above copyright notices for more information.

======================================================================*/

#ifndef __ScaledSingleValuedNonLinearOptimizer_h
#define __ScaledSingleValuedNonLinearOptimizer_h

#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkScaledSingleValuedCostFunction.h"

namespace itk
{
class ScaledSingleValuedNonLinearOptimizer :
  public SingleValuedNonLinearOptimizer
{
public:

  typedef ScaledSingleValuedNonLinearOptimizer Self;
  typedef SingleValuedNonLinearOptimizer       Superclass;
  typedef SmartPointer< Self >                 Pointer;
  typedef SmartPointer< const Self >           ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( ScaledSingleValuedNonLinearOptimizer,
    SingleValuedNonLinearOptimizer );

  typedef Superclass::MeasureType      MeasureType;
  typedef Superclass::ParametersType   ParametersType;
  typedef Superclass::DerivativeType   DerivativeType;
  typedef Superclass::CostFunctionType CostFunctionType;

  typedef NonLinearOptimizer::ScalesType  ScalesType;
  typedef ScaledSingleValuedCostFunction  ScaledCostFunctionType;
  typedef ScaledCostFunctionType::Pointer ScaledCostFunctionPointer;

  virtual void InitializeScales( void );

  virtual void SetCostFunction( CostFunctionType * costFunction );

  virtual void SetUseScales( bool arg );

  bool GetUseScales( void ) const;

  itkGetConstReferenceMacro( ScaledCurrentPosition, ParametersType );

  virtual const ParametersType & GetCurrentPosition( void ) const;

  itkGetConstObjectMacro( ScaledCostFunction, ScaledCostFunctionType );

  itkBooleanMacro( Maximize );
  virtual void SetMaximize( bool _arg );

  itkGetConstMacro( Maximize, bool );

protected:

  ScaledSingleValuedNonLinearOptimizer();
  virtual ~ScaledSingleValuedNonLinearOptimizer() {}

  void PrintSelf( std::ostream & os, Indent indent ) const;

  ParametersType            m_ScaledCurrentPosition;
  ScaledCostFunctionPointer m_ScaledCostFunction;

  virtual void SetScaledCurrentPosition( const ParametersType & parameters );

  virtual void  SetCurrentPosition( const ParametersType & param );

  virtual MeasureType GetScaledValue(
    const ParametersType & parameters ) const;

  virtual void GetScaledDerivative(
    const ParametersType & parameters,
    DerivativeType & derivative ) const;

  virtual void GetScaledValueAndDerivative(
    const ParametersType & parameters,
    MeasureType & value,
    DerivativeType & derivative ) const;

private:

  ScaledSingleValuedNonLinearOptimizer( const Self & );   // purposely not implemented
  void operator=( const Self & );                         // purposely not implemented

  mutable ParametersType m_UnscaledCurrentPosition;
  bool                   m_Maximize;

};

} // end namespace itk

#endif //#ifndef __ScaledSingleValuedNonLinearOptimizer_h