Commit 559bd70b authored by Laurent Belcour's avatar Laurent Belcour Committed by Ludovic Courtès

[Doc] Missing */ in data-formats and separation of format in pages.

parent ba2a3011
/*!
\page dataformats Data File Formats
\page data-formats Data File Formats
ALTA usually takes as input material reflectance measurements. While
ALTA plug-ins can support arbitrary file formats, ALTA has built-in
......@@ -85,3 +85,4 @@ This simple binary format was designed with two goals in mind: providing
a compact way to store large input data, and allowing implementations to
directly map the file in memory, as opposed to having to allocate
storage and parse large sequences of numbers.
*/
\ No newline at end of file
......@@ -13,14 +13,9 @@ ALTA provides two programming APIs. At the lowest level, it is possible to autho
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"
#### Data formats
The \ref data-formats "Data Formats" section describes the data formats
ALTA uses to store data.
+ \ref data-formats "Data file format"
+ \ref func-format "Function file format"
+ \ref xml-format "XML scripting format"
#### BRDF Related Documents
......
......@@ -31,7 +31,7 @@ Parametrization format
- `#PARAM_IN input_parametrization_name`
- `#PARAM_OUT output_parametrization_name`
Input Parametrization
---------------------
......@@ -45,14 +45,14 @@ input parametrizations.
Output Parametrization
----------------------
In the current version of ALTA, we cannot handle different output
In the current version of ALTA, we cannot handle different output
parametrizations (like LAB color space). Fitting will be performed
independantly of the data and function output space. They only need
to match in size.
\verbatim
INV_STERADIAN, // A BRDF which unit is sr^{-1}
INV_STERADIAN_COSINE_FACTOR, // A BRDF multiplied by the cosine factor, unit is still sr^{-1}
INV_STERADIAN_COSINE_FACTOR, // A BRDF multiplied by the cosine factor, unit is still sr^{-1}
\endverbatim
......@@ -62,7 +62,7 @@ For a text data file with <em>n</em> data entries where the input domain has <em
\verbatim
#ALTA DATA HEADER
#DIM N P
#DIM N P
#PARAM_IN %input_param%
#PARAM_OUT %output_param%
#VS [0|1|2] (P times)
......@@ -79,17 +79,17 @@ sample has a radius associated for the associated dimension. If VS is
2, each sample has a min and max segment value for the associated
dimension.
<h2>Function file format</h2>
\page func-format Function file format
ALTA library assumes that all functions are exported using the following convention:
<ul>
<li>The *.function file is outputed in plain text and not in binary.</li>
<li>The *.function file starts with a header. Each line of the header
<li>The *.function file starts with a header. Each line of the header
starts with the character '#'.</li>
<li>The header contains the command line used to create the function
in a <em>#CMD ...</em> line.
......@@ -109,10 +109,10 @@ Example of a *.function file for a single Lafortune lobe without any diffuse:
#FUNC lafortune
Cx 1.0
Cz 1.0
N 10.0
N 10.0
\endverbatim
For multiple BRDFs lobes (when you want to add a diffuse for example), you need to
For multiple BRDFs lobes (when you want to add a diffuse for example), you need to
specify it into the command line. The different parameters are outputed sequentially
into the file:
\verbatim
......@@ -123,7 +123,7 @@ into the file:
#PARAM_OUT RGB_COLOR
#ALTA_HEADER_END
#FUNC diffuse
#FUNC diffuse
kd 1.0
kd 0.02
kd 0.1We advise to output function file into <em>.function</em> file for consistency.
......@@ -131,21 +131,21 @@ into the file:
#FUNC lafortune
Cx 1.0
Cz 1.0
N 10.0
N 10.0
Cx 1.0
Cz 1.0
N 10.0
N 10.0
Cx 1.0
Cz 1.0
N 10.0
N 10.0
#FUNC phong
ks 1.0
N 10.0
N 10.0
ks 1.0
N 10.0
N 10.0
ks 1.0
N 10.0
N 10.0
#FUNC schlick
R 1.0
......@@ -156,11 +156,11 @@ into the file:
\todo Right now the different color channels have the same length !
<h2>XML scripts</h2>
\page xml-format XML scripts
You can create XML formated files to run ALTA complex commands. A python
script <em>xml_cmd.py</em> is available in the directory <em>scripts</em>.
You can use it with the following command: <em>./scripts/xml_cmd.py
You can use it with the following command: <em>./scripts/xml_cmd.py
file.xml</em>
We provide an example XML file that is self describing:
......@@ -192,20 +192,20 @@ We provide an example XML file that is self describing:
<!-- Fitting parameters -->
<parameter name="max" value="[0.8, 0.8]" />
</action>
<!-- Convert the fit to BRDF explorer format -->
<action name="brdf2brdf">
<!-- Input and output arguments of the action -->
<input name="./results/blue-metallic-paint-2lafortune.brdf" />
<output name="./results/blue-metallic-paint-2lafortune_explorer.brdf" />
<parameter name="export" value="explorer" />
</action>
<!-- Export the fit -->
<action name="brdf2gnuplot">
<!-- Input and output arguments of the action -->
<input name="./results/blue-metallic-paint-2lafortune.brdf" />
<output name="./results/blue-metallic-paint-2lafortune.dat" />
......
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