itkScaledSingleValuedNonLinearOptimizer.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 __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 );
 
  void SetCostFunction( CostFunctionType * costFunction ) override;
 
  virtual void SetUseScales( bool arg );
 
  bool GetUseScales( void ) const;
 
  itkGetConstReferenceMacro( ScaledCurrentPosition, ParametersType );
 
  const ParametersType & GetCurrentPosition( void ) const override;
 
  itkGetConstObjectMacro( ScaledCostFunction, ScaledCostFunctionType );
 
  itkBooleanMacro( Maximize );
  virtual void SetMaximize( bool _arg );
 
  itkGetConstMacro( Maximize, bool );
 
protected:
 
  ScaledSingleValuedNonLinearOptimizer();
  ~ScaledSingleValuedNonLinearOptimizer() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  ParametersType            m_ScaledCurrentPosition;
  ScaledCostFunctionPointer m_ScaledCostFunction;
 
  virtual void SetScaledCurrentPosition( const ParametersType & parameters );
 
  void  SetCurrentPosition( const ParametersType & param ) override;
 
  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