commit 743a6d2361e1540a90c128b424490ca64639ecf3
parent 84cd957f3a5e0255ad75cf889bec785a76f21fa4
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 24 Mar 2016 20:32:32 +0100
Fix some misspellings and typos in the man pages
Diffstat:
3 files changed, 9 insertions(+), 10 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -41,7 +41,7 @@ of a sphere whose \fRradius\fR is controlled by a distribution;
A spherical geometry is simply controlled by the distribution of its
\fBradius\fR.
.IP \(bu 4
-A supershape is a generalisation of the superellipsoide that is well suited to
+A supershape is a generalisation of the superellipsoid that is well suited to
represent many complex shapes found in the nature. It is controlled by 2
superformulas, each defining a radius "r" for a given angle "a":
.IP " " 8
@@ -49,8 +49,8 @@ r(a) = ( |cos(\fBM\fR*a/4)/\fBA\fR)|^\fBN1\fR + |sin(\fBM\fR*a/4)/\fBB\fR|^\fBN2
.IP " " 4
The 6 parameters of each superformula \- i.e. \fBA\fR, \fBB\fR, \fBM\fR,
\fBN0\fR, \fBN1\fR and \fBN2\fR \- are controlled independently by their own
-distribution. Assuming a point with the spherical coordinate {theta, phi}, the
-corresponding 3D coordinate onto the supershape is obtained by evaluating the
+distribution. Assuming a point with the spherical coordinates {theta, phi}, the
+corresponding 3D coordinates onto the supershape is obtained by evaluating the
following relations:
.IP " " 8
x = r0(theta)*cos(theta) * r1(phi)*cos(phi)
@@ -62,10 +62,9 @@ z = r1(phi)*sin(phi)
The geometry parameters can be distributed with respect to the following
distributions:
.IP \(bu 4
-the constant distribution fixes the value of the parameter. Actually this
-distribution is implicitly used if the parameter value is a constant;
+the constant distribution fixes the value of the parameter;
.IP \(bu 4
-the \fBgaussian\fR distribution use the following probability distribition to
+the \fBgaussian\fR distribution uses the following probability distribution to
define the parameter according to the mean value \fBmu\fR and the standard
deviation \fBsigma\fR:
.IP " " 8
@@ -221,10 +220,10 @@ follows an histogram distribution:
.PP
Soft particles are cylinders. Their radius is constant and their height is
distributed according to a gaussian distribution. The cylinder geometry is
-discretized in 64 slices along 2PI:
+discretized in 128 slices along 2PI:
.IP " " 4
\fBcylinder:
- slices: 64
+ slices: 128
radius: 1
height: { gaussian: { mu: 1.3, sigma: 0.84 } }\fR
.PP
diff --git a/doc/schiff-output.5 b/doc/schiff-output.5
@@ -31,7 +31,7 @@ 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 at "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
+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
diff --git a/doc/schiff.1 b/doc/schiff.1
@@ -90,7 +90,7 @@ output:
.IP " " 4
$ \fBschiff -i geometry.yaml -l 2.3 -w 0.45:0.6 properties\fR
.PP
-The soft particles have a characteristic length of 1 and their shape is
+The soft particles have a characteristic length of \fB1\fR and their shape is
controlled by the \fBmy_geom.yaml\fR file. Their optical properties are read
from the standard input. The estimated wavelelength is \fB0.66\fR microns and
the results are written to the \fBmy_result\fR file:
