commit 0521051fb29c5ed6f398d7d9a4609f4592175967
parent f4ef4b8bd6baf91e4abb106320b1b6d46d3e0558
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 13 Nov 2018 10:01:24 +0100
Minor changes on man pages
Diffstat:
2 files changed, 47 insertions(+), 41 deletions(-)
diff --git a/doc/htrdr-image.5.txt b/doc/htrdr-image.5.txt
@@ -23,21 +23,22 @@ htrdr-image - format of the images generated by htrdr(1)
DESCRIPTION
-----------
-The *htrdr-image* is a raw image file format whose data are stored in plain
+The *htrdr-image* is a raw image file format where data are stored in plain
text. Characters after the '#' character are considered as comments and are
-thus ignore as well as empty lines. The first valid line stores 2 unsigned
+thus ignored as well as empty lines. The first valid line stores 2 unsigned
integers that represent the image definition, i.e. the number of pixels per
-line and per column. Then each line stores 3 pairs of floating points data,
+line and per column. Then each line stores 3 pairs of floating points data
representing the pixel color encoded in the CIE 1931 XYZ color space. The
first, second and third pair encodes the estimated radiance of the X, Y and Z
-pixel component, respectively. The first value of each pair is the radiance
-expected value while the second one is its associated standard deviation.
+pixel component, respectively. The first value of each pair is the expected
+value of the estimated radiance while the second one is its associated
+standard deviation.
Pixels are sorted line by line, with the origin defined as the top corner of
the image. With an image definition of N by M pixels, with N the number of
-pixels per line and M the overall number of lines in the image. The first N
+pixels per line and M the overall number of lines in the image, the first N
pixels correspond to the pixels of the top line of the image, the following N
-pixels are the second line and so on.
+pixels are the pixels of the second line and so on.
GRAMMAR
-------
@@ -64,13 +65,13 @@ GRAMMAR
EXAMPLE
-------
-The following output is emitted by *htrdr*(1) invoked to render an image whose
-definition is *800* by *600* pixels. Note that actually the comments or the
-blank lines are not necessaraly written as it by *htrdr*(1); they are are used
-here only to help in understanding the data layout. The comment after each
-pixel gives the two dimensionnal index of the pixel in the image: the first
-and second integer is the index of the line and the column of the pixel into
-the image, respectively.
+The following output is emitted by *htrdr*(1) invoked to render an image of
+*800* by *600* pixels. Note that actually the comments or the blank lines are
+not necessarily written as it by *htrdr*(1); they are are used here only to
+help in understanding the data layout. The comment after each pixel gives the
+two dimensional index of the pixel in the image: the first and second integer
+is the index of the line and the column of the pixel into the image,
+respectively.
[verse]
------
@@ -94,7 +95,7 @@ the image, respectively.
...
-# Pixels of the 600^th line
+# Pixels of the 600th line
0.0002697 7.44208e-05 0.0002310 2.56492e-05 0.0001958 2.30952e-05 # (1,600)
0.0004325 0.000125897 0.0002222 2.22320e-05 0.0002047 2.60948e-05 # (2,600)
0.0002782 5.81477e-05 0.0002756 4.99110e-05 0.0002172 3.30041e-05 # (3,600)
diff --git a/doc/htrdr.1.txt.in b/doc/htrdr.1.txt.in
@@ -56,15 +56,15 @@ observation position.
In *htrdr* the spatial unit 1.0 corresponds to one meter. The estimated
radiance of each pixel component is given in W.sr^-1.m^-2. The pixels are
written into the _output_ file or to the standard output whether the *-o*
-option is defined or not, respectively. The output image is al ist of raw
+option is defined or not, respectively. The output image is a list of raw
ASCII data formatted with respect to the *htrdr-image*(5) file format. Since
*htrdr* relies on the Monte-Carlo method, the estimated radiance of a pixel
component is provided with its numerical accuracy.
-*htrdr* supports the shared memory parallelism and relies on the Message
-Passing Interface specification [5] to parallelise its computations in a
-distribute memory environment. *htrdr* can thus be run either directly or
-through a MPI process launcher like *mpirun*(1).
+*htrdr* supports shared memory parallelism and relies on the Message Passing
+Interface specification [4] to parallelise its computations in a distribute
+memory environment. *htrdr* can thus be run either directly or through a MPI
+process launcher like *mpirun*(1).
OPTIONS
-------
@@ -102,15 +102,17 @@ OPTIONS
90]. Following the right-handed convention, the azimuthal rotation is
counter-clockwise, with 0 degree on the X axis. The elevation starts from 0
degree for a direction in the XY plane, up to 90 degrees at zenith. Thus
- -D0,0 -D0,90 -D0,180 and -D0,270 will produce solar vectors {-1,0,0} {0,-1,0}
- {+1,0,0} and {0,+1,0} respectively, while -D__azimuth__,90 will produce
- {0,0,-1} regardless of _azimuth value.
+ -D0,0 -D0,90 -D0,180 and -D0,270 will produce solar vectors {+1,0,0} {0,+1,0}
+ {-1,0,0} and {0,-1,0} respectively, while -D__azimuth__,90 will produce
+ {0,0,+1} regardless of _azimuth_ value.
*-d*::
- Write in _output_ the data structure used to speed up the radiative transfer
- computations in the clouds. The written data are 3D grids saved in the VTK
- file format [4]. Each grid are separated of the previous one by a line with
- three minus character, i.e. '---'.
+ Write in _output_ the space partitionning data structures used to speed up
+ the radiative transfer computations in the clouds. The written data are
+ octrees saved in the VTK file format [3]. Each octree node stores the minimum
+ and the maximum of the extinction coefficients of the cloud cells overlapped
+ by the octree node. In the _output_ file, each octree is separated of the
+ previous one by a line with three minus characters, i.e. '---'.
*-e* _reflectivity_::
Reflectivity of the ground geometry in [0, 1]. By default it is set to
@@ -120,24 +122,24 @@ OPTIONS
Force overwrite of the _output_ file.
*-g* _ground_::
- Path toward an OBJ file [3] representing the ground geometry.
+ Path toward an OBJ file [2] representing the ground geometry.
*-G*::
Pre-compute or use cached grids of the cloud properties built from the
_clouds_, the _atmosphere_ and the _mie_ files. If the corresponding grids
were generated in a previous run, reuse them as far as it is possible, i.e.
if the _clouds_, the _atmosphere_ and the _mie_ files were not updated. The
- cached data, are written in a hidden directory named *.htrdr* located in the
+ cached data are written in a hidden directory named *.htrdr* located in the
directory where *htrdr* is run. On platforms with an efficient hard-drive and
- plenty of random access memory, this cache mechanism can speed-up the
- pre-computation step on _clouds_ data. Note that this option is incompatible
- with a MPI execution and is thus forced to off if *htrdr* is run through a
- process launcher.
+ plenty of random access memory, this cache mechanism can significantly
+ speed-up the pre-computation step on _clouds_ data. Note that this option is
+ incompatible with a MPI execution and is thus forced to off if *htrdr* is run
+ through a process launcher.
*-h*::
List short help and exit.
-*-i* <__image-parameter__:>::
+*-i* <__image-parameter__:...>::
Define the image to render. Available image parameters are:
**def**=**_width_**,**_height_**;;
@@ -161,7 +163,7 @@ OPTIONS
droplets.
*-o* _output_::
- File where *htrdr* write its _output_ data. If not defined, write results to
+ File where *htrdr* writes its _output_ data. If not defined, write results to
standard output.
*-T* _threshold_::
@@ -185,7 +187,7 @@ Render a clear sky scene, i.e. a scene without any cloud, whose sun is at
zenith. The vertical atmospheric gaz mixture along the Z axis is described in
the *gas.txt* file. The Mie data are provided through the *Mie.nc* file and
the ground geometry is a quad repeated to the infinity. The camera is
-positioned at 400 meters high and looks toward the positive Y axis. The
+positioned at *400* meters high and looks toward the positive Y axis. The
definition of the rendered image is *800* by *600* pixels and the radiance of
each pixel component is estimated with *64* Monte-Carlo realisations. The
resulting image is written to *output* excepted if the file already exists; in
@@ -239,11 +241,11 @@ NOTES
-----
1. High-Tune: Gas Optical Properties file format -
<https://www.meso-star.com/projects/dowloads/htgop.pdf>
-2. Network Common Data Form - <https://www.unidata.ucar.edu/software/netcdf/>
-3. OBJ file format -
+2. OBJ file format -
<http://www.martinreddy.net/gfx/3d/OBJ.spec>
-4. VTK file format -
+3. VTK file format -
<http://www.vtk.org/wp-content/uploads/2015/04/file-formats.pdf>
+4. MPI specifications - <https://www.mpi-forum.org/docs/>
COPYRIGHT
---------
@@ -255,5 +257,8 @@ NO WARRANTY, to the extent permitted by law.
SEE ALSO
--------
-*csplit*(1), *mpirun*(1), *htcp*(5), *htmie*(5), *htrdr-image*(5)
-
+*csplit*(1),
+*mpirun*(1),
+*htcp*(5),
+*htmie*(5),
+*htrdr-image*(5)
