Commit 1eb482a3 authored by Ralf Mueller's avatar Ralf Mueller
Browse files

[mapReduce] rename reduce to reducegrid; improve doc about it

parent a9d36698
......@@ -99,7 +99,7 @@ Operator catalog:
Cond2 ifthenelse If then else
Condc ifthenc If then constant
Condc ifnotthenc If not then constant
MapReduce reduce Reduce input file variables to locations, where mask is non-zero.
MapReduce reducegrid Reduce input file variables to locations, where mask is non-zero.
-------------------------------------------------------------
Comparison
-------------------------------------------------------------
......
......@@ -5,7 +5,7 @@
@Section = Conditional selection
@Class = Conditional
@Arguments = ifile ofile
@Operators = reduce
@Operators = reducegrid
@BeginDescription
This module holds an operator for data reduction based on a user defined mask.
......@@ -15,20 +15,18 @@ avoided by using the additional 'nobounds' keyword.
@EndModule
@BeginOperator_reduce
@Name = reduce
@BeginOperator_reducegrid
@Name = reducegrid
@Title = Reduce input file variables to locations, where mask is non-zero.
Horizontal grids of @file{mask} and @file{ifile} must be identical
@Parameter = mask [nobounds|nocoords]
@Parameter = mask[,limitCoordsOutput]
@EndOperator
@BeginParameter
@Item = mask
STRING file which holds the mask field
@Item = nobounds
STRING if given, coordinated bounds are not written to output
@Item = nocoords
STRING if given, coordinates and bounds are not written to output
@Item = limitCoordsOutput
STRING optional parameter to limit the amount of coordinates: 'nobounds' disables coordinate bounds in the output, 'nocoords' avoids all coordinate information
@EndParameter
@BeginExample
......@@ -45,9 +43,9 @@ Note that output file type is NetCDF, because unstructured grids cannot be store
@EndExample
@BeginOperator_unreduce
@Name = unpack
@Title = Unpack input fields to given grid description
@BeginOperator_expandgrid
@Name = expandgrid
@Title = Unpack input fields to given grid description - reverse operators of reducegrid
@Parameter = grid
@BeginDescription
......
......@@ -740,10 +740,10 @@ static const char *CondcHelp[] = {
static const char *MapReduceHelp[] = {
"NAME",
" reduce - Reduce fields to user-defined mask",
" reducegrid - Reduce fields to user-defined mask",
"",
"SYNOPSIS",
" reduce,mask[,nobounds|nocoords] ifile ofile",
" reducegrid,mask[,limitCoordsOutput] ifile ofile",
"",
"DESCRIPTION",
" This module holds an operator for data reduction based on a user defined mask.",
......@@ -751,9 +751,8 @@ static const char *MapReduceHelp[] = {
" avoided by using the additional 'nobounds' keyword.",
"",
"PARAMETER",
" mask STRING file which holds the mask field",
" nobounds STRING if given, coordinated bounds are not written to output",
" nocoords STRING if given, coordinates and bounds are not written to output",
" mask STRING file which holds the mask field",
" limitCoordsOutput STRING optional parameter to limit the amount of coordinates: 'nobounds' disables coordinate bounds in the output, 'nocoords' avoids all coordinate information",
NULL
};
......
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