Commit 419a1851 authored by Laurent Belcour's avatar Laurent Belcour

Adding documentation to build the doxygen. Adding some of the plugins into the...

Adding documentation to build the doxygen. Adding some of the plugins into the plugin group of the documentation.
parent c047f8cc
......@@ -16,3 +16,7 @@ We use heavily the Qt profile functionality. To build some of the plugins you wi
be required to create your own system dependant .prf for any used library. For example
all the rational BRDF fitters use the Eigen library. Therefore it is mandatory that you
provide a eigen.prf file and that this file is in your QMAKEFEATURES directory.
Generate the documentation using Doxygen
cd ${ALTA}/documents/
doxygen doxygen.conf
......@@ -20,8 +20,6 @@ class data ;
*
* Any function used by the fitting algorithm should overload publicly this
* interface.
*
* \todo how-to write a plugin here ?
*/
class function
{
......
......@@ -392,8 +392,9 @@ void rational_function::save_cpp(const std::string& filename, const arguments& a
}
}
file << "};" << std::endl;
file << std::endl ;
file << "// l(double x, int i) is the Legendre polynomial of order i evaluated in x" << std::endl;
file << "void brdf(double* x, double* y)" << std::endl;
file << "{" << std::endl;
file << "\tdouble p, q;" << std::endl;
......
......@@ -12,6 +12,10 @@
#include <core/args.h>
#include <core/vertical_segment.h>
/*! \brief A fitter for non-linear BRDF models that uses Eigen's
* Levenberg-Marquardt solver.
* \ingroup plugins
*/
class nonlinear_fitter_eigen: public QObject, public fitter
{
Q_OBJECT
......
......@@ -13,7 +13,13 @@
#include <core/fitter.h>
#include <core/args.h>
/*! \brief A fitter for rational functions that can run in parallel
* using QuadProg++ quadratic solver.
* \ingroup plugins
*
* \details
* You can find QuadProg++ here: http://quadprog.sourceforge.net/
*/
class rational_fitter_parallel : public QObject, public fitter
{
Q_OBJECT
......
......@@ -13,12 +13,8 @@
#include <core/fitter.h>
#include <core/args.h>
/*! \todo This plugin is not working with 1D example. This is weird. Use the following command
* to generate the bug:
\verbatim
./build/plugin_loader --input ../data/1d/transmi_lame_50_50_avg45.txt --output output.rational --fitter librational_fitter_quadprog.so --min 400 --max 500 --min-np 1 --min-nq 1 --np 20 --nq 20 --dt 0.01
\endverbatim
It should freeze after np = 6 and nq = 6
/*! \brief A rational fitter using the library QuadProg++
* You can find the library here: http://quadprog.sourceforge.net/
*/
class rational_fitter_quadprog : public QObject, public fitter
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment