diff --git a/Documentation/Cookbook/rst/ExtendedFilenames.rst b/Documentation/Cookbook/rst/AdvancedUse.rst similarity index 87% rename from Documentation/Cookbook/rst/ExtendedFilenames.rst rename to Documentation/Cookbook/rst/AdvancedUse.rst index 02b5512351958d0b5ae88f1de831e9c5c2f823cc..d98519393283522cc3abc9f1d40934baba4235a0 100644 --- a/Documentation/Cookbook/rst/ExtendedFilenames.rst +++ b/Documentation/Cookbook/rst/AdvancedUse.rst @@ -1,7 +1,24 @@ -.. _extended-filenames: +Advanced Use +============ + +This section describes advanced configuration options and tricks. + +Environment variables that affects Orfeo ToolBox +------------------------------------------------ + +The following environment variables are parsed by Orfeo ToolBox. Note +that they only affect default values, and that settings in extended +filenames, applications, monteverdi or custom C++ code might override +those values. + +* ``OTB_DEM_DIRECTORY``: Default directory were DEM tiles are stored. It should only contain ```.hgt`` or or georeferenced ``.tif`` files. Empty if not set (no directory set) +* ``OTB_GEOID_FILE``: Default path to the geoid file that will be used to retrieve height of DEM above ellipsoid. Empty if not set (no geoid set) +* ``OTB_MAX_RAM_HINT``: Default maximum memory that OTB should use for processing, in MB. If not set, default value is 128 MB. +* ``OTB_LOGGER_LEVEL``: Default level of logging for OTB. Should be one of ``DEBUG``, ``INFO``, ``WARNING``, ``CRITICAL`` or ``FATAL``, by increasing order of priority. Only messages with a higher priority than the level of logging will be displayed. By default level is ``DEBUG`` for Debug build and ``INFO`` otherwise. Extended filenames -================================ +------------------ +.. _extended-filenames: Extended filenames is an interesting feature of OTB. With it, you can control several aspects of the beahvior of the OTB in the OTB-Applications or in our @@ -42,7 +59,6 @@ applications from the bash command line.** Reader options ^^^^^^^^^^^^^^ - :: &geom=<path/filename.geom> diff --git a/Documentation/Cookbook/rst/index_TOC.rst b/Documentation/Cookbook/rst/index_TOC.rst index 12565d1577bd6a9211449e2c9e71b2cf0ca291e6..126fc8debfbd713cdd752205ee33f49ba9b60dfd 100644 --- a/Documentation/Cookbook/rst/index_TOC.rst +++ b/Documentation/Cookbook/rst/index_TOC.rst @@ -8,7 +8,7 @@ Table of Contents Installation OTB-Applications Monteverdi - ExtendedFilenames + AdvancedUse Recipes Applications FAQ