itkOptimizer.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkOptimizer.h,v $
  Language:  C++
  Date:      $Date: 2009-06-24 12:02:54 $
  Version:   $Revision: 1.39 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 __itkOptimizer_h
#define __itkOptimizer_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkExceptionObject.h"
#include "itkArray.h"


namespace itk
{
  
class ITK_EXPORT Optimizer : public Object 
{
public:
  typedef Optimizer                 Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(Optimizer, Object);

  typedef Array<double>             ParametersType;

  typedef Array<double>             ScalesType;

  virtual void SetInitialPosition( const ParametersType & param );

  itkGetConstReferenceMacro(InitialPosition, ParametersType);

  void SetScales(const ScalesType & scales);

  itkGetConstReferenceMacro( Scales, ScalesType );

  itkGetConstReferenceMacro( CurrentPosition, ParametersType );

  virtual void StartOptimization() {};

  virtual const std::string GetStopConditionDescription() const;

protected:
  Optimizer();
  virtual ~Optimizer() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual void SetCurrentPosition( const ParametersType & param );

  bool                    m_ScalesInitialized;

  // Keep m_CurrentPosition as a protected var so that subclasses can
  // have fast access.  This is important when optimizing high-dimensional
  // spaces, e.g. bspline transforms.
  ParametersType          m_CurrentPosition;

private:
  Optimizer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  ParametersType          m_InitialPosition;
  ScalesType              m_Scales;
};

} // end namespace itk


#endif