CGeneralLinInversion.h

Go to the documentation of this file.

/* Base class for all linearized inversion methods. Contains abstract methods and
 * variables common to linearized inversion schemes. Also contains code to calculate the matrix of
 * partial derivatives, as this is needed in basically any linearized optimization method */
 
 /* Version 0.1                         Last Modified 7/11/05 */

#ifndef CGENERALLININVERSION_H_
#define CGENERALLININVERSION_H_
#include <vector>
#include <boost/numeric/ublas/vector.hpp>
#include <boost/numeric/ublas/matrix.hpp> 
#include <boost/numeric/ublas/io.hpp>
#include <exception>

#include "VecMat.h"
#include "CGeneralObjective.h"
#include "CGeneralLineSearch.h"

namespace ublas = boost::numeric::ublas;
class ConvergenceException : public std::exception {
        virtual const char* what() const throw() {return "Converged !";} 
};

class CGeneralLinInversion
{
private:
    gplib::rvec posmodel;
    gplib::rvec negmodel;
    gplib::rvec posdata;
    gplib::rvec negdata;
protected:
        unsigned int nparams;
        unsigned int ndata;
        gplib::rvec CurrentData;
        double epsilon;
public:
        CGeneralLinInversion(const unsigned int ndatapoints, const unsigned int nmodel);
        virtual ~CGeneralLinInversion();
        double CurrentRMS; // holds the RMS value at the end of the current iteration
        int Iterationnumber; // The current iteration's number
        gplib::rvec InversionResult; //The vector containing the best fitting synthetic data after the current iteration
        gplib::rvec CurrentModel;
        gplib::rvec InputData;
        gplib::rvec Gradient;
        gplib::rvec StartModel;
        gplib::rvec CurrentMisfit;
        gplib::rmat DataCovar;
        gplib::rmat ModelCovar;
        gplib::rmat PartialDerivs;
        CGeneralObjective* MisfitCalculator; //References to the objects to calculate the Misfits
        CGeneralLineSearch *LineSearch;
        void virtual CalcPartialDerivs();
        void virtual CalcGradient();
        void virtual Prepare() = 0; // Setup all matrices and vector, has to be called before first call of DoIteration() 
        void virtual DoIteration() = 0; //The purely virtual function that calculates the next iteration
};

#endif /*CGENERALLININVERSION_H_*/