Fit.h

Go to the documentation of this file.

/***************************************************************************
    File                 : Fit.h
    Project              : SciDAVis
    --------------------------------------------------------------------
    Copyright            : (C) 2006 by Ion Vasilief, Tilman Benkert
    Email (use @ for *)  : ion_vasilief*yahoo.fr, thzs*gmx.net
    Description          : Fit base class
                           
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *  This program is free software; you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor,                    *
 *   Boston, MA  02110-1301  USA                                           *
 *                                                                         *
 ***************************************************************************/
#ifndef FIT_H
#define FIT_H

#include <QObject>

#include "Filter.h"
#include "Script.h"

#include <gsl/gsl_multifit_nlin.h>
#include <gsl/gsl_multimin.h>

class Table;
class Matrix;
class ApplicationWindow;
class Script;

class Fit : public Filter, public scripted
{
    Q_OBJECT

    public:

        typedef double (*fit_function_simplex)(const gsl_vector *, void *);
        typedef int (*fit_function)(const gsl_vector *, void *, gsl_vector *);
        typedef int (*fit_function_df)(const gsl_vector *, void *, gsl_matrix *);
        typedef int (*fit_function_fdf)(const gsl_vector *, void *, gsl_vector *, gsl_matrix *);

        enum Algorithm{ScaledLevenbergMarquardt, UnscaledLevenbergMarquardt, NelderMeadSimplex};
        enum ErrorSource {UnknownErrors, AssociatedErrors, PoissonErrors, CustomErrors};

        Fit(ApplicationWindow *parent, Graph *g = 0, const char * name = 0);
        ~Fit();

        virtual void fit();

        bool setYErrorSource(ErrorSource err, const QString& colName = QString::null, bool fail_silently=false);

        void setDataCurve(int curve, double start, double end);

        QString formula(){return d_formula;};
        int numParameters() {return d_p;}

        void setInitialGuess(int parIndex, double val){gsl_vector_set(d_param_init, parIndex, val);};
        void setInitialGuesses(double *x_init);

        virtual void guessInitialValues(){};

        void setAlgorithm(Algorithm s){d_solver = s;};

        void generateFunction(bool yes, int points = 100);

        virtual QString legendInfo();

        double* results(){return d_results;};

        double* errors();

        double chiSquare() {return chi_2;};

        double rSquare();

        void scaleErrors(bool yes = true){d_scale_errors = yes;};

        Table* parametersTable(const QString& tableName);
        Matrix* covarianceMatrix(const QString& matrixName);

                int evaluate_f(const gsl_vector * x, gsl_vector * f);
                double evaluate_d(const gsl_vector * x);
                int evaluate_df(const gsl_vector *x, gsl_matrix *J);
                static double evaluate_df_helper(double x, void * param);

        protected slots:
                void scriptError(const QString& message,const QString& script_name,int line_number);

    private:
        double * fitGslMultimin(int &iterations, int &status);

        double * fitGslMultifit(int &iterations, int &status);

        virtual void storeCustomFitResults(double *par);

    protected:
        void insertFitFunctionCurve(const QString& name, double *x, double *y, int penWidth = 1);

        virtual void generateFitCurve(double *par);

        virtual void calculateFitCurveData(double *par, double *X, double *Y) { Q_UNUSED(par) Q_UNUSED(X) Q_UNUSED(Y)   };

        virtual QString logFitInfo(double *par, int iterations, int status, const QString& plotName);

        fit_function d_f;
        fit_function_df d_df;
        fit_function_fdf d_fdf;
        fit_function_simplex d_fsimplex;

        int d_p;

        gsl_vector *d_param_init;

        bool is_non_linear;

        double *d_y_errors;

        QStringList d_param_names;

        QStringList d_param_explain;

        bool d_gen_function;

        Algorithm d_solver;

        QString d_formula;

        gsl_matrix *covar;

        ErrorSource d_y_error_source;

        QString d_y_error_dataset;

        double *d_results;

        double *d_result_errors;

        double chi_2;

        bool d_scale_errors;

                Script * d_script;
};

#endif