freVnlSetupOptimizationOptimizer.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freVnlSetupOptimizationOptimizer.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freVnlSetupOptimizationOptimizer_h
#define __freVnlSetupOptimizationOptimizer_h

#include "freSetupOptimizationOptimizer.h"
#include "freSingleValuedVnlSOMetricAdaptor.h"

namespace FREE
{
  
class ITK_EXPORT VnlSetupOptimizationOptimizer : 
        public SetupOptimizationOptimizer
{
public:
  typedef VnlSetupOptimizationOptimizer                               Self;
  typedef SetupOptimizationOptimizer                                                                    Superclass;
  typedef itk::SmartPointer<Self>               Pointer;
  typedef itk::SmartPointer<const Self>         ConstPointer;
  
        typedef Superclass::CostFunctionType                                    CostFunctionType;
        typedef CostFunctionType::Pointer                                                 CostFunctionPointer;

        typedef Superclass::MeasureType                                                         MeasureType;
        typedef itk::Array< double >                                                                    DerivativeType;
        typedef Superclass::DecomposedMeasureType                       DecomposedMeasureType;

  itkTypeMacro( VnlSetupOptimizationOptimizer, SetupOptimizationOptimizer );
 
        typedef itk::ReceptorMemberCommand< Self >           CommandType;

  itkGetConstReferenceMacro( Maximize, bool );
  itkSetMacro( Maximize, bool );
  itkBooleanMacro( Maximize );

  bool GetMinimize( ) const
  { return !m_Maximize; }
  void SetMinimize(bool v)
  { this->SetMaximize(!v); }
  void MinimizeOn()
  { this->MaximizeOff(); }
  void MinimizeOff()
  { this->MaximizeOn(); }

  itkGetConstReferenceMacro(CachedValue, MeasureType);
  itkGetConstReferenceMacro(CachedDerivative, DerivativeType);
  itkGetConstReferenceMacro(CachedCurrentPosition, ParametersType);

  virtual void SetCostFunction( CostFunctionType * costFunction ) = 0;

protected:
  VnlSetupOptimizationOptimizer();
  virtual ~VnlSetupOptimizationOptimizer();
        void PrintSelf(std::ostream& os, itk::Indent indent) const;

  typedef SingleValuedVnlSOMetricAdaptor   CostFunctionAdaptorType;

  void SetCostFunctionAdaptor( CostFunctionAdaptorType * adaptor );
  const CostFunctionAdaptorType * GetCostFunctionAdaptor( void ) const;
  CostFunctionAdaptorType * GetCostFunctionAdaptor( void );

  CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor( void ) const;

private:  
  VnlSetupOptimizationOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&);//purposely not implemented

  void IterationReport( const itk::EventObject & event );
  
  CostFunctionAdaptorType * m_CostFunctionAdaptor;

  bool                      m_Maximize;

        CommandType::Pointer      m_Command;

  mutable ParametersType    m_CachedCurrentPosition;
  mutable MeasureType       m_CachedValue;
  mutable DerivativeType    m_CachedDerivative;
};

} // end namespace FREE

#endif
    
 

---