commit e18fe61bb43466859c56b962aa760e1f31e680d1
parent 9c838243d24be5951ca4223d0088db365bc2d90b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 16 Mar 2016 17:44:04 +0100
Add man page of the schiff program
Diffstat:
| A | src/schiff.1 | | | 90 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 90 insertions(+), 0 deletions(-)
diff --git a/src/schiff.1 b/src/schiff.1
@@ -0,0 +1,90 @@
+.TH SCHIFF 1
+.SH NAME
+schiff \- estimate radiative properties of soft particles
+.SH SYNOPSIS
+\fBschiff
+\fR[\fIOPTIONS\fR]...
+[\fIFILE\fR]
+.SH DESCRIPTION
+\fBschiff\fR estimates the radiative properties of micro organisms with an
+"Approximation Method for Short Wavelength or High Energy Scattering" (L.
+Schiff, 1956 [1]). It relies on the Monte\-Carlo method to solve Maxwell's
+equations within Schiff's approximation (J. Charon et al. 2016 [2]); it
+estimates total cross sections (extinction, absorption and scattering
+cross-sections) in addition of the inverse cumulative phase function.
+.PP
+The shape of the micro organisms is controlled by the geometry distribution
+defined in the YAML file submitted by the \fB\-i\fR option while \fIFILE\fR
+stores their per wavelength optical properties. Each line of \fIFILE\fR must be
+formatted as "W Nr Kr Ne" where "W" is the wavelength in vacuum expressed in
+micron "Nr" and "Kr" are the real and imaginary parts, respectively, of the
+relative refractive index, and "Ne" the refractive index of the medium. With no
+\fIFILE\fR, the optical properties are read from standard input.
+.PP
+The estimated results are written to the \fIOUTPUT\fR file defined by the
+\fB\-o\fR option or to standard output whether the \fB-o\fR option is defined
+or not, respectively.
+.SH OPTIONS
+.TP
+.B \-a \fIANGLES\fR
+number of phase function scattering angles. Default is 1000.
+.TP
+.B \-A \fIANGLES\fR
+number of angles computed from the inverse cumulative phase function. Default
+is 2000.
+.TP
+.B \-d \fIDIRS\fR
+number of sampled directions for each geometry. Default is 100.
+.TP
+.B \-g \fIGEOMETRIES\fR
+number of sampled geometries. This is actyally the number of realisations.
+Default is 10000.
+.TP
+.B \-G \fICOUNT\fR
+sampled \fICOUNT\fR geometries with respect to the defined distribution, dump
+their data and exit. The data are written to OUTPUT or the standard output
+whether the \fB-o\fR option is defined or not, respectively. The outputted data
+followed the Alias Wavefront obj file format.
+.TP
+.B \-h
+display short help and exit.
+.TP
+.B \-i \fIDISTRIBUTION\fR
+define the YAML file that controls the geometry distributions of the micro
+organisms.
+.TP
+.B \-l \fILENGTH\fR
+caracteristic length of the micro organisms.
+.TP
+.B \-n \fITHREADS\fR
+hint on the number of threads to use during the integration. By default use as
+many threads as CPU cores.
+.TP
+.B \-o \fIOUTPUT\fR
+write results to OUTPUT. If not defined, write results to standard output.
+.TP
+.B \-q
+do not print the helper message when no FILE is submitted.
+.TP
+.B \-w \fI A[:B]...\fR
+list of wavelengths in vacuum (expressed in micron) to integrate.
+.SH NOTES
+.TP
+[1]
+L. I. Schiff, 1956. Approximation Method for Short Wavelength or High\-Energy
+Scattering. Phys. Rev. 104 \- 1481\-1485.
+.TP
+[2]
+J. Charon, S. Blanco, J. F. Cornet, J. Dauchet, M. El Hafi, R. Fournier, M.
+Kaissar Abboud, S. Weitz, 2016. Monte Carlo Implementation of Schiff's
+approximation for estimating radiative properties of homogeneous, simple-shaped
+and optically soft particles: Application to photosynthetic micro-organisms.
+Journal of Quantitative Spectroscopy and Radiative Transfer 172 \- 3\-23.
+.SH COPYRIGHT
+Copyright \(co |Meso|Star> 2015-2016 (<contact@meso-star.com>). It is a free
+software release under the OSI approved CeCILL license. You are welcome de
+redistribute it under certain conditions.
+.SH SEE ALSO
+
+.BR schiff-geometry (5),
+.BR schiff-output (5)
