documentation.dox 1.63 KB
 Romain Pacanowski committed Oct 16, 2015 1 2 3 /*! \page documentation Documentation  Laurent Belcour committed Oct 16, 2015 4 #### APIs  Romain Pacanowski committed Oct 16, 2015 5   Laurent Belcour committed Oct 16, 2015 6 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.  Romain Pacanowski committed Oct 16, 2015 7   Laurent Belcour committed Oct 16, 2015 8 9 + \ref cpp "C++ API" + \ref python "Python Bindings"  Romain Pacanowski committed Oct 16, 2015 10 11   Laurent Belcour committed Oct 16, 2015 12 13 14 15 16 17 18 #### 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. + \ref format "Data file format" + \ref format "Function file format" + \ref format "XML scripting format"  Romain Pacanowski committed Oct 16, 2015 19   Ludovic Courtès committed Oct 16, 2015 20 21 22 23 #### Data formats The \ref data-formats "Data Formats" section describes the data formats ALTA uses to store data.  Romain Pacanowski committed Oct 16, 2015 24 25 26  #### BRDF Related Documents  Laurent Belcour committed Oct 16, 2015 27 28 ALTA can manipulate BRDF data in different parametrization of the input space of those functions. A BRDF is defined as \f$y = \rho(\omega_i, \omega_o)\f$, where \f$\omega_i, \omega_o \in \Omega\f$ the hemisphere of directions. Multiple way to parametrize this space exist, and we implement most of them. See Parametrisations supported in ALTA for more details.  Romain Pacanowski committed Oct 16, 2015 29   Laurent Belcour committed Oct 16, 2015 30 #### References  Romain Pacanowski committed Oct 16, 2015 31   Laurent Belcour committed Oct 16, 2015 32 Below are referenced all the different plugins and softwares provided with ALTA. Documentation on how to use them is provided on the different pages.  Romain Pacanowski committed Oct 16, 2015 33 34 35 36 37 38  + 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) */