Commit 969d2280 authored by Laurent Belcour's avatar Laurent Belcour
Browse files

Updating the documentation.

parent 965a5e29
......@@ -5,8 +5,8 @@ Here are the names, affiliations, and mails of people involved in ALTA. Please
do not hesitate to share your experience of using this library, bug reports,
or feature requests.<br />
<ul>
<li><a href="mailto:laurent.belcour@inria.fr">Laurent Belcour</a></li>
<li><a href="mailto:romain.pacanowski@inria.fr">Romain Pacanowski</a></li>
<li><a href="mailto:xavier.granier@inria.fr">Xavier Granier</a></li>
<li><a href="mailto:laurent.belcour@inria.fr">Laurent Belcour</a>, Inria</li>
<li><a href="mailto:romain.pacanowski@inria.fr">Romain Pacanowski</a>, CNRS</li>
<li><a href="mailto:xavier.granier@inria.fr">Xavier Granier</a>, LP2N</li>
</ul>
*/
......@@ -2,48 +2,12 @@
\page contribute Contribute
You can contribute and expand ALTA by providing new plugins. The three kind
of plugins (function, data and fitter) can be provided. Examples of such
plugins can be found in the $ALTA/sources/plugins directory.
of plugins (\ref function, \ref data and \ref fitter) can be provided.
Examples of such plugins can be found in the $ALTA/sources/plugins
directory.
<h2>Fitter: an example</h2>
You have to inherit from the fitter and the QObject interfaces. It will
be required that you implement the pure virtual functions. The call to
Q_OBJECT and Q_INTERFACES(fitter) macros is manatory.
\code
#pragma once
// Interface
#include <QObject>
#include <core/args.h>
#include <core/function.h>
class my_fitter : public QObject, public fitter
{
Q_OBJECT
Q_INTERFACES(fitter)
public: // methods
rational_fitter_eigen() ;
virtual ~rational_fitter_eigen() ;
// Fitting a data object
//
virtual bool fit_data(const data* d, function* fit) ;
// Provide user parameters to the fitter
//
virtual void set_parameters(const arguments& args) ;
// Obtain associated data and functions
//
virtual data* provide_data() const ;
virtual function* provide_function() const ;
} ;
\endcode
\todo Add other example on data and function
<center style="color:red">
Work in progress
</center>
*/
/**
\page install Install
How to install the various components
<h1>Qmake</h1>
How to install the various components using <b>qmake</b>.
<h2>Requirement</h2>
<ul>
<li>Qt library with qmake</li>
<li>Eigen library (for some plugins)</li>
<li>qmake</li>
<li>Eigen library (for core and plugins)</li>
<li>Quadprog library (provided in external)</li>
<li>Matlab with the Engine library (for some plugins)</li>
<li>CGAL library (for some plugins)</li>
</ul>
<h2>.prf files</h2>
Qt rely on user specified .prf files to look for external libraries.
.prf files describe where to find libraries' headers and shared objects
in a qmake fashion. Here is an example for the <i>quadprog.prf</i> file:
\verbatim
INCLUDEPATH += ~/Projects/alta/external/quadprog++
LIBS += -L~/Projects/alta/build -lquadprog++
\endverbatim
You need to set the environment variable QMAKEFEATURES to the directory
where you will be storing your .prf files. If you are not familiar with
this process, we advise to store your .prf files in the external directory
of ALTA.
<h2>Installation</h2>
Once you have the required libraries, the installation of the fitting
......@@ -23,4 +43,14 @@ $ qmake && make
All the resulting elements (binaries, dynamic and static libraries)
are outputed in: <em>$ALTA/sources/build</em> directory.
<br />
<h1>Scons</h1>
<center style="color:red">
Work in progress
</center>
<br />
*/
/*! \package data2brdf
* \ingroup commands
* \brief
* This command allows to convert a \ref data object to a \ref function object.
* This command allows to convert a \ref data object to a \ref function
* object.
* \details
*
* Note, each plugin you load can have its own list of arguments. They
* are not listed here. Please refer to the documentation of the plugin
* to know how to fine tune it.
*
* <h3>Parameters</h3>
* <ul>
* <li><b>\-\-input <i>filename</i></b> data file to be loaded uwing the data
* plugin specified by the <b>\-\-data <i>filename</i></b> option. If no
* plugin is specified, the data file will be loaded using a \ref
* vertical_segment data object.</li>
* <li><b>\-\-help</b> print the help and exit.
* <li><b>\-\-input <i>filename</i></b> data file to be loaded using
* the data plugin specified by the <b>\-\-data <i>filename</i></b>
* option. If no plugin is specified, the data file will be loaded
* using a \ref vertical_segment data object.</li>
* <li><b>\-\-output <i>filename</i></b> function file to be exported
* in the format specified by <b>\-\-export</b>. If no export argument
* is given, the function will be exported in ALTA \ref format.
* </ul>
*
* <h3>Plugins</h3>
* <ul>
* <li><b>\-\-fitter <i>plugin.lib</i></b> \ref fitter library to be used.
* Note that the fitter plugin must be compatible with the \a function
* to be used. We make the convention that the filename of the plugin
* expose its compatibility. For example,
* <i>rational_function_legendre.lib</i> expose a rational function,
* compatible with a rational fitter and will not be compatible with
* nonlinear fitters.
* <li><b>\-\-data <i>plugin.lib</i></b> \ref data library to be used.
* <li><b>\-\-func <i>plugin.lib</i></b> \ref function library to be
* used.
* </ul>
*/
#include <core/args.h>
......
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