commit cd9cfb175fd8e9c71c95b3ffa38665d1e67bd2ae
parent 88146d2adf7a0a4ae16fa63e8aff3ff33771a159
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 18 Mar 2016 14:14:11 +0100
Small update of the schiff man page
Fix some typos and misspellings. Replace the "micro-organism" term by the
more general "soft-particle" expression.
Diffstat:
| M | doc/schiff.1 | | | 53 | ++++++++++++++++++++++++++++++----------------------- |
1 file changed, 30 insertions(+), 23 deletions(-)
diff --git a/doc/schiff.1 b/doc/schiff.1
@@ -6,22 +6,25 @@ schiff \- estimate radiative properties of soft particles
\fR[\fIOPTIONS\fR]...
[\fIFILE\fR]
.SH DESCRIPTION
-\fBschiff\fR estimates the radiative properties of micro organisms with an
+\fBschiff\fR computes the radiative properties of soft particles with an
"Approximation Method for Short Wavelength or High Energy Scattering" [1]. It
relies on the Monte\-Carlo method to solve Maxwell's equations within Schiff's
approximation [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.
+The shapes of a family of soft particles are controlled by the
+.BR schiff-geometry (5)
+file submitted by the \fB\-i\fR option. Their per wavelength properties are
+stored in \fIFILE\fR where each line is formatted as "W Nr Kr Ne" whith "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
+The estimated results follows the
+.BR schiff-output (5)
+format and 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
@@ -37,11 +40,11 @@ is 2000.
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.
+number of sampled geometries. This is actually the number of realisations.
Default is 10000.
.TP
.B \-G \fICOUNT\fR
-sampled \fICOUNT\fR geometries with respect to the defined distribution, dump
+sample \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.
@@ -50,23 +53,26 @@ followed the Alias Wavefront obj file format.
display short help and exit.
.TP
.B \-i \fIDISTRIBUTION\fR
-define the YAML file that controls the geometry distributions of the micro
-organisms.
+define the YAML
+.BR schiff-geometry (5)
+file that controls the geometry distribution of the soft particles.
.TP
.B \-l \fILENGTH\fR
-caracteristic length of the micro organisms.
+caracteristic length of the soft particles.
.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.
+write results to \fIOUTPUT\fR with respect to the
+.BR schiff-output (5)
+format. If not defined, write results to standard output.
.TP
.B \-q
-do not print the helper message when no FILE is submitted.
+do not print the helper message when no \fIFILE\fR is submitted.
.TP
-.B \-w \fI A[:B]...\fR
+.B \-w \fIA\fR[\fB:\fIB\fR]...
list of wavelengths in vacuum (expressed in micron) to integrate.
.SH NOTES
.TP
@@ -77,14 +83,15 @@ Scattering. Phys. Rev. 104 \- 1481\-1485.
[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.
+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
\fBschiff\fR is 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. Refer to the its COPYING
-files for details.
+It is a free software released under the OSI approved CeCILL license. You are
+welcome de redistribute it under certain conditions. Refer to its COPYING file
+for details.
.SH SEE ALSO
.BR schiff-geometry (5),
.BR schiff-output (5)
