mrumtl

commit ef5e5669e9e765c0b6079f25735de493cf802785
parent 473baa188a9ac9f40ea4935760b37f5b61fc3bb2
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Fri,  8 Jul 2022 12:02:04 +0200

Update the man page

Diffstat:
M
doc/mrumtl.5.scd
 | 
51
+++++++++++++++++++++++++++------------------------

1 file changed, 27 insertions(+), 24 deletions(-)
diff --git a/doc/mrumtl.5.scd b/doc/mrumtl.5.scd
@@ -21,48 +21,51 @@ mrumtl - ModRadUrb MaTeriaL file format
 
 # DESCRIPTION
 
-A *mrumtl* file defines a spectral varying Bidirectional Reflectance
-Distribution Function (BRDF). Both the parameters and the type of the function
-can vary over the spectrum. These data can be defined for a list of
-wavelengths or for a set a spectral bands. In both cases, the wavelengths or
-the band boundaries are given in nanometers and must be listed in ascending
-orders. In addition the spectral bands must not overlapped.
+*mrumtl* is a text file format that describes a Bidirectional Reflectance
+Distribution Function (BRDF) whose type and parameters can vary spectrally. Its
+data are described for a set of wavelengths or spectral bands that must be
+listed in ascending order.
 
-Characters behind the hash mark (#) are considered as comments and are thus
-ignored. Empty lines, i.e. lines without any characters or composed only of
-spaces and tabulations, are simply skipped.
+Characters behind the hash mark (#) are considered comments and are therefore
+ignored, as well as empty lines, i.e. lines without any characters or composed
+only of spaces and tabs.
 
 # GRAMMAR
 
 ```
-<mrumtl>            ::= <BRDF-list-wlen>
-                      | <BRDF-list-band>
+<mrumtl>            ::= <per-wlen-BRDF>
+                      | <per-band-BRDF>
 
-<BRDF-list-wlen>    ::= wavelengths <wavelengths-count>
-                        <BRDF-wlen>
-                      [ <BRDF-wlen> ... ]
+---
 
-<BRDF-list-band>    ::= bands <bands-count>
-                        <BRDF-band>
-                      [ <BRDF-band> ... ]
+<per-wlen-BRDF>     ::= wavelengths <wavelengths-count>
+                        <wlen-BRDF>
+                      [ <wlen-BRDF> ... ]
 
+<wlen-BRDF>         ::= <wavelength> <BRDF>
 <wavelengths-count> ::= INTEGER
-<bands-count>       ::= INTEGER
+<wavelength>        ::= REAL # in nanometer
 
-<BRDF-wlen>         ::= <wavelength> <BRDF>
+---
 
-<BRDF-band>         ::= <band-bound-min> <band-bound-max> <BRDF>
-<bound-bound-min>   ::= <wavelength>
-<bound-bound-max>   ::= <wavelength>
+<per-band-BRDF>     ::= bands <bands-count>
+                        <band-BRDF>
+                      [ <band-BRDF> ... ]
 
-<wavelength>        ::= REAL # in nanometer
+<band-BRDF>         ::= <wavelength-min> <wavelength-max> <BRDF>
+
+<bands-count>       ::= INTEGER
+<wavelength-min>    ::= REAL # Inclusive bound in nanometers
+<wavelength-max>    ::= REAL # Inclusive bound in nanometers
+
+---
 
 <BRDF>              ::= <BRDF-lambertian>
                       | <BRDF-specular>
 
 <BRDF-lambertian>   ::= lambertian <reflectivity>
 <BRDF-specular>     ::= specular <reflectivity>
-<reflectivity>      ::= REAL
+<reflectivity>      ::= REAL # In [0, 1]
 ```
 
 # EXAMPLES