Commit 0a7a735d authored by Julien Michel's avatar Julien Michel
Browse files

Merge branch 'app_docsprint' of https://git.orfeo-toolbox.org/git/otb into app_docsprint

No related merge requests found
Showing with 31 additions and 16 deletions
+31 -16
...@@ -53,40 +53,55 @@ private: ...@@ -53,40 +53,55 @@ private:
void DoInit() ITK_OVERRIDE void DoInit() ITK_OVERRIDE
{ {
SetName("OSMDownloader"); SetName("OSMDownloader");
SetDescription("Generate a vector data from OSM on the input image extend"); SetDescription("Download vector data from OSM and store it to file");
// Documentation // Documentation
SetDocName("Open Street Map layers importations applications"); SetDocName("Open Street Map layers import");
SetDocLongDescription("Generate a vector data from Open Street Map data. A DEM could be use. By default, the entire layer is downloaded, an image can be use as support for the OSM data. The application can provide also available classes in layers . This application required an Internet access. Information about the OSM project : http://www.openstreetmap.fr/"); SetDocLongDescription("The application connects to Open Street Map server"
SetDocLimitations("None"); ", downloads the data corresponding to the spatial extent of the support"
" image, and filters the geometries based on OSM tags to produce a vector"
" data file.\n\n"
"This application can be used to download reference data to perform the "
"training of a machine learning model (see for instance [1]).\n\n"
"By default, the entire layer is downloaded. The application has a "
"special mode to provide the list of available classes in the layers. "
"The downloaded features are filtered by giving an OSM tag 'key'. In "
"addition, the user can also choose what 'value' this key should have. "
"More information about the OSM project at [2].");
SetDocLimitations("This application requires an Internet access.");
SetDocAuthors("OTB-Team"); SetDocAuthors("OTB-Team");
SetDocSeeAlso("Conversion"); SetDocSeeAlso("[1] TrainImagesClassifier \n"
"[2] http://www.openstreetmap.fr/");
AddDocTag("Miscellaneous"); AddDocTag("Miscellaneous");
AddDocTag(Tags::Meta); AddDocTag(Tags::Meta);
AddDocTag(Tags::Vector); AddDocTag(Tags::Vector);
AddParameter(ParameterType_OutputVectorData, "out", "Output vector data"); AddParameter(ParameterType_OutputVectorData, "out", "Output vector data");
SetParameterDescription("out", "Generated output vector data path"); SetParameterDescription("out", "Vector data file to store downloaded features");
AddParameter(ParameterType_InputImage, "support", "Support image"); AddParameter(ParameterType_InputImage, "support", "Support image");
SetParameterDescription("support", "Image used as support to estimate the models"); SetParameterDescription("support", "Image used to derive the spatial extent"
" to be requested from OSM server (the bounding box of the extent is "
"used). Be aware that a request with a large extent may be rejected by "
"the server.");
AddParameter(ParameterType_String, "key", "OSM tag key"); AddParameter(ParameterType_String, "key", "OSM tag key");
SetParameterDescription("key", "OSM tag key to extract (highway, building...)"); SetParameterDescription("key", "OSM tag key to extract (highway, building"
"...). It defines a category to select features.");
MandatoryOff("key"); MandatoryOff("key");
AddParameter(ParameterType_String, "value", "OSM tag value"); AddParameter(ParameterType_String, "value", "OSM tag value");
SetParameterDescription("value", "OSM tag value to extract (motorway, footway...)"); SetParameterDescription("value", "OSM tag value to extract (motorway, "
"footway...). It defines the type of feature to select inside a category.");
MandatoryOff("value"); MandatoryOff("value");
// Elevation // Elevation
ElevationParametersHandler::AddElevationParameters(this, "elev"); ElevationParametersHandler::AddElevationParameters(this, "elev");
AddParameter(ParameterType_Empty, "printclasses", "option to display available key/value classes"); AddParameter(ParameterType_Empty, "printclasses", "Displays available key/value classes");
std::ostringstream oss; SetParameterDescription("printclasses","Print the key/value classes "
oss << "Print the key/value classes available for the bounding box of the input image "<<std::endl; "available for the selected support image. If enabled, the OSM tag Key "
oss << "\t\t\t\t ** If not used : Note that the options OSMKey (-key) and Output (-out) become mandatory"; "(-key) and the output (-out) become optional" );
SetParameterDescription("printclasses", oss.str().c_str());
MandatoryOff("printclasses"); MandatoryOff("printclasses");
// Doc example parameter settings // Doc example parameter settings
......
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