Commit 213d42ff authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

remapdis: docu update

parent ea9297c7
No preview for this file type
...@@ -19,11 +19,11 @@ For a detailed description of the interpolation method see @cite{SCRIP}. ...@@ -19,11 +19,11 @@ For a detailed description of the interpolation method see @cite{SCRIP}.
@BeginOperator_remapdis @BeginOperator_remapdis
@Name = remapdis @Name = remapdis
@Title = Distance-weighted average remapping @Title = Distance-weighted average remapping
@Parameter = grid @Parameter = grid [neighbors]
@BeginDescription @BeginDescription
Performs a distance-weighted average remapping of the four nearest neighbor Performs a distance-weighted average remapping of the nearest neighbors value on all input fields.
values on all input fields. The default number of nearest neighbors is 4.
@EndDescription @EndDescription
@EndOperator @EndOperator
...@@ -44,7 +44,9 @@ Use the operator @mod{remap} to apply this remapping weights to a data file with ...@@ -44,7 +44,9 @@ Use the operator @mod{remap} to apply this remapping weights to a data file with
@BeginParameter @BeginParameter
@Item = grid @Item = grid
STRING Target grid description file or name STRING Target grid description file or name
@Item = neighbors
INTEGER Number of nearest neighbors
@EndParameter @EndParameter
......
...@@ -3486,7 +3486,8 @@ static const char *RemapdisHelp[] = { ...@@ -3486,7 +3486,8 @@ static const char *RemapdisHelp[] = {
" remapdis, gendis - Distance-weighted average remapping", " remapdis, gendis - Distance-weighted average remapping",
"", "",
"SYNOPSIS", "SYNOPSIS",
" <operator>,grid ifile ofile", " remapdis,grid[,neighbors] ifile ofile",
" gendis,grid ifile ofile",
"", "",
"DESCRIPTION", "DESCRIPTION",
" This module contains operators for a distance-weighted average remapping of the four", " This module contains operators for a distance-weighted average remapping of the four",
...@@ -3496,8 +3497,8 @@ static const char *RemapdisHelp[] = { ...@@ -3496,8 +3497,8 @@ static const char *RemapdisHelp[] = {
"", "",
"OPERATORS", "OPERATORS",
" remapdis Distance-weighted average remapping", " remapdis Distance-weighted average remapping",
" Performs a distance-weighted average remapping of the four nearest neighbor ", " Performs a distance-weighted average remapping of the nearest neighbors value on all input fields.",
" values on all input fields.", " The default number of nearest neighbors is 4.",
" gendis Generate distance-weighted average remap weights", " gendis Generate distance-weighted average remap weights",
" Generates distance-weighted average remapping weights of the four nearest neighbor", " Generates distance-weighted average remapping weights of the four nearest neighbor",
" values for the first input field and writes the result to a file.", " values for the first input field and writes the result to a file.",
...@@ -3505,7 +3506,8 @@ static const char *RemapdisHelp[] = { ...@@ -3505,7 +3506,8 @@ static const char *RemapdisHelp[] = {
" Use the operator remap to apply this remapping weights to a data file with the same source grid.", " Use the operator remap to apply this remapping weights to a data file with the same source grid.",
"", "",
"PARAMETER", "PARAMETER",
" grid STRING Target grid description file or name", " grid STRING Target grid description file or name",
" neighbors INTEGER Number of nearest neighbors",
"", "",
"ENVIRONMENT", "ENVIRONMENT",
" REMAP_EXTRAPOLATE", " REMAP_EXTRAPOLATE",
......
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