Commit 4021ba31 authored by Christophe Palmann's avatar Christophe Palmann

BandMathX app: documentation improved

parent f3d25eb8
......@@ -113,11 +113,22 @@ private:
"\n\n"
"- Application itself:\n\n"
"Setting the list of inputs can be done with the 'il' parameter.\n"
"Setting an expression can be done with the 'exp' parameter.\n"
"Setting the output image can be done with the 'out' parameter.\n"
"The application takes the following parameters :"
"- Setting the list of inputs can be done with the 'il' parameter.\n"
"- Setting expressions can be done with the 'exp' parameter. Separating expressions by semi-colons (;) will concatenate their results into one multiband output image.\n"
"Adding expressions without the use of semi-colons will produce additional output images (not implemented yet).\n"
"- Setting constants can be done with the 'incontext' parameter. User must provide a txt file with a specific syntax: #type name value\n"
"An example of such a file is given below:\n\n"
"#F expo 1.1\n"
"#M kernel1 { 0.1 , 0.2 , 0.3 ; 0.4 , 0.5 , 0.6 ; 0.7 , 0.8 , 0.9 ; 1 , 1.1 , 1.2 ; 1.3 , 1.4 , 1.5 }\n"
"\nAs we can see, #I/#F allows the definition of an integer/float constant, whereas #M allows the definition of a vector/matrix.\n"
"In the latter case, elements of a row must be separated by comma, and rows must be separated by semicolons.\n"
"It is also possible to define expressions within the same txt file, with the pattern #E expr; they will be added to the list of expressions to be applied. For instance:\n\n"
"#E conv(kernel1,im1b1N3x5) ; im2b1^expo\n"
"\n- The 'outcontext' parameter allows to save user's constants and expressions (context).\n"
"- Setting the output image can be done with the 'out' parameter (multi-outputs is not implemented yet).\n"
"\n\n"
"Finally, we strongly recommend that the reader takes a look at the cookbook, where additional information can be found.\n"
"Finally, we strongly recommend that the reader takes a look at the cookbook, where additional information can be found (http://www.orfeo-toolbox.org/packages/OTBCookBook.pdf).\n"
);
......@@ -134,9 +145,9 @@ private:
AddRAMParameter();
AddParameter(ParameterType_StringList, "exp", "Expression");
AddParameter(ParameterType_StringList, "exp", "Expressions");
SetParameterDescription("exp",
"The mathematical expression to apply.");
"Mathematical expressions to apply.");
MandatoryOff("exp");
AddParameter(ParameterType_String, "incontext", "Import context");
......@@ -146,7 +157,7 @@ private:
AddParameter(ParameterType_String, "outcontext", "Export context");
SetParameterDescription("outcontext",
"A txt file containing user's constants and expressions.");
"A txt file where to save user's constants and expressions.");
MandatoryOff("outcontext");
// Doc example parameter settings
......
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