Commit 6af43c25 authored by Cyrille Valladeau's avatar Cyrille Valladeau
Browse files

ENH: update docexample to the new framework for Projections appli

parent 75d0414f
......@@ -58,9 +58,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine BundleToPerfectSensor ${OTB-BIN}/bin "
"--inp ${OTB-Data}/Examples/QB_Toulouse_Ortho_PAN.tif --inxs ${OTB-Data}/Examples/QB_Toulouse_Ortho_XS.tif "
"--out PanSharpenedImage.tif");
AddDocTag(Tags::Geometry);
AddDocTag(Tags::Manip);
AddDocTag(Tags::Pansharpening);
......@@ -83,6 +81,16 @@ private:
MandatoryOff("lms");
MandatoryOff("dem");
MandatoryOff("ram");
SetDocCLExample("otbApplicationLauncherCommandLine BundleToPerfectSensor ${OTB-BIN}/bin "
"--inp ${OTB-Data}/Examples/QB_Toulouse_Ortho_PAN.tif --inxs ${OTB-Data}/Examples/QB_Toulouse_Ortho_XS.tif "
"--out PanSharpenedImage.tif");
// Doc example parameter settings
SetDocExampleParameterValue("inp", "QB_Toulouse_Ortho_PAN.tif");
SetDocExampleParameterValue("inxs", "QB_Toulouse_Ortho_XS.tif");
SetDocExampleParameterValue("out", "BundleToPerfectSensor.png uchar");
}
void DoUpdateParameters()
......
......@@ -68,7 +68,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine ConvertCartoToGeoPoint ${OTB-BIN}/bin --carto.x 367074.625 --carto.y 4835740 --mapproj utm --mapproj.utm.hemisphere true --mapproj.utm.zone 31");
AddDocTag(Tags::Coordinates);
AddDocTag(Tags::Geometry);
}
......@@ -147,6 +147,15 @@ private:
AddParameter(ParameterType_Float, "lat", "Output lat");
SetParameterDescription("lat", "Point latitude coordinates.");
SetParameterRole("lat", Role_Output);
SetDocCLExample("otbApplicationLauncherCommandLine ConvertCartoToGeoPoint ${OTB-BIN}/bin --carto.x 367074.625 --carto.y 4835740 --mapproj utm --mapproj.utm.hemisphere true --mapproj.utm.zone 31");
// Doc example parameter settings
SetDocExampleParameterValue("carto.x", "367074.625");
SetDocExampleParameterValue("carto.y", "4835740");
SetDocExampleParameterValue("mapproj", "utm");
SetDocExampleParameterValue("mapproj.utm.hemisphere", "true");
SetDocExampleParameterValue("mapproj.utm.zone", "31");
}
void DoUpdateParameters()
......
......@@ -55,8 +55,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine ImageEnvelope ${OTB-BIN}/bin "
"--in ${OTB-Data}/Input/sensor_stereo_left.tif --out envelope.shp");
AddDocTag(Tags::Geometry);
}
......@@ -85,6 +84,12 @@ private:
SetParameterDescription("proj", "Projection to be used to compute the envelope (default is WGS84)");
MandatoryOff("proj");
SetDocCLExample("otbApplicationLauncherCommandLine ImageEnvelope ${OTB-BIN}/bin "
"--in ${OTB-Data}/Input/sensor_stereo_left.tif --out envelope.shp");
// Doc example parameter settings
SetDocExampleParameterValue("in", "sensor_stereo_left.tif");
SetDocExampleParameterValue("out", "ImageEnvelope.shp");
}
void DoUpdateParameters()
......
......@@ -100,7 +100,7 @@ private:
SetDocLimitations("Supported sensors are SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("Ortho-rectification chapter from the OTB Software Guide");
SetDocCLExample(" ");
AddDocTag(Tags::Manip);
AddDocTag(Tags::Geometry);
}
......@@ -219,6 +219,9 @@ private:
SetDefaultParameterFloat("opt.gridspacing", 4.);
SetParameterDescription("opt.gridspacing", "Resampling is done according to a coordinate mapping grid, whose pixel size is set by this parameter. The closer to the output spacing this parameter is, the more precise will be the ortho-rectified image, but increasing this parameter allows to reduce processing time.");
MandatoryOff("opt.gridspacing");
// TODO Doc example parameter settings
//SetDocExampleParameterValue("", "");
}
void DoUpdateParameters()
......
......@@ -55,7 +55,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("Translation application");
SetDocCLExample("otbApplicationLauncherCommandLine RigidTransformResample ${OTB-BIN}/bin --in ${OTB-Data}/Input/poupees.tif --out rigitTransformImage.tf --tx 5 --ty 5");
AddDocTag("Conversion");
AddDocTag(Tags::Geometry);
}
......@@ -101,6 +101,12 @@ private:
// Output Image
SetParameterOutputImage("out", m_Resampler->GetOutput());
// Doc example parameter settings
SetDocExampleParameterValue("in", "poupees.tif");
SetDocExampleParameterValue("out", "rigitTransformImage.tif");
SetDocExampleParameterValue("tx", "5");
SetDocExampleParameterValue("ty", "5");
}
ResampleFilterType::Pointer m_Resampler;
......
......@@ -60,9 +60,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine Superimpose ${OTB-BIN}/bin "
"--inr ${OTB-Data}/Examples/QB_Toulouse_Ortho_PAN.tif --inm ${OTB-Data}/Examples/QB_Toulouse_Ortho_XS.tif "
"--out otbSuperimposedXS_to_PAN.tif");
AddDocTag(Tags::Geometry);
AddDocTag(Tags::Manip);
AddDocTag("Superimposition");
......@@ -88,6 +86,11 @@ private:
MandatoryOff("dem");
MandatoryOff("lms");
MandatoryOff("ram");
// Doc example parameter settings
SetDocExampleParameterValue("inr", "QB_Toulouse_Ortho_PAN.tif");
SetDocExampleParameterValue("inm", "QB_Toulouse_Ortho_XS.tif");
SetDocExampleParameterValue("out", "SuperimposedXS_to_PAN.tif");
}
void DoUpdateParameters()
......
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