Commit 351e4524 authored by Victor Poughon's avatar Victor Poughon

DOC: Improve cookbook introductions

This proof reads the installation chapter and
improves cookbook introdutions to OTB applications and Monteverdi by not
talking about OTB history, older versions of otb applications or
Monteverdi but directly introducing them in their current state,
focusing on a user completely unfamiliar with OTB or any of its previous
versions.
parent 20e42e3a
......@@ -12,20 +12,20 @@ We provide different standalone binary packages for OTB-Applications:
Other binaries can be available as packages (OSGeo packages,
Debian/Ubuntu packages, OpenSuse packages), however be advised that they
may not be up-to-date nor delivered with full features. If you want to
build from source or if we don’t provide packages for your system, some
informations are available into the , in the section (\ Building
from Source)
build from source or if we don’t provide packages for your system,
information is available in the `Software Guide <http://orfeo-toolbox.org/SoftwareGuide/>`_,
in the section "Building from Source".
Windows
-------
We provide for Windows Seven and later through standalone packages. They
are cross-compiled with MinGW, for 32bit and 64bit platforms. They
contain all and their launchers (both command line and graphical
launchers are provided). Check the download page : `OTB Download
page <https://www.orfeo-toolbox.org/download>`__
are cross-compiled with MinGW, for 32 bits and 64 bits platforms. They
contain all applications and their launchers (both command line and graphical
launchers are provided).
Check the `Download page <https://www.orfeo-toolbox.org/download>`__
There is a 32bit and a 64bit version. They contain the same directory
There is a 32 bits and a 64 bits version. They contain the same directory
structure:
- ``monteverdi.bat`` : A launcher script for Monteverdi
......@@ -47,18 +47,17 @@ with ``otbenv.bat``.
Linux 64bit
-----------
We provide for Linux 64bit OS through standalone packages. They contain
We provide for Linux 64 bits OS through standalone packages. They contain
all OTB Applications and their launchers (both command line and
graphical launchers are provided). Check the download page : `OTB
Download page <https://www.orfeo-toolbox.org/download>`__
graphical launchers are provided). Check the `Download page <https://www.orfeo-toolbox.org/download>`__
This package is a self-extractible archive. You may uncompress it with a
double-click on the file, or with the command line :
::
> chmod +x OTB-&\otbversion&-Linux64.run
> ./OTB-&\otbversion&-Linux64.run
chmod +x OTB-X.Y.Z-Linux64.run
./OTB-X.Y.Z-Linux64.run
Please note that the resulting installation is not meant to be moved,
you should uncompress the archive in its final location. Once the
......@@ -107,13 +106,13 @@ uncompress it with the command line :
::
> chmod +x OTB-&\otbversion&-Darwin64.run
> ./OTB-&\otbversion&-Darwin64.run
chmod +x OTB-X.Y.Z-Darwin64.run
./OTB-X.Y.Z-Darwin64.run
Once the archive is extracted, you can see OTB--Darwin64 directory in
the same direcrtory along with OTB--Darwin64.run
Once the archive is extracted, you can see OTB-X.Y.Z-Darwin64 directory in
the same direcrtory along with OTB-X.Y.Z-Darwin64.run
Contents of OTB--Darwin64 is briefly listed below:
Contents of OTB-X.Y.Z-Darwin64 is briefly listed below:
- ``Monteverdi.app`` : A Mac OSX .app for Monteverdi
......@@ -139,17 +138,17 @@ Notes:
- You must use monteverdi and mapla through their .app files only.
- You are allowed to move these .app files and refrain from moving or
deleting OTB--Darwin64 after extraction. In case you need to have OTB
deleting OTB-X.Y.Z-Darwin64 after extraction. In case you need to have OTB
installed in some other directory. Extract the .run file there.
Other packages
--------------
Warning ! These packages may not be up-to-date with latest OTB
Warning! These packages may not be up-to-date with latest OTB
releases. In addition, some features of the library may not be available
on every platform. Some of these are not maintained by OTB-team. If you
want to get involved in the packaging of OTB for your favourite
platform, please contact us through the developer’s mailing list :
platform, please contact us through the developer’s mailing list:
otb-developers@googlegroups.com.
Debian
......
A brief tour of Monteverdi
==========================
Introduction
------------
The package makes available a set of simple software tools, designed to
demonstrate what can be done with . Many users started using these
applications for real processing tasks, so we tried to make them more
generic, more robust and easy to use. users have been asking for an
integrated application for a while, since using several applications for
a complete processing (ortho-rectification, segmentation,
classification, etc.) can be a burden. The OTB team received a request
from CNES’ Strategy and Programs Office in order to provide an
integrated application for capacity building activities (teaching,
simple image manipulation, etc.). The specifications included ease of
integration of new processing modules.
**Warning** : since version 3.0.0, there is only one , which replaces
monteverdi2 and the original monteverdi 1 (version lower than 1.24.0).
Monteverdi
==========
Monteverdi is a satellite image viewer. Its main features are:
- **Performance**: Navigate instantly in full size satellite images thanks to its
hardware accelerated rendering engine. Compose tiles or compare multiple images in a stack with
rapid cycling and shader effects.
- **Sensor geometry support**: View raw images directly in sensor geometry! Resampling is
handled by the GPU through texture mapping. OTB automagically handles
coordinates mapping between actors and viewport geometries.
- **Powerful**: Access to all processing application from OTB. Orthorectification,
optical calibration, classification, SAR processing, and much more!
GUI : what does it look like ?
------------------------------
.. image:: Art/MonteverdiImages/gui.png
This is ’s main window (figure  [fig:mongui]) where the different
functionalities are reachable:
This is Monteverdi’s main window where the different functionalities are reachable:
- 1. Main menu
#. Main menu
- 2. Top toolbar
#. Top toolbar
- 3. Image displaying
#. Image displaying
- 4. Right side dock
#. Right side dock
- 5. Stack layer
#. Stack layer
Main menu
~~~~~~~~~
The main menu is made up of four items. The main one is the File item,
from which you can : open a image, load the otb applications, and
finally quit . The Edit item lets the user change his/her preferences.
from which you can: open a image, load the otb applications, and
finally quit. The Edit item lets the user change his/her preferences.
The view item is intended to let the user display or hide different
parts of the main window. Finally, the Help item lets the user know the
’About’ information of the software, and also can display an useful
......@@ -53,29 +45,28 @@ Top toolbar
The top toolbar is made up of ten icons; from left to right:
- 1st : open one or more image(s)
#. open one or more image(s)
- 2nd : zoom in
#. zoom in
- 3rd : zoom out
#. zoom out
- 4th : zoom to full extent
#. zoom to full extent
- 5th : zoom to layer extent
#. zoom to layer extent
- 6th : zoom to full resolution
#. zoom to full resolution
- 7th : gives/changes the current projection, used as reference of the
view
#. gives/changes the current projection, used as reference of the view
- 8th : selects the effect to be applied to the selected layer :
#. selects the effect to be applied to the selected layer :
chessboard, local constrast, local translucency, normal, spectral
angle, swipe (horizontal and vertical)
- 9th : a parameter used for the following effects : chessboard, local
#. a parameter used for the following effects : chessboard, local
contrast, local translucency, spectral angle
- 10th : a parameter used for the following effects : local constrast,
#. a parameter used for the following effects : local constrast,
spectral angle
Image displaying
......
A brief tour of OTB-Applications
A brief tour of OTB Applications
================================
Introduction
------------
OTB Applications was perhaps the older package of the Orfeo
Toolbox suite after the OTB package itself. Since the Orfeo
Toolbox is a library providing remote sensing functionalities, the
only applications that were distributed at the beginning were the
examples from the Software Guide and the tests. These applications are
very useful for the developer because their code is very short and only
demonstrates one functionality at a time. In many cases, a real
application would require :
- combining together two or more functions from the Orfeo Toolbox
- providing a nice high level interface to handle : parameters, input
data, output data and communication with the user
The OTB Applications package was originally designed to provide
applications performing simple remote sensing tasks, more complex than
simple examples from the Software Guide, and with a more user-friendly
interface (either graphical or command-line), to demonstrate the use of
the Orfeo Toolbox functions. The most popular applications are maybe
the *otbImageViewerManager* , which allows to open a collection of
images and navigate in them, and the
*otbSupervisedClassificationApplication* , which allowed to delineate
training regions of interest on the image and classify the image with a
SVM classifier trained with these regions (this application is no longer
maintained since the same functionnality is available through the
corresponding Monteverdi module). During the first 3 years of the
Orfeo Toolbox development, many more applications have been added to
this package, to perform various tasks. Most of them came with a
graphical user interface, apart from some small utilities that are
command-line.
The development and release of the Monteverdi software (see
chapter [chap:Monteverdi] at the end of year 2009 changed a lot of
things for the OTB Applications package: most of non-developer users
were looking for quite a long time for an application providing Orfeo
Toolbox functionalities under a unified graphical interface. Many
applications from the OTB Applications package were integrated to
Monteverdi as modules, and the OTB Applications package lost a
lot of its usefulness. No more applications were added to the package
and it was barely maintained, as new graphical tools were directly
embedded within Monteverdi .
Then, some people started to regain interest in the OTB Applications
package. Monteverdi is a great tool to perform numerous remote
sensing and image processing task in a minute, but it is not well
adapted to heavier (and longer) processing, scripting and batch
processing. Therefore, in 2010 the OTB Applications package has been
revamped: old applications have been moved to a legacy folder for
backward compatibility, and the development team started to populate the
package with compact command-line tools to perform various heavy
processing tasks.
Later on in 2011, the OTB Applications has been further revamped.
Because of the increasing need to interface the OTB Applications
into other software and to provide auto-generated interfaces, the
Orfeo Toolbox development team decided to develop a new application
framework. The main idea of this framework is the following: each
application is written once for all in a shared library (also known as
plugin). This plugin can be auto-loaded into appropriate tools wihtout
recompiling, and is able to fully describe its parameters, behaviour and
documentation.
The tools to use the plugins can be extended, but Orfeo Toolbox
shipped the following:
- A command-line laucher, which is almost equivalent to the former
OTB Applications command-line interface,
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:
- combine together two or more functions from the Orfeo Toolbox,
- provide a nice high level interface to handle: parameters, input
data, output data and communication with the user.
OTB applications can be launched in different ways, and accessed from different
entry points. The framework can be extended, but Orfeo Toolbox ships with the following:
- A command-line laucher, to call applications from the terminal,
- A graphical launcher, with an auto-generated QT interface, providing
ergonomic parameters setting, display of documentation, and progress
......@@ -80,47 +26,27 @@ shipped the following:
set-up and executed into a high-level language such as Python or Java
for instance.
Additionally, `QGis <http://www.qgis.org/>`_ plugins built on top of
the SWIG/Python interface are available with seamless integration within
QGis. You can find a short guide about it
`here <http://wiki.orfeo-toolbox.org/index.php/Quantum_GIS_access_to_OTB_applications>`_ .
- `QGIS <http://www.qgis.org/>`_ plugin built on top of
the SWIG/Python interface is available with seamless integration within
QGIS.
To facilitate the use of these tools and applications, they will now be
shipped with the standard Orfeo Toolbox package. It means that the
former OTB-Applications package has entered its maintenance cycle :
no new feature will be pushed there, and all development is done
directly inside the Orfeo Toolbox package.
The OTB Applications are now rich of more than 40 tools, which are
The OTB Applications are now rich of more than 90 tools, which are
listed in the the applications reference documentation, presented in
chapter [chap:apprefdoc], page .
chapter [chap:apprefdoc], page.
Using the applications
----------------------
Using the new framework is slightly more complex than launching a
command-line tool. This section describes all the ways to launch the new
applications. Apart from the simplified access, which is similar to the
former access to , you will need to know the application name and
optionally the path where the applications plugins are stored. For
applications shipped with , the name of each application can be found in
chapter [chap:apprefdoc], page .
Simplified use
~~~~~~~~~~~~~~
All standard applications delivered in with comes with simplified
scripts in the system path, allowing to launch the command-line and
graphical user interface versions of the application in the same simple
way we used to launch the old applications. The command-line interface
is prefixed by ``otbcli_``, while the Qt interface is prefixed by
Common framework
~~~~~~~~~~~~~~~~
All standard applications shared the same implementation and expose
automatically generated interfaces.
Thus, the command-line interface is prefixed by ``otbcli_``, while the Qt interface is prefixed by
``otbgui_``. For instance, calling ``otbcli_Convert`` will launch the
command-line interface of the Convert application, while
``otbgui_Convert`` will launch its GUI.
Passing arguments to the command-line version (prefixed by ``otbcli_``)
is explained in next sub-section.
Using the command-line launcher
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
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