Skip to content
Snippets Groups Projects
Commit e3ce462b authored by Aurélien Bricier's avatar Aurélien Bricier
Browse files

DOC: added documentation to NaryParserImageFilter

parent 9b1c2139
Branches
Tags
No related merge requests found
...@@ -32,10 +32,33 @@ namespace otb ...@@ -32,10 +32,33 @@ namespace otb
{ {
/** \class NaryParserImageFilter /** \class NaryParserImageFilter
* \brief Performs a mathematical operation on the input images * \brief Performs a mathematical operation on the input images
* according to the formula specified by the user * according to the formula specified by the user.
*
* This filter is based on the math parser library muParser.
* The built in function and operator list is available at:
* http://muparser.sourceforge.net/mup_features.html#idDef2
*
* OTB specific additional functions :
* ndvi(r, niri)
*
* OTB specific additional contants :
* e - log2e - log10e - ln2 - ln10 - pi - euler
* *
* In order to use this filter, at least one input image is to be
* set. A associated variable name can be spécified or not by using
* the corresponding SetNthInput method. For the nth input image, if
* no associated variable name has been spefified, a default variable
* name is given by concatenating the letter "b" (for band) and the
* coresponding n.
* 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 :
* "ndvi(b1,b2)*b3"
*
* \sa Parser * \sa Parser
* *
* \ingroup Streamed
* \ingroup Threaded
*/ */
template< class TImage > template< class TImage >
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment