Commit 63d2452e authored by Victor Poughon's avatar Victor Poughon
Browse files

DOC: Fix cookbook images

parent 191e8808
This diff is collapsed.
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -18,6 +18,12 @@ configure_file(${CookBook_SOURCE_DIR}/CMake/RunApplicationsRstGenerator.sh.cmake
${RST_GENERATED_SOURCE_DIR}/RunApplicationsRstGenerator.sh
@ONLY)
file(GLOB images ${CookBook_SOURCE_DIR}/Art/*.*)
foreach(image ${images})
get_filename_component(out_file ${image} NAME)
configure_file(${image} ${RST_GENERATED_SOURCE_DIR}/Art/${out_file} COPYONLY)
endforeach()
file(GLOB mvd_images ${CookBook_SOURCE_DIR}/Art/MonteverdiImages/*.*)
foreach(mvd_image ${mvd_images})
# message(${mvd_image})
......@@ -72,4 +78,4 @@ add_custom_target(CookBookHTMLFromRST
# WORKING_DIRECTORY ${RST_SOURCES}/RST
# COMMENT "Building RST documentation in html")
# ADD_DEPENDENCIES(CookBookHTMLFromPDF CookBookHTMLFromRST)
\ No newline at end of file
# ADD_DEPENDENCIES(CookBookHTMLFromPDF CookBookHTMLFromRST)
[t][10cm][b] |image|
| *The ORFEO Toolbox is not a black box.*
Ch.D.
Foreword
========
Since 2006, the **Orfeo ToolBox**has become a rich library used in many
remote sensing context, from research work to operational systems. The
**OTB Applications**and more recently the Monteverdi tool has helped to
broaden the audience of the library, giving access to its
functionalities to non-developers.
Meanwhile, the `OTB Software
Guide <http://orfeo-toolbox.org/SoftwareGuide/>`__has grown to more than
700 pages of documented code examples, which, combined with the class
documentation with the `Doxygen <http://orfeo-toolbox.org/doxygen/>`__,
allows developer users to find their way through the **Orfeo ToolBox**so
as to write code suiting their needs.
Yet, the documentation available for non-developers users, using
Monteverdi and **OTB Applications**to perform everyday remote sensing
tasks, has been almost inexistent for all these years, and these users
had to learn the software by themselves or ask for help from more
experienced users. This cookbook aims at fulfilling the need for an
appropriate documentation of the applications built upon the **Orfeo
ToolBox**: **Monteverdi**, and **OTB Applications**, which are now
integrated into the main **Orfeo ToolBox**package and provide several
access mode (command-line, QT interface, QGis plugins, other languages
…).
A general introduction to these tools is first presented, along with
installation instructions. Rather than describing all modules and
applications in an exhaustive way, we then decided to focus on very
common remote sensing tasks, detailing how they can be achieved with
either **Monteverdi**or an application.
For more information on the **Orfeo ToolBox**, please feel free to visit
the `Orfeo ToolBox website <http://orfeo-toolbox.org>`__.
.. |image| image:: ../Art/logoVectoriel.pdf
......@@ -534,13 +534,10 @@ mandatory parameters cannot be unchecked.
The interface of the application is shown here as an example.
|image| [fig:rescaleParam]
|image| [fig:rescaleLogs]
|image| [fig:rescaleProgress]
|image| [fig:rescaleDocumentation]
.. figure:: Art/QtImages/rescale_param.png
.. figure:: Art/QtImages/rescale_logs.png
.. figure:: Art/QtImages/rescale_progress.png
.. figure:: Art/QtImages/rescale_documentation.png
Using the Python interface
~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -673,7 +670,7 @@ toolbox, which is accessible with Processing :math:`\rightarrow`
Toolbox. Switch to “advanced interface” in the bottom of the application
widget and OTB applications will be there.
|image| [fig:otb-qgis]
.. figure:: Art/QtImages/qgis-otb.png
Using a custom OTB
^^^^^^^^^^^^^^^^^^
......@@ -682,16 +679,9 @@ If QGIS cannot find OTB, the “applications folder” and “binaries folder”
can be set from the settings in the Processing :math:`\rightarrow`
Settings :math:`\rightarrow` “service provider”.
|image| [fig:otb-qgis-settings]
.. figure:: Art/QtImages/qgis-otb-settings.png
On some versions of QGIS, if an existing OTB installation is found, the
textfield settings will not be shown. To use a custom OTB instead of the
existing one, you will need to replace the otbcli, otbgui and library
files in QGIS installation directly.
.. |image| image:: ../Art/QtImages/rescale_param.png
.. |image| image:: ../Art/QtImages/rescale_logs.png
.. |image| image:: ../Art/QtImages/rescale_progress.png
.. |image| image:: ../Art/QtImages/rescale_documentation.png
.. |image| image:: ../Art/QtImages/qgis-otb.png
.. |image| image:: ../Art/QtImages/qgis-otb-settings.png
......@@ -24,7 +24,8 @@ cd $HOME/sources
git clone https://github.com/CS-SI/OTB-Documents
ii). Run cmake to configure cookbook build
ii). Run cmake to configure cookbook build, you wil need to add /path/where/you/installed/otb/lib/python to PYTHONPATH
and /path/where/you/installed/otb/lib/applications to ITK_AUTOLOAD_PATH:
mkdir ~/build-cookbook
......@@ -43,4 +44,4 @@ open the cookbook documentation in a firefox tab!
firefox ~/build-cookbook/rst/_build/html/index.html
TODO: include Applications/app_* file if they exists
\ No newline at end of file
TODO: include Applications/app_* file if they exists
......@@ -6,10 +6,49 @@
Welcome to OTB CookBook's documentation!
========================================
.. image:: Art/logo.png
*The ORFEO Toolbox is not a black box.*
Foreword
========
Since 2006, Orfeo ToolBox has become a rich library used in many
remote sensing context, from research work to operational systems. The
OTB Applications and more recently the Monteverdi tool has helped to
broaden the audience of the library, giving access to its
functionalities to non-developers.
Meanwhile, the `OTB Software
Guide <http://orfeo-toolbox.org/SoftwareGuide/>`__has grown to more than
700 pages of documented code examples, which, combined with the class
documentation with the `Doxygen <http://orfeo-toolbox.org/doxygen/>`__,
allows developer users to find their way through the Orfeo ToolBox so
as to write code suiting their needs.
Yet, the documentation available for non-developers users, using
Monteverdi and OTB Applications to perform everyday remote sensing
tasks, has been almost inexistent for all these years, and these users
had to learn the software by themselves or ask for help from more
experienced users. This cookbook aims at fulfilling the need for an
appropriate documentation of the applications built upon the Orfeo
ToolBox: Monteverdi, and OTB Applications, which are now
integrated into the main Orfeo ToolBox package and provide several
access mode (command-line, QT interface, QGis plugins, other languages
...).
A general introduction to these tools is first presented, along with
installation instructions. Rather than describing all modules and
applications in an exhaustive way, we then decided to focus on very
common remote sensing tasks, detailing how they can be achieved with
either Monteverdi or an application.
For more information on the Orfeo ToolBox, please feel free to visit
the `Orfeo ToolBox website <http://orfeo-toolbox.org>`__.
.. toctree::
:maxdepth: 3
:maxdepth: 2
CookBook
OTB-Applications
Monteverdi
Recipes
......
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