diff --git a/Documentation/Cookbook/Art/QtImages/rescale_documentation.png b/Documentation/Cookbook/Art/QtImages/rescale_documentation.png deleted file mode 100644 index 70cea29e59f15f04ac7a8ccbf119aba372409c16..0000000000000000000000000000000000000000 Binary files a/Documentation/Cookbook/Art/QtImages/rescale_documentation.png and /dev/null differ diff --git a/Documentation/Cookbook/Art/QtImages/rescale_logs.png b/Documentation/Cookbook/Art/QtImages/rescale_logs.png deleted file mode 100644 index ed6abd8f90e348f63154d77c9b593a344df38bd6..0000000000000000000000000000000000000000 Binary files a/Documentation/Cookbook/Art/QtImages/rescale_logs.png and /dev/null differ diff --git a/Documentation/Cookbook/Art/QtImages/rescale_param.png b/Documentation/Cookbook/Art/QtImages/rescale_param.png index e3b9cff8ce3de5dc72fc386da55c34dc9040fada..bb235c7528fd6ac2ac52097ed01fc5f3db2c080e 100644 Binary files a/Documentation/Cookbook/Art/QtImages/rescale_param.png and b/Documentation/Cookbook/Art/QtImages/rescale_param.png differ diff --git a/Documentation/Cookbook/Art/QtImages/rescale_progress.png b/Documentation/Cookbook/Art/QtImages/rescale_progress.png deleted file mode 100644 index bedf4336133a201ddc550eceda4ef17600c7ccc8..0000000000000000000000000000000000000000 Binary files a/Documentation/Cookbook/Art/QtImages/rescale_progress.png and /dev/null differ diff --git a/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py b/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py index eb0cd954d523df801e371267058618e6532de127..f9c22a7397be3bba3e0f06f32cbff39fd4daa1ed 100755 --- a/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py +++ b/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py @@ -205,8 +205,9 @@ def rst_parameter_value(app, key): ParameterType_Float: "float", ParameterType_String: "string", ParameterType_StringList: "string1 string2...", - **dict.fromkeys([ParameterType_InputFilename, ParameterType_OutputFilename], "filename"), - **dict.fromkeys([ParameterType_InputImage, ParameterType_ComplexInputImage, ParameterType_OutputImage, ParameterType_ComplexOutputImage], "image"), + **dict.fromkeys([ParameterType_InputFilename, ParameterType_OutputFilename], "filename [dtype]"), + **dict.fromkeys([ParameterType_InputImage, ParameterType_ComplexInputImage], "image"), + **dict.fromkeys([ParameterType_OutputImage, ParameterType_ComplexOutputImage], "image [dtype]"), **dict.fromkeys([ParameterType_InputVectorData, ParameterType_OutputVectorData], "vectorfile"), ParameterType_Directory: "directory", ParameterType_Choice: "choice", diff --git a/Documentation/Cookbook/Scripts/otb_warnings.py b/Documentation/Cookbook/Scripts/otb_warnings.py index 6db86be913be455b20e3182f6a3d9d683c0384bf..4ed62aee4ac43211bf914aaed7fc45d3e72e19a1 100644 --- a/Documentation/Cookbook/Scripts/otb_warnings.py +++ b/Documentation/Cookbook/Scripts/otb_warnings.py @@ -12,10 +12,10 @@ def parameter_warnings(app_warn, app, key): warn("name ends with a space") if ":" in name: - warn("name contains special character (:)") + warn("name contains a special character (:)") if "." in name: - warn("name contains special character (.)") + warn("name contains a special character (.)") #if description == "": #warn("missing description") diff --git a/Documentation/Cookbook/rst/AdvancedUse.rst b/Documentation/Cookbook/rst/AdvancedUse.rst index e9813689ce2575da5c16082f6123c12f08ab6419..09d3d6cb80c599a57fcb6e4b3b8c8c440f54a006 100644 --- a/Documentation/Cookbook/rst/AdvancedUse.rst +++ b/Documentation/Cookbook/rst/AdvancedUse.rst @@ -334,6 +334,8 @@ The available syntax for boolean options are: - OFF, Off, off, false, False, 0 are available for setting a ’false’ boolean value +----------------------------------------------- + :: &nodata=(double) value / [int:double, int:double ...] diff --git a/Documentation/Cookbook/rst/OTB-Applications.rst b/Documentation/Cookbook/rst/OTB-Applications.rst index 3fe1052e956dc584cb898cc474347ac184a04f65..736c587bd951e62c3e51f7b29d4b973273374b71 100644 --- a/Documentation/Cookbook/rst/OTB-Applications.rst +++ b/Documentation/Cookbook/rst/OTB-Applications.rst @@ -1,7 +1,7 @@ A brief tour of OTB Applications ================================ -OTB ships with more than 90 ready to use applications for remote sensing tasks. +OTB ships with than 100 ready to use applications for remote sensing tasks. They usually expose existing processing functions from the underlying C++ library, or integrate them into high level pipelines. OTB applications allow the user to: @@ -84,44 +84,55 @@ example based on the OrthoRectification application: :: $ otbcli_OrthoRectification - - ERROR: Waiting for at least one parameter... - - ====================== HELP CONTEXT ====================== - NAME: OrthoRectification - DESCRIPTION: This application allows to ortho-rectify optical images from supported sensors. - - EXAMPLE OF USE: + ERROR: Waiting for at least one parameter. + + + This is the Ortho-rectification (OrthoRectification) application, version 6.7.0 + + This application allows ortho-rectifying optical and radar images from supported sensors. + Complete documentation: https://www.orfeo-toolbox.org/CookBook/Applications/app_OrthoRectification.html or -help + + Parameters: + -io <group> Input and output data + MISSING -io.in <string> Input Image (mandatory) + MISSING -io.out <string> [pixel] Output Image [pixel=uint8/uint16/int16/uint32/int32/float/double/cint16/cint32/cfloat/cdouble] (default value is float) (mandatory) + -map <string> Map Projection [utm/lambert2/lambert93/wgs/epsg] (mandatory, default value is utm) + -map.utm.zone <int32> Zone number (mandatory, default value is 31) + -map.utm.northhem <boolean> Northern Hemisphere (mandatory, default value is false) + -map.epsg.code <int32> EPSG Code (mandatory, default value is 4326) + -outputs <group> Output Image Grid + -outputs.mode <string> Parameters estimation modes [auto/autosize/autospacing/outputroi/orthofit] (mandatory, default value is auto) + MISSING -outputs.ulx <float> Upper Left X (mandatory) + MISSING -outputs.uly <float> Upper Left Y (mandatory) + MISSING -outputs.sizex <int32> Size X (mandatory) + MISSING -outputs.sizey <int32> Size Y (mandatory) + MISSING -outputs.spacingx <float> Pixel Size X (mandatory) + MISSING -outputs.spacingy <float> Pixel Size Y (mandatory) + -outputs.lrx <float> Lower right X (optional, off by default) + -outputs.lry <float> Lower right Y (optional, off by default) + -outputs.ortho <string> Model ortho-image (optional, off by default) + -outputs.isotropic <boolean> Force isotropic spacing by default (mandatory, default value is true) + -outputs.default <float> Default pixel value (optional, off by default, default value is 0) + -elev <group> Elevation management + -elev.dem <string> DEM directory (optional, off by default) + -elev.geoid <string> Geoid File (optional, off by default) + -elev.default <float> Default elevation (mandatory, default value is 0) + -interpolator <string> Interpolation [bco/nn/linear] (mandatory, default value is bco) + -interpolator.bco.radius <int32> Radius for bicubic interpolation (mandatory, default value is 2) + -opt <group> Speed optimization parameters + -opt.rpc <int32> RPC modeling (points per axis) (optional, off by default, default value is 10) + -opt.ram <int32> Available RAM (MB) (optional, off by default, default value is 128) + -opt.gridspacing <float> Resampling grid spacing (optional, off by default, default value is 4) + -inxml <string> Load parameters from XML (optional, off by default) + -progress <boolean> Report progress + -help <string list> Display long help (empty list), or help for given parameters keys + + Use -help param1 [... paramN] to see detailed documentation of those parameters. + + Examples: otbcli_OrthoRectification -io.in QB_TOULOUSE_MUL_Extract_500_500.tif -io.out QB_Toulouse_ortho.tif - DOCUMENTATION: http://www.orfeo-toolbox.org/Applications/OrthoRectification.html - ======================= PARAMETERS ======================= - -progress <boolean> Report progress - MISSING -io.in <string> Input Image - MISSING -io.out <string> [pixel] Output Image [pixel=uint8/int8/uint16/int16/uint32/int32/float/double] - -map <string> Output Map Projection [utm/lambert2/lambert93/transmercator/wgs/epsg] - MISSING -map.utm.zone <int32> Zone number - -map.utm.northhem <boolean> Northern Hemisphere - -map.transmercator.falseeasting <float> False easting - -map.transmercator.falsenorthing <float> False northing - -map.transmercator.scale <float> Scale factor - -map.epsg.code <int32> EPSG Code - -outputs.mode <string> Parameters estimation modes [auto/autosize/autospacing] - MISSING -outputs.ulx <float> Upper Left X - MISSING -outputs.uly <float> Upper Left Y - MISSING -outputs.sizex <int32> Size X - MISSING -outputs.sizey <int32> Size Y - MISSING -outputs.spacingx <float> Pixel Size X - MISSING -outputs.spacingy <float> Pixel Size Y - -outputs.isotropic <boolean> Force isotropic spacing by default - -elev.dem <string> DEM directory - -elev.geoid <string> Geoid File - -elev.default <float> Average Elevation - -interpolator <string> Interpolation [nn/linear/bco] - -interpolator.bco.radius <int32> Radius for bicubic interpolation - -opt.rpc <int32> RPC modeling (points per axis) - -opt.ram <int32> Available memory for processing (in MB) - -opt.gridspacing <float> Resampling grid spacing + For a detailed description of the application behaviour and parameters, please check the application reference documentation presented @@ -169,12 +180,10 @@ In this interface, every optional parameter has a check box that you have to tick if you want to set a value and use this parameter. The mandatory parameters cannot be unchecked. -The interface of the application is shown here as an example. +The interface of the application is shown here as an example: .. figure:: Art/QtImages/rescale_param.png -.. figure:: Art/QtImages/rescale_logs.png -.. figure:: Art/QtImages/rescale_progress.png -.. figure:: Art/QtImages/rescale_documentation.png + :align: center Python interface ----------------