Commit a795703a authored by Cédric Traizet's avatar Cédric Traizet

Merge branch 'bandmath_doc' into 'develop'

Refactoring of the BandMathX documentation, and fix OpticalCalibration documentation

See merge request !580
parents 804001ae b6c2e3cf
Pipeline #2563 passed with stages
in 5 minutes and 39 seconds
......@@ -68,6 +68,7 @@ Table of Contents
recipes/featextract.rst
recipes/stereo.rst
recipes/hyperspectral.rst
recipes/bandmathX.rst
.. toctree::
:maxdepth: 1
......@@ -76,7 +77,6 @@ Table of Contents
C++/SystemOverview.rst
C++/Tutorial.rst
C++/UserGuide.rst
C++/AboutBandMathX.rst
C++/Examples.rst
C++/DeveloperGuide.rst
......
Image processing
================
Simple calculus with channels
-----------------------------
The *BandMath* application provides a simple and efficient way to
perform band operations. The command line application and the
corresponding Monteverdi module (shown in the section [Band:sub:`m`\ ath
module]) are based on the same standards. It computes a band wise
operation according to a user defined mathematical expression. The
following code computes the absolute difference between first bands of
two images.
::
otbcli_BandMath -il input_image_1 input_image_2
-exp "abs(im1b1 - im2b1)"
-out output_image
The naming convention “im[x]b[y]” designates the yth band of the xth
input image.
The *BandMath* application embeds built-in operators and functions
listed in `muparser documentation <https://beltoforion.de/article.php?a=muparser&p=features&s=idDef1#idDef1>`_ thus
allowing a vast choice of possible operations.
Images with no-data values
--------------------------
......
......@@ -61,7 +61,6 @@ private:
SetDescription("This application performs mathematical operations on several multiband images.");
SetDocLongDescription(
"This application performs a mathematical operation on several multi-band "
"images and outputs the result into an image (multi- or mono-band, as "
......@@ -87,7 +86,7 @@ private:
" * ``im1b2`` the 2nd component of a pixel from 1st input (band index is 1-based)\n"
" * ``im1b2N3x4`` a 3x4 pixels Neighbourhood of a pixel the 2nd component of a pixel from the 1st input\n"
" * ``im1PhyX`` horizontal (X-axis) spacing of the 1st input.\n"
" * ``im1PhyY`` vertical spacing of the 1st input input.\n"
" * ``im1PhyY`` vertical (Y-axis) spacing of the 1st input input.\n"
" * ``im1b2Mean`` mean of the 2nd component of the 1st input (global statistics)\n"
" * ``im1b2Mini`` minimum of the 2nd component of the 1st input (global statistics)\n"
" * ``im1b2Maxi`` maximum of the 2nd component of the 1st input (global statistics)\n"
......@@ -100,6 +99,7 @@ private:
" * ``<`` less than, ``>`` greater than, ``<=`` less or equal, ``>=`` greater or equal\n"
" * ``==`` equal, ``!=`` not equal\n"
" * logical operators: ``or``, ``and``, ``xor``\n"
" * bit manipulation: ``&`` (and), ``|`` (or), ``<<``(left shift) and ``>>`` (right shift)"
"* if-then-else operator: ``(condition ? value_true : value_false)``\n"
"* functions: abs(), exp(), log(), sin(), cos(), min(), max(), ...\n\n"
......
......@@ -133,7 +133,7 @@ private:
SetDocLongDescription("The application allows converting pixel values from DN (for Digital Numbers) to reflectance. Calibrated values are called surface reflectivity and its values lie in the range [0, 1].\nThe first level is called Top Of Atmosphere (TOA) reflectivity. It takes into account the sensor gain, sensor spectral response and the solar illuminations.\nThe second level is called Top Of Canopy (TOC) reflectivity. In addition to sensor gain and solar illuminations, it takes into account the optical thickness of the atmosphere, the atmospheric pressure, the water vapor amount, the ozone amount, as well as the composition and amount of aerosol gasses.\nIt is also possible to indicate an AERONET file which contains atmospheric parameters (version 1 and version 2 of Aeronet file are supported. Note that computing TOC reflectivity will internally compute first TOA and then TOC reflectance. \n"
"\n--------------------------\n\n"
"If the sensor is not supported by the metadata interface factory of OTB, users still have the possibility to give the needed parameters to the application.\n"
"For TOA conversion, these parameters are: \n"
"For TOA conversion, these parameters are: \n\n"
"- day and month of acquisition, or flux normalization coefficient, or solar distance (in AU);\n"
"- sun elevation angle;\n"
"- gains and biases, one pair of values for each band (passed by a file);\n"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment