OxModel.h

Go to the documentation of this file.

#ifndef Tomato_OxModel_H
#define Tomato_OxModel_H

#include "tomatolib_export.h"
#include <string>

namespace Ox {

    template< typename MeasureType >
    class Model{

    public:

        virtual MeasureType calcModelValue(const MeasureType* parameters, MeasureType time) = 0;

        virtual void calcLSResiduals(const MeasureType* parameters, MeasureType* residuals) = 0;

        virtual MeasureType calcCostValue(const MeasureType* parameters) = 0;

        virtual void calcCostDerivative(const MeasureType* parameters, MeasureType* derivative) = 0;

        virtual void calcLSJacobian(const MeasureType* parameters, MeasureType* jacobian) = 0;

        // getters
        virtual int getNSamples() { return _nSamples; }
        virtual const MeasureType *getInvTimes() const { return _InvTimes; }
        virtual const MeasureType *getEchoTimes() const { return _EchoTimes; }
        virtual const MeasureType *getRepTimes() const { return _RepTimes; }
        virtual const MeasureType *getRelAcqTimes() const { return _RelAcqTimes; }
        virtual const MeasureType *getSignal() const { return _Signal; }
        virtual int getNDims() { return _nDims; }

        // setters
        void setNSamples(int _nSamples);
        virtual void setInvTimes(const MeasureType *_InvTimes) { Model::_InvTimes = _InvTimes; }
        virtual void setEchoTimes(const MeasureType *_EchoTimes) { Model::_EchoTimes = _EchoTimes; }
        virtual void setRepTimes(const MeasureType *_RepTimes) { Model::_RepTimes = _RepTimes; }
        virtual void setRelAcqTimes(const MeasureType *_RelAcqTimes) { Model::_RelAcqTimes = _RelAcqTimes; }
        virtual void setSignal(const MeasureType *_Signal) { Model::_Signal = _Signal; }

        // TODO: make abstract
        virtual std::string getNthParamName(int nthParam){return "";};

        virtual void disp();

        void setAllPointersToNull();

        Model();

        Model(const Model &old);

        virtual Model<MeasureType> *newByCloning() = 0;

        virtual ~Model();

    protected:

        const MeasureType* _InvTimes;
        const MeasureType* _EchoTimes;
        const MeasureType* _RepTimes;
        const MeasureType* _RelAcqTimes;
        const MeasureType* _Signal;
        int _nSamples;
        int _nDims;

        // helper variables
        MeasureType* _Residuals;
    };
} //namespace Ox

#ifndef TOMATOLIB_COMPILED
#include "OxModel.hxx"
#endif //TOMATOLIB_COMPILED

#endif //Tomato_OxModel_H