Skip to content
Snippets Groups Projects
Commit e7337657 authored by Mickael Savinaud's avatar Mickael Savinaud
Browse files

DOC: udpate doc of muparserX app to avoid issue with cookbook

parent eb5fc2e1
No related branches found
No related tags found
No related merge requests found
......@@ -59,12 +59,12 @@ private:
"The syntax is mainly constrained by the muparserx library, which can be considered as the core of the application.\n"
"\n\n"
"- Fundamentals:\n\n"
"The default prefix name for variables related to the ith input is « im(i+1) » (note the indexing from 1 to N, for N inputs). \n"
"The default prefix name for variables related to the ith input is 'im(i+1)'(note the indexing from 1 to N, for N inputs). \n"
"The following list summaries the available variables for input #0 (and so on for every input): \n"
"\n"
"im1 --> a pixel from first input, made of n components (n bands)\n"
"im1bj --> jth component of a pixel from first input (first band is indexed by 1)\n"
"im1bjNkxp --> a neighbourhood (“N”) of pixels of the jth component from first input, of size kxp\n"
"im1bjNkxp --> a neighbourhood ('N') of pixels of the jth component from first input, of size kxp\n"
"im1PhyX and im1PhyY --> spacing of first input in X and Y directions (horizontal and vertical)\n"
"im1bjMean im1bjMin im1bjMax im1bjSum im1bjVar --> mean, min, max, sum, variance of jth band from first input (global statistics)\n"
"\nMoreover, we also have the following generic variables:\n"
......@@ -105,7 +105,7 @@ private:
"- Operators:\n\n"
"In addition to the previous operators, other operators are available:\n"
"- existing operators/functions from muParserX, that were not originally defined for vectors and\n"
"matrices (for instance cos, sin, ...). These new operators/ functions keep the original names to which we added the prefix ”v” for vector (vcos, vsin, ...).\n"
"matrices (for instance cos, sin, ...). These new operators/ functions keep the original names to which we added the prefix 'v' for vector (vcos, vsin, ...).\n"
"- mult, div and pow operators, that perform element-wise multiplication, division or exponentiation of vector/matrices (for instance im1 div im2)\n"
"- mlt, dv and pw operators, that perform multiplication, division or exponentiation of vector/matrices by a scalar (for instance im1 dv 2.0)\n"
"- bands, which is a very usefull operator. It allows to select specific bands from an image, and/or to rearrange them in a new vector;\n"
......@@ -125,7 +125,7 @@ private:
"\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 commas, 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. For instance (two expressions; see also limitations section below):\n\n"
"#E dotpr(kernel1,im1b1N3x5); im2b1^expo\n"
"#E $dotpr(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"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment