commit 67609cd18c1bd3c08968e21e8b09f3250ea5e741
parent fa9e2298a7a29db30cacb0654973d5d6c2d3aba1
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 6 Jul 2021 16:34:24 +0200
Take care of htrdr-combustion in the htrdr-image man page
Diffstat:
1 file changed, 31 insertions(+), 30 deletions(-)
diff --git a/doc/htrdr-image.5.txt b/doc/htrdr-image.5.txt
@@ -32,36 +32,37 @@ 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 8 pixel components.
-If the image is a regular rendering in the visible part of the spectrum, the
-pixel components are actually 4 pairs of floating points data representing the
-pixel color encoded in the CIE 1931 XYZ color space and the per radiative path
-computation time. The first, second and third pairs encode the estimated
-integrated radiance in W/sr/m^2 of the X, Y and Z pixel components,
-respectively. The first value of each pair is the expected value of the
-estimated radiance while the second one is its associated standard deviation.
-The fourth pair saves the estimate in microseconds of the per radiative path
-computation time and its standard error.
-
-If the image is an infrared rendering the first and second pixel components
-store the expected value and the standard error, respectively, of the
-estimated brightness temperature in Kelvin. The third and fourth components
-save the expected value and standard deviation of the pixel radiance that is
-either an integrated radiance in W/sr/m^2 or a spectral radiance in
-W/sr/m^2/nm whether this radiance is computed for a spectral range or for one
-wavelength. The fifth and sixth pixel components are unused. Finally the last
-2 pixel components save, as for a regular rendering, the estimate in
-microseconds of the per radiative path computation time and its standard
-error.
-
-If it was generating from a shortwave rendering the image is formatted as in
-longwave rendering mode exepted that the first and second pixel components are
-unused since no brightness temperature was evaluated in shortwave.
-
-For flux computations, the first and second pixel component stores the
-expected value and the standard error of the pixel flux in W/m^2. As
-previously, the seventh and eighth pixel components store the estimate of the
+If the image is a regular *htrdr-atmosphere*(1) rendering in the visible part of
+the spectrum, the pixel components are actually 4 pairs of floating points
+data representing the pixel color encoded in the CIE 1931 XYZ color space and
+the per radiative path computation time. The first, second and third pairs
+encode the estimated integrated radiance in W/sr/m^2 of the X, Y and Z pixel
+components, respectively. The first value of each pair is the expected value
+of the estimated radiance while the second one is its associated standard
+deviation. The fourth pair saves the estimate in microseconds of the per
+radiative path computation time and its standard error.
+
+If the image is an infrared rendering computed by *htrdr-atmosphere*(1) the
+first and second pixel components store the expected value and the standard
+error, respectively, of the estimated brightness temperature in Kelvin. The
+third and fourth components save the expected value and standard deviation of
+the pixel radiance that is either an integrated radiance in W/sr/m^2 or a
+spectral radiance in W/sr/m^2/nm whether this radiance is computed for a
+spectral range or for one wavelength. The fifth and sixth pixel components are
+unused. Finally the last 2 pixel components save, as for a regular rendering,
+the estimate in microseconds of the per radiative path computation time and
+its standard error.
+
+If the file stores a shortwave rendering of *htrdr-atmosphere*(1) or a
+monochromatic image computed by *htrdr-combustion*(1) the data are formatted
+as for infrared rendering exept that the first and second components of pixels
+are not used because no brightness temperature has been evaluated.
+
+For flux density calculations, the first and second pixel components store the
+expected value and standard error of the flux density of the pixel in W/m^2.
+As before, the seventh and eighth pixel components store the estimate of the
radiative path computation time in microseconds and its standard error. The
-remaining components, i.e. the components 3 to 6, are unused.
+remaining components, i.e. components 3 to 6, are unused.
Pixels are sorted line by line, with the origin defined at the top left corner
of the image. With an image definition of N by M pixels, with N the number of
@@ -150,4 +151,4 @@ NOTES
SEE ALSO
--------
-*htpp*(1), *htrdr*(1)
+*htpp*(1), *htrdr*(1), *htrdr-atmosphere*(1), *htrdr-combustion*(1)
