documentation.dox 1.17 KB
Newer Older
1 2 3 4 5 6 7
/*!
\page documentation Documentation


<!-- This page lists all documentation related to the ALTA library. -->


8
#### APIs 
9

10
ALTA provides two programming APIs. At the lowest level, it is possible to author new \ref plugins "plugins" and \ref commands "commands" using the C++ API. At the highest level, it is possible to build Python scripts by directly manipulating plugins in this language.
11

12 13
+ \ref cpp "C++  API"
+ \ref python "Python Bindings"
14 15


16 17 18 19 20 21 22 23 24
#### File format specifications

ALTA permits to manipulate various type of files. Here, we detail: our internal data file format which can be either ASCII or binary; our function file format to store function parameters; and our XML file format to store high-level scripts.

\todo Separate the different file format

+ \ref format "Data file format"
+ \ref format "Function file format"
+ \ref format "XML scripting format"
25 26 27 28 29 30 31


#### BRDF Related Documents

+ <a href="classparams.html" >Parametrisations </a> supported in ALTA


32
#### Reference
33 34 35 36 37 38 39 40

+ List of plugin to convert data (cf. \ref datas)
+ List of plugins to fit data (cf. \ref fitters)
+ List of BRDF Models (cf. \ref functions)
+ List of provided ALTA sofwares (cf. \ref commands)


*/