commit ba3a5f0d468b78b482c7f06b5bf240dc0746ed33
parent e18fe61bb43466859c56b962aa760e1f31e680d1
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 16 Mar 2016 17:44:25 +0100
Add man page of the shiff output format
Diffstat:
| A | src/schiff-output.5 | | | 120 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 120 insertions(+), 0 deletions(-)
diff --git a/src/schiff-output.5 b/src/schiff-output.5
@@ -0,0 +1,120 @@
+.TH SCHIFF-OUTPUT 5
+.SH NAME
+schiff\-output \- format of
+.BR schiff (1)
+results
+.SH DESCRIPTION
+The output result of the
+.BR schiff (1)
+program is a collection of ASCII floating point data. The first set of floating
+point values is the list of per wavelength cross\-sections. Each line stores
+the estimated cross section of a wavelength submitted by the \fB\-w\fR option of
+.BR schiff (1).
+It is formatted as "W E e A a S s P p" with "W" the wavelength in vacumm
+(expressed in microns), "E", "A" and "S" the estimation of the extinction,
+absorption and scattering cross\-sections, respectively, and "P" the estimated
+average projected area of the micro organisms. The "e", "a", "s" and "p" values
+are the standard error of the aforementioned estimations.
+.PP
+An empty line then separates the cross\-sections from the list of per
+wavelength inverse cumulative phase functions.
+.PP
+Each inverse cumulative phase function begins by a line that describes how the
+function was computed. The format of this line is "W theta-l Ws Ws-SE Wc Wc-SE
+n" with "W" the wavelength in vacuum (expressed in microns) of the inverse
+cumulative phase function, "theta-l" the scattering angle in radians from which
+the phase function was analytically computed, "Ws" and "Wc" the values of the
+differential cross section and its cumulative for "theta-l", and "n" the
+parameter of the model used to analytically evaluate the phase function for
+wide scattering angles, i.e. angles greater than 'theta-l'. The Ws-SE and Wc-SE
+values are the standard error of the "Ws" and "Wc" estimations, respectively.
+.PP
+Following this heading line, there is the list of inverse cumulative phase
+function values, i.e. the angles in [0, PI] corresponding to a probability in
+[0, 1]. The number of these angles are controlled by the \fB\-A\fR option of
+.BR schiff (1).
+Assuming a set of N angles, the i^th angle (i in [0, N\-1]) is the angle whose
+probability is i/(N\-1).
+.PP
+The last angle of the inverse cumulative phase function is then followed by
+an empty line that separates the current inverse cumulative phase function
+from the next one.
+.PP
+Note that both the cross sections and the inverse cumulative phase functions
+are sorted in ascending order with respect to their associated wavelength.
+.SS Grammar
+The following grammar formally describes the
+.BR schiff (1)
+output format
+.TP
+<\fIoutput\fR> ::=
+ <\fIcross\-sections\fR>
+ empty-line
+ <\fIinverse\-cumulative\-phase\-functions\fR>
+.PP
+\l'20'
+.TP
+<\fIcross\-sections\fR> ::=
+ wavelength <\fIextinction\fR> <\fIabsorption\fR> <\fIscattering\fR> <\fIarea\fR>
+ <\fIcross\-sections\fR>
+.TP
+<\fIextinction\fR> ::=
+ estimation standard\-error
+.TP
+<\fIabsorption\fR> ::=
+ estimation standard\-error
+.TP
+<\fIscattering\fR> ::=
+ estimation standard\-error
+.TP
+<\fIarea\fR> ::=
+ estimation standard\-error
+.PP
+\l'20'
+.TP
+<\fIinverse\-cumulative\-phase\-functions\fR> ::=
+ <\fIinverse\-cumulative\-descriptor\fR>
+ <\fIangles\fR>
+ empty-line
+ <\fIinverse\-cumulative\-phase\-function\fR>
+.TP
+<\fIinverse\-cumulative\-descriptor\fR> ::=
+ wavelength theta-limit <\fIPF(theta\-limit)\fR> <\fICDF(theta\-limit)\fR> n
+.TP
+<\fICDF(theta\-limit)\fR> ::=
+ estimation standard\-error
+.TP
+<\fIPF(theta\-limit)\fR> ::=
+ estimation standard\-error
+.TP
+<\fIangles\fR> ::=
+ real
+ <\fIangles\fR>
+.SH EXAMPLE
+The following result is emitted by the
+.BR schiff(1)
+program invoked on the wavelengths 0.4 and 0.6 micron.
+Note that actually,
+.BR schiff(1)
+does not write comments, i.e. text preceeded by the "#" character. However in
+the following output, comments are added in order to help in understanding the
+data layout.
+.PP
+ 0.4 6.4e-2 1.1e-4 5.6e-2 9.1e-5 8.6e-3 1.9e-5 0.8 9.4e-4 \fB# X\-sections\fR
+ 0.6 7.7e-3 1.3e-5 7.4e-3 1.1e-5 5.5e-4 1.2e-6 0.2 2.3e-4 \fB# X\-sections\fR
+.PP
+ 0.4 0.54 6.75e-4 3.93e-6 8.02e-3 1.95e-5 3.40913 \fB# Inv Cum Descriptor\fR
+ 0.0000000 \fB# Angles list\fR
+ 0.0060234
+ ...
+ 2.74326
+ 3.14159
+.PP
+ 0.6 0.77 7.11e-5 1.05e-07 4.6e-4 1.23e-6 3.85927 \fB# Inv Cum Descriptor\fR
+ 0.0000000 \fB# Angles list\fR
+ 0.0121295
+ ...
+ 2.93276
+ 3.14159
+.SH SEE ALSO
+.BR schiff (1)
