Commit cb7581cb authored by Victor Poughon's avatar Victor Poughon

DOC: remove obsolete FAQ entries

parent d835359f
Frequently Asked Questions
==========================
Introduction
------------
What's in OTB?
~~~~~~~~~~~~~~
--------------
- Image access: optimized read/write access for most of remote sensing
image formats, meta-data access, simple visualization;
......@@ -36,92 +33,6 @@ For an introduction to the C++ API see the
And for an exhaustive description of the C++ API see the
`Doxygen <https://www.orfeo-toolbox.org/doxygen/>`_.
What is ORFEO?
~~~~~~~~~~~~~~
ORFEO stands for Optical and Radar Federated Earth Observation. In 2001
a cooperation program was set between France and Italy to develop ORFEO,
an Earth observation dual system with metric resolution: Italy is in
charge of COSMO-Skymed the radar component development, and France of
PLEIADES the optic component.
The PLEIADES optic component is composed of two “small satellites” (mass
of one ton) offering a spatial resolution at nadir of 0.7 m and a field
of view of 20 km. Their great agility enables a daily access all over
the world, essentially for defense and civil security applications, and
a coverage capacity necessary for the cartography kind of applications
at scales better than those accessible to SPOT family satellites.
Moreover, PLEIADES have stereoscopic acquisition capacity to meet the
fine cartography needs, notably in urban regions, and to bring more
information when used with aerial photography.
The ORFEO “targeted” acquisition capacities made it a system
particularly adapted to defense or civil security missions, as well as
critical geophysical phenomena survey such as volcanic eruptions, which
require a priority use of the system resources.
With respect to the constraints of the Franco-Italian agreement,
cooperation have been set up for the PLEIADES optical component with
Sweden, Belgium, Spain and Austria.
Where can I get more information about ORFEO?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
At the PLEIADES HR web site: http://smsc.cnes.fr/PLEIADES/.
What is the ORFEO Accompaniment Program?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Beside the Pleiades (PHR) and Cosmo-Skymed (CSK) systems developments
forming ORFEO, the dual and bilateral system (France - Italy) for Earth
Observation, the ORFEO Accompaniment Program was set up, to prepare,
accompany and promote the use and the exploitation of the images derived
from these sensors.
The creation of a preparatory program is needed because of:
- the new capabilities and performances of the ORFEO systems (optical
and radar high resolution, access capability, data quality,
possibility to acquire simultaneously in optic and radar),
- the implied need of new methodological developments: new processing
methods, or adaptation of existing methods,
- the need to realize those new developments in very close cooperation
with the final users, the integration of new products in their
systems.
This program was initiated by CNES mid-2003 and will last until mid
2013. It consists in two parts, between which it is necessary to keep a
strong interaction:
- A Methodological part,
- A Thematic part.
This Accompaniment Program uses simulated data (acquired during airborne
campaigns) and satellite images quite similar to Pleiades (as QuickBird
and Ikonos), used in a communal way on a set of special sites. The
validation of specified products and services will be realized with
Pleiades data
Apart from the initial cooperation with Italy, the ORFEO Accompaniment
Program enlarged to Belgium, with integration of Belgian experts in the
different WG as well as a participation to the methodological part.
Where can I get more information about the ORFEO Accompaniment Program?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Go to the following web site:
http://smsc.cnes.fr/PLEIADES/A_prog_accomp.htm.
Who is responsible for OTB's development?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The French Centre National d’Études Spatiales, CNES, initiated the ORFEO
Toolbox and is responsible for the specification of the library. CNES
funds the industrial development contracts and research contracts needed
for the evolution of OTB.
License
-------
......@@ -157,107 +68,6 @@ No. The OTB license only requires you to include a copy of the Apache
license and to provide a clear attribution to the OTB project in any
distribution including a piece of OTB software.
Getting OTB
-----------
Who can download OTB?
~~~~~~~~~~~~~~~~~~~~~
Anybody can download OTB at no cost.
Where can I download OTB?
~~~~~~~~~~~~~~~~~~~~~~~~~
Go to http://www.orfeo-toolbox.org and follow the “download OTB” link.
You will have access to the OTB source code, to the Software User’s
Guide and to the Cookbook of the last release. Binary packages are also
provided for the current version. OTB and Monteverdi are also integrated
in OSGeo-Live since version 4.5. You can find more information about the
project at http://live.osgeo.org/. Moreover you can found the last
release of Monteverdi and OTB applications through the OSGeo4W
installer.
How to get the latest bleeding-edge version?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can get the current development version, as our repository is
public, using Git (available at http://git-scm.com). Be aware that, even
if the golden rule is *what is committed will compile*, this is not
always the case. Changes are usually more than ten per day.
The first time, you can get the source code using:
::
git clone https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb.git
Then you can build OTB as usual using this directory as the source
(refer to build instructions). Later if you want to update your source,
from OTB's source directory, just do:
::
git pull
A simple ``make`` in your OTB binary directory will be enough to update
the library (recompiling only the necessary files).
Special issues about compiling OTB from source
----------------------------------------------
All information about OTB compilation can be found in the Software Guide.
We present here only the special issues which can be encountered.
Debian Linux / Ubuntu
~~~~~~~~~~~~~~~~~~~~~
On some Debian and Ubuntu versions, the system GDAL library and its tiff
internal symbol might conflict with the system Tiff library
(bugs.debian.org/558733). This is most likely the case if you get odd
segmentation fault whenever trying to open a tiff image. This symbol
clash happens when using OTB. A workaround to the issue has been
provided in GDAL sources, but is available in the 1.9.0 release.
The recommended procedure is to get this recent source and build GDAL
from sources, with the following configure command:
::
./configure --prefix=INSTALL_DIR --with-libtiff=internal
--with-geotiff=internal
--with-rename-internal-libtiff-symbols=yes
--with-rename-internal-libgeotiff-symbol=yes
Errors when compiling internal libkml
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The internal version of libkml cannot be compiled when using an external
build of ITK. See http://bugs.orfeo-toolbox.org/view.php?id=879 for more
details.
To workaround the problem, either use an external build of libkml (it is
provided on most systems), or use an internal build of ITK by setting to
OFF the CMake variable OTB\_USE\_EXTERNAL\_ITK.
OTB compilation and Windows platform
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To build OTB on Windows, you should prepare an environment with the following
tools:
* Visual Studio 2015 or later
* CMake 3.1 or later
* OTB XDK : download a Windows binary package of OTB and use the supplied
uninstall script to remove OTB binaries and headers. Now, this package only
contains the dependencies needed to build OTB.
Then, you can download OTB sources (preferably, a version compatible with your
XDK), and compile them as a standard CMake project. More details are available
in the SoftwareGuide.
There is an other solution, using OSGeo4W distribution. However, the
dependencies may be outdated.
Using OTB
---------
......@@ -304,53 +114,3 @@ be unique, the first library *SomeLib* loaded will be used by any other binary
depending on it. Thus, the order of the imports has an effect. In some cases,
symbol problems have been observed in libcrypto, and the solution was to import
OTB Applications before importing Fiona.
Getting help
------------
Is there any mailing list?
~~~~~~~~~~~~~~~~~~~~~~~~~~
Yes. There is a discussion group at
http://groups.google.com/group/otb-users/ where you can get help on the
set up and the use of OTB.
Which is the main source of documentation?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The main source of documentation is the CookBook located at
https://www.orfeo-toolbox.org/CookBook/.
Secondly there is the OTB Software Guide which can be
found at https://www.orfeo-toolbox.org/SoftwareGuide/
It contains many examples and a tutorial which should be a good
starting point for any new OTB user. The code source for these examples
is distributed with the toolbox. Another information source is the
on-line API documentation which is available at
http://www.orfeo-toolbox.org/doxygen.
You can also find some information about how to use Monteverdi and the
OTB-Applications into the Cookbook at
http://www.orfeo-toolbox.org/CookBook/.
Contributing to OTB
-------------------
I want to contribute to OTB, where to begin?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are many ways to join us in the OTB adventure. The more people
contribute, the better the library is for everybody!
First, you can send an email to the user mailing list
(otb-users@googlegroups.com) to let us know what functionality you would
like to introduce in OTB. If the functionality seems important for
OTB users, we will then discuss on how to retrieve your code, make the
necessary adaptions, check with you that the results are correct and
finally include it in the next release.
You can also run the nightly tests so we have a wider range of platforms
to detect bugs earlier.
You can also find more information about how to contribute at
https://www.orfeo-toolbox.org/community
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