animaNLOPTOptimizers.h

Go to the documentation of this file.

#pragma once

#include <itkVector.h>
#include <itkMatrix.h>
#include <itkSingleValuedNonLinearOptimizer.h>

#include <nlopt.hpp>
#include <AnimaOptimizersExport.h>

#include <animaNLOPTParametersConstraintFunction.h>

namespace anima
{
    class ANIMAOPTIMIZERS_EXPORT NLOPTOptimizers:
        public itk::SingleValuedNonLinearOptimizer
    {
    public:

        typedef NLOPTOptimizers                Self;            
        typedef SingleValuedNonLinearOptimizer Superclass;      
        typedef itk::SmartPointer<Self>             Pointer;            
        typedef itk::SmartPointer<const Self>       ConstPointer;   
        typedef SingleValuedNonLinearOptimizer::ParametersType ParametersType; 
        typedef anima::NLOPTParametersConstraintFunction ConstraintsFunctionType; 
        itkNewMacro(Self)

        
        itkTypeMacro(NLOPTOptimizers, SingleValuedNonLinearOptimizer)

        
        typedef  itk::SingleValuedCostFunction         CostFunctionType;
        typedef  CostFunctionType::Pointer        CostFunctionPointer;

        itkSetMacro(Algorithm, nlopt_algorithm)
        itkGetConstReferenceMacro(Algorithm, nlopt_algorithm)

        itkSetMacro(ErrorCode, nlopt_result)
        itkGetConstReferenceMacro(ErrorCode, nlopt_result)

        std::string GetErrorCodeDescription() const;

        bool    isSuccessful() const;


        itkGetConstReferenceMacro(CurrentCost, MeasureType)
        MeasureType GetValue() const {return this->GetCurrentCost();}

        void SetLowerBoundParameters( const ParametersType& p );
        itkGetConstReferenceMacro(LowerBoundParameters, ParametersType)

        void SetUpperBoundParameters( const ParametersType& p );
        itkGetConstReferenceMacro(UpperBoundParameters, ParametersType)

        
        itkSetMacro(Maximize, bool)
        itkGetConstReferenceMacro(Maximize, bool)

        
        void SetStopVal(double stopval) {m_StopValSet=true; m_StopVal=stopval;}
        itkGetConstReferenceMacro(StopVal, double)

        
        itkSetMacro(FTolRel, double)
        itkGetConstReferenceMacro(FTolRel, double)

        
        itkSetMacro(FTolAbs, double)
        itkGetConstReferenceMacro(FTolAbs, double)

        
        itkSetMacro(XTolRel, double)
        itkGetConstReferenceMacro(XTolRel, double)

        
        itkSetMacro(XTolAbs, double)
        itkGetConstReferenceMacro(XTolAbs, double)

        
        itkSetMacro(MaxEval, int)
        itkGetConstReferenceMacro(MaxEval, int)

        
        itkSetMacro(MaxTime, double)
        itkGetConstReferenceMacro(MaxTime, double)
        
        
        itkSetMacro(VectorStorageSize, int)
        itkGetConstReferenceMacro(VectorStorageSize, int)
        
        
        itkSetMacro(PopulationSize, int)
        itkGetConstReferenceMacro(PopulationSize, int)
        
        
        itkSetMacro(LocalOptimizer, nlopt_algorithm)
        itkGetConstReferenceMacro(LocalOptimizer, nlopt_algorithm)

        void StartOptimization() ITK_OVERRIDE;

        void StopOptimization() {nlopt_force_stop(m_NloptOptions);}

        itkGetMacro(VerboseLevel, unsigned int)
        itkSetMacro(VerboseLevel, unsigned int)

        void AddInequalityConstraint(ConstraintsFunctionType *constraint);
        void ClearInequalityConstraints();
        void AddEqualityConstraint(ConstraintsFunctionType *constraint);
        void ClearEqualityConstraints();

    protected:
        NLOPTOptimizers();
        NLOPTOptimizers(const NLOPTOptimizers&);
        virtual ~NLOPTOptimizers();
        void PrintSelf(std::ostream& os, itk::Indent indent) const ITK_OVERRIDE;
        static double NloptFunctionWrapper(unsigned n, const double *x, double *grad, void *data);
        itkSetMacro(CurrentCost, double)

    private:
        nlopt_opt           m_NloptOptions;
        nlopt_opt           m_NloptLocalOptions;

        nlopt_algorithm     m_Algorithm;
        nlopt_algorithm     m_LocalOptimizer;

        nlopt_result        m_ErrorCode;

        ParametersType      m_LowerBoundParameters;
        ParametersType      m_UpperBoundParameters;

        bool                m_Maximize;
        bool                m_ForceStop;
        bool                m_StopValSet;
        double              m_StopVal;
        double              m_FTolRel;
        double              m_FTolAbs;
        double              m_XTolRel;
        double              m_XTolAbs;
        int                 m_MaxEval;
        double              m_MaxTime;
        int        m_VectorStorageSize;
        int        m_PopulationSize;

        unsigned int        m_VerboseLevel;

        MeasureType         m_CurrentCost;

        std::vector<ConstraintsFunctionType::Pointer> m_InequalityConstraints;
        std::vector<ConstraintsFunctionType::Pointer> m_EqualityConstraints;

    }; // end of class

} // end of namespace anima