fitter.h 1.39 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
#pragma once

// Include STL
#include <vector>
#include <string>

// Interface
#include <core/function.h>
#include <core/data.h>
#include <core/fitter.h>
#include <core/args.h>
#include <core/vertical_segment.h>

14 15 16
/*! \brief A fitter for non-linear BRDF models that uses Eigen's
 *  Levenberg-Marquardt solver.
 *  \ingroup plugins
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 *
 * You will need the Eigen unsupported library (available with mercurial)
 *  <ul>
 *		<li>Eigen latest version.</li>
 *  </ul>
 *
 *  You need to provide your own eigen.prf file for qmake to generate the correct
 *  Makefile or Visual Studio solution. In particular this configuration file
 *  should provide:
 *
 *  <pre>
 *  INCLUDEPATH += [path-to-eigen-include]
 *  </pre>
 *
 *
 *  <h3>Plugin parameters</h3>
 *  <ul>
 *		<li><b>--fit-compound</b> to control how the fitting procedure is
 *		done. If this flag is set, any compound function will be decomposed
 *      during the fit. The fitting will be done incrementally. <b>in progress</b></li>
 *  </ul>
38
 */
39
class nonlinear_fitter_eigen: public fitter
40 41
{
	public: // methods
Laurent Belcour's avatar
Laurent Belcour committed
42

43 44
		nonlinear_fitter_eigen() ;
		virtual ~nonlinear_fitter_eigen() ;
Laurent Belcour's avatar
Laurent Belcour committed
45

46 47
		// Fitting a data object
		//
48
		virtual bool fit_data(const ptr<data>& d, const ptr<function>& fit, const arguments& args) ;
49 50 51 52 53 54 55 56 57 58 59

		// Provide user parameters to the fitter
		//
		virtual void set_parameters(const arguments& args) ;

	protected: // function


	protected: // data
} ;