Commit 39dc41cc authored by Victor Poughon's avatar Victor Poughon

DOC: remove references to the SG in other docs

parent e09a54c1
Pipeline #529 passed with stage
in 26 minutes and 47 seconds
......@@ -39,14 +39,14 @@ template for in depth description called 'Request for Comments'.
## Documentation improvements
The two main OTB documentations are the [Software Guide](https://www.orfeo-toolbox.org/SoftwareGuide/index.html)
and the [CookBook](https://www.orfeo-toolbox.org/CookBook/). Their sources are
The main OTB documentation is
the [CookBook](https://www.orfeo-toolbox.org/CookBook/). The source is
hosted in the main OTB repository in the `Documentation/` directory. Then, to
contribute documentation use the same workflow as for code contributions (see
below).
See also the [Compiling documentation](https://wiki.orfeo-toolbox.org/index.php/Compiling_documentation)
wiki page for help on building the Sphinx and Latex source.
See also the "Compiling documentation" section of the CookBook
for help on building the Sphinx source.
## Code contribution
......
Frequently Asked Questions
==========================
What's in OTB?
--------------
- Image access: optimized read/write access for most of remote sensing
image formats, meta-data access, simple visualization;
- Sensor geometry: sensor models, cartographic projections;
- Radiometry: atmospheric corrections, vegetation indices;
- Filtering: blurring, denoising, enhancement;
- Fusion: image pansharpening;
- Feature extraction: interest points, alignments, lines;
- Image segmentation: region growing, watershed, level sets;
- Classification: K-means, SVM, Markov random fields;
- Change detection.
- Object based image analysis.
- Geospatial analysis.
For a full list of applications see the chapter :ref:`apprefdoc`.
For an introduction to the C++ API see the
`Software Guide <https://www.orfeo-toolbox.org/SoftwareGuide/>`_.
And for an exhaustive description of the C++ API see the
`Doxygen <https://www.orfeo-toolbox.org/doxygen/>`_.
License
-------
......
......@@ -32,10 +32,6 @@ joining `our community <https://www.orfeo-toolbox.org/community/>`_ and
For other documentation, be sure to read:
- OTB's website: `www.orfeo-toolbox.org <https://www.orfeo-toolbox.org/>`_
- `OTB Software Guide <http://orfeo-toolbox.org/SoftwareGuide/>`_ for advanced users and developers.
The software guide contains documented code examples,
descriptions of the ITK pipeline model, multithreading and
streaming functionalities, and an introduction to the C++ API.
- `Doxygen <http://orfeo-toolbox.org/doxygen/>`_, for exhaustive documentation
of the C++ API.
......
Feature extraction
==================
As described in the OTB Software Guide, the term *Feature Extraction*
The term *Feature Extraction*
refers to techniques aiming at extracting added value information from
images. These extracted items named *features* can be local statistical
moments, edges, radiometric indices, morphological and textural
......
......@@ -85,9 +85,7 @@ private:
SetDocLongDescription(
"The purpose of this application is "
"to present parameters types,"
" and Application class framework. "
"It is used to generate Software guide documentation"
" for Application chapter example.");
" and Application class framework. ");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
......@@ -182,14 +180,12 @@ private:
// \code{DoUpdateParameters()} is called as soon as a parameter value change. Section \ref{sec:appDoUpdateParameters}
// gives a complete description of this method.
// Software Guide :BeginCodeSnippet
void DoUpdateParameters() override
{
}
// \code{DoExecute()} contains the application core. Section \ref{sec:appDoExecute}
// gives a complete description of this method.
// Software Guide :BeginCodeSnippet
void DoExecute() override
{
FloatVectorImageType::Pointer inImage = GetParameterImage("in");
......@@ -201,7 +197,6 @@ private:
SetParameterOutputImage("out", inImage);
}
// Software Guide :EndCodeSnippet
};
} // namespace Wrapper
} // namespace otb
......
......@@ -23,8 +23,6 @@
*/
// Software Guide : BeginDescription
//
// This filter is based on the mathematical parser library muParser.
// The built in functions and operators list is available at:
// http://muparser.sourceforge.net/mup_features.html.
......@@ -39,8 +37,6 @@
// The next step is to set the expression according to the variable
// names. For example, in the default case with three input images the
// following expression is valid: ``(b1+b2)*b3``.
//
// Software Guide : EndDescription
#include "itkMacro.h"
#include <iostream>
......
......@@ -29,12 +29,8 @@
*/
// Software Guide : BeginDescription
//
// This example illustrates the use of the LineSegmentDetector.
// This filter is designed to extract segments in mono channel images.
//
// Software Guide : EndDescription
#include "otbLineSegmentDetector.h"
......
......@@ -109,12 +109,10 @@ int main(int argc, char* argv[])
height = demHandler->GetHeightAboveEllipsoid(point);
std::cout << "height above ellipsoid (" << longitude << ", " << latitude << ") = " << height << " meters" << std::endl;
//
// Note that OSSIM internal calls for sensor
// modelling use the height above ellipsoid, and follow the same logic as the
// \code{GetHeightAboveEllipsoid()} method.
//
// Software Guide : EndLatex
// Check for Nan
if (vnl_math_isnan(height))
......
......@@ -103,7 +103,7 @@ int main(int argc, char* argv[])
TargetListSample->PushBack(label);
}
// Displays the corresponding values (not into the Software Guide)
// Displays the corresponding values
for (int i = 0; i < nbSamples; ++i)
{
std::cout << i + 1 << "-label = " << TargetListSample->GetMeasurementVector(i) << std::endl;
......
......@@ -12,15 +12,8 @@ Specifically, the purpose of these examples is as follows:
to use them. The examples have minimal dependencies on outside packages;
and if they do, there should be CMake flags to turn them off.
* Provide a consistent set of examples that will work in conjunctions with
the OTB Software Guide.
* Provide a consistent set of examples that will work with OTB tutorials
and courses.
* Make sure that the code is well documented, of consistent style, and
always up-to-date with the current OTB code.
To learn the software from these examples, you may wish to refer to the
"ORFEO Toolbox Software Guide".
......@@ -101,7 +101,7 @@ private:
SetDocLongDescription(oss.str());
SetDocLimitations("Supported sensors (both optical and radar) are: GeoEye, Ikonos, Pleiades, Quickbird, RadarSat, Sentinel-1, SPOT5 (TIF format), SPOT6/7, TerraSAR-X, Worldview 1/2/3, and any TIF image with embedded RPC tags.\n Also note that the opt.gridspacing default value may not be suitable for all sensors. In particular, if this value is lower than the target ground sampling distance, the processing time may increase a lot. A warning is issued in this case. Typical values should be half the DEM ground sampling distance.");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("Ortho-rectification chapter from the OTB Software Guide");
SetDocSeeAlso(" ");
AddDocTag(Tags::Geometry);
......
......@@ -91,7 +91,7 @@ SetDocLongDescription(
"sharpness homogeneity), Low Grey-Level Run Emphasis, High Grey-Level Run Emphasis, "
"Short Run Low Grey-Level Emphasis, Short Run High Grey-Level Emphasis, Long Run Low "
"Grey-Level Emphasis and Long Run High Grey-Level Emphasis.\n\n"
"The documentation of textures (description are formulas) are available in the OTB Software Guide (section Textures) and also in corresponding doxygen "
"The documentation of textures (description are formulas) are available in the OTB CookBook (section Textures) and also in corresponding doxygen "
"documentation of filters (see section *Detailed Description* in doxygen):\n"
"* **simple**: otbScalarImageToTexturesFilter\n"
"* **advanced**: otbScalarImageToAdvancedTexturesFilter\n"
......
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