Commit 3b642a46 authored by Victor Poughon's avatar Victor Poughon
Browse files

CookBook: fix some titles and depths

parent c6478a71
......@@ -521,7 +521,7 @@ def GenerateRstForApplications():
print "All apps: %s" % (appNames,)
appIndexFile = open(RST_DIR + '/Applications.rst', 'w')
appIndexFile.write(RstPageHeading("Applications", "2", ref="apprefdoc"))
appIndexFile.write(RstPageHeading("Applications Reference Documentation", "2", ref="apprefdoc"))
for appName in appNames:
tags = GetApplicationTags(appName)
......
......@@ -63,7 +63,8 @@ use the otbcli and otbgui launchers, you can initialize your environment
with ``source otbenv.profile``.
Python bindings
---------------
~~~~~~~~~~~~~~~
Starting from OTB 5.8.0, OTB python bindings are distributed with binary package.
currently only Python 2.x is supported. If no compatible python is found, installation
notify you about it. If everything works fine, you will be given information about
......@@ -87,10 +88,11 @@ Notes:
- Multiple installation of OTB can exists in same system without one conflicting the other!
FAQ for Packaging
-----------------
~~~~~~~~~~~~~~~~~
Q: I am getting an error message...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+++++++++++++++++++++++++++++++++++
::
Cannot mix incompatible Qt library (version 0x40806) with this library (version 0x40807)
......@@ -104,7 +106,7 @@ A: This is due to a conflict with system Qt4 (usually seen on KDE) and Qt4 + gtk
rm -f lib/libQt* && rm -fr lib/gtk
Q: Monteverdi and Mapla applications look different from my other applications.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
A: By default, Monteverdi, Mapla and otbapplication (otbgui\_\*) uses a the
system gtk theme. If you can't install GTK on your system you can use the
......
......@@ -26,7 +26,8 @@ Contents of OTB-|release|-Darwin64 is briefly listed below:
mentions.
Python bindings
---------------
~~~~~~~~~~~~~~~
Starting from OTB 5.8.0, OTB python bindings are distributed with binary package.
currently only Python 2.x is supported. If no compatible python is found, installation
notify you about it. If everything works fine, you will be given information about
......
......@@ -23,7 +23,8 @@ use the otbcli and otbgui launchers, you can initialize a command prompt
with ``otbenv.bat``.
Python bindings
---------------
~~~~~~~~~~~~~~~
Starting from OTB 5.8.0, OTB python bindings are distributed with binary package.
currently only Python 2.x is supported. If no compatible python is found, installation
notify you about it. If everything works fine, you will be given information about
......@@ -33,9 +34,10 @@ You must have python numpy bindings installed in your system. you can install it
without admin rights with "pip install --user numpy". This is to give users to choose
their own existing python installation rather than distributing one in OTB package
Notes:
~~~~~~
Notes
~~~~~
- You must have "Visual C++ Redistributable for Visual Studio 2015" installed for using this package.
It can be downloaded freely from `microsoft <https://www.microsoft.com/en-us/download/details.aspx?id=48145>`_
A brief tour of OTB Applications
================================
Introduction
------------
OTB ships with more than 90 ready to use applications for remote sensing tasks.
They usually expose existing processing functions from the underlying C++
library, or compose them into high level pipelines. OTB applications allow to:
......@@ -30,8 +27,7 @@ entry points. The framework can be extended, but Orfeo Toolbox ships with the fo
the SWIG/Python interface is available with seamless integration within
QGIS.
The complete list of applications is described in the :ref:`Application
Reference Documentation <apprefdoc>`.
The complete list of applications is described in the :ref:`apprefdoc`.
All standard applications share the same implementation and expose
automatically generated interfaces.
......@@ -40,8 +36,8 @@ Thus, the command-line interface is prefixed by ``otbcli_``, while the Qt interf
command-line interface of the Convert application, while
``otbgui_Convert`` will launch its GUI.
Using the command-line launcher
-------------------------------
Command-line launcher
---------------------
The command-line application launcher allows to load an application
plugin, to set its parameters, and execute it using the command line.
......@@ -135,8 +131,8 @@ Parameters are passed to the application using the parameter key (which
might include one or several ``.`` character), prefixed by a ``-``.
Command-line examples are provided in chapter [chap:apprefdoc], page .
Using the GUI launcher
----------------------
Graphical launcher
------------------
The graphical interface for the applications provides a useful
interactive user interface to set the parameters, choose files, and
......@@ -181,8 +177,8 @@ The interface of the application is shown here as an example.
.. figure:: Art/QtImages/rescale_progress.png
.. figure:: Art/QtImages/rescale_documentation.png
Using the Python interface
--------------------------
Python interface
----------------
The applications can also be accessed from Python, through a module
named ``otbApplication``. However, there are technical requirements to use it.
......@@ -261,8 +257,8 @@ application, changing the algorithm at each iteration.
app.ExecuteAndWriteOutput()
Using OTB from QGIS
-------------------
QGIS interface
--------------
The processing toolbox
^^^^^^^^^^^^^^^^^^^^^^
......@@ -289,8 +285,8 @@ existing one, you will need to replace the otbcli, otbgui and library
files in QGIS installation directly.
Load/Save OTB-Applications parameters from/to file
--------------------------------------------------
Load and save parameters to XML files
-------------------------------------
Since OTB 3.20, OTB applications parameters can be export/import to/from
an XML file using inxml/outxml parameters. Those parameters are
......@@ -353,7 +349,7 @@ for writing the final result images.
In-memory connection between applications is available both at the C++
API level and using the python bindings to the application presented
in the `Using the Python interface`_ section.
in the `Python interface`_ section.
Here is a Python code sample connecting several applications together:
......@@ -459,11 +455,8 @@ Note that this MPI parallel invocation of applications is only
available for command-line calls to OTB applications, and only for
images output parameters.
Extended filename for reader and writer
---------------------------------------
Purpose
^^^^^^^
Extended filenames for reader and writer
----------------------------------------
There are multiple ways to define geo-referencing information. For
instance, one can use a geographic transform, a cartographic projection,
......@@ -483,9 +476,6 @@ application, the sensor model must be used. In order to specify which
information should be skipped, a syntax of extended filenames has been
developed for both reader and writer.
Syntax
^^^^^^
The reader and writer extended file name support is based on the same
syntax, only the options are different. To benefit from the extended
file name mechanism, the following syntax is to be used:
......
......@@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to OTB CookBook's documentation!
========================================
Welcome to Orfeo ToolBox!
=========================
`Orfeo ToolBox (OTB) <http://orfeo-toolbox.org>`_ is an open-source project for
state-of-the-art remote sensing. Built on the shoulders of the open-source
......
Supports Markdown
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