Commit b1555673 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

added Remapdis docu

parent c3502c92
......@@ -199,6 +199,7 @@ doc/tex/mod/Remapbic -text
doc/tex/mod/Remapbil -text
doc/tex/mod/Remapcon -text
doc/tex/mod/Remapcon2 -text
doc/tex/mod/Remapdis -text
doc/tex/mod/Remapeta -text
doc/tex/mod/Remapgrid -text
doc/tex/mod/Remapycon -text
......
......@@ -448,16 +448,16 @@ Operator catalog:
Remapbil genbil Generate bilinear interpolation weights
Remapbic remapbic Bicubic interpolation
Remapbic genbic Generate bicubic interpolation weights
Remapdis remapdis Distance-weighted average remapping
Remapdis gendis Generate distance-weighted average remap weights
Remapycon remapycon First order conservative remapping
Remapycon genycon Generate 1st order conservative remap weights
Remapcon remapcon First order conservative remapping
Remapcon gencon Generate 1st order conservative remap weights
Remapcon2 remapcon2 Second order conservative remapping
Remapcon2 gencon2 Generate 2nd order conservative remap weights
Remapgrid remapdis Distance-weighted average remapping
Remapgrid remapnn Nearest neighbor remapping
Remapgrid remaplaf Largest area fraction remapping
Genweights gendis Generate distance-weighted average remap weights
Genweights gennn Generate nearest neighbor remap weights
Genweights genlaf Generate largest area fraction remap weights
Remap remap SCRIP grid remapping
......
......@@ -94,6 +94,7 @@ EOFs EOFs
Eofcoeff EOFs
Remapbil Interpolation
Remapbic Interpolation
Remapdis Interpolation
Remapycon Interpolation
Remapcon Interpolation
Remapcon2 Interpolation
......
......@@ -5,7 +5,7 @@
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = gendis gennn genlaf
@Operators = gennn genlaf
@BeginDescription
Interpolation between different horizontal grids can be a very time-consuming
......@@ -22,18 +22,6 @@ Each operator is using a different interpolation method.
@EndModule
@BeginOperator_gendis
@Name = gendis
@Title = Generate distance-weighted average remap weights
@Parameter = grid
@BeginDescription
Generates distance-weighted average remapping weights of the four
nearest neighbor values and writes the result to a file.
@EndDescription
@EndOperator
@BeginOperator_gennn
@Name = gennn
@Title = Generate nearest neighbor remap weights
......
@BeginModule
@NewPage
@Name = Remapdis
@Title = Distance-weighted average remapping
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = remapdis gendis
@BeginDescription
This module contains operators for a distance-weighted average remapping of the four
nearest neighbor values of fields between grids in spherical coordinates.
The interpolation is based on an adapted SCRIP library version.
For a detailed description of the interpolation method see @cite{SCRIP}.
This interpolation method only works on quadrilateral curvilinear source grids.
@EndDescription
@EndModule
@BeginOperator_remapdis
@Name = remapdis
@Title = Distance-weighted average remapping
@Parameter = grid
@BeginDescription
Performs a distance-weighted average remapping of the four nearest neighbor
values on all input fields.
@EndDescription
@EndOperator
@BeginOperator_gendis
@Name = gendis
@Title = Generate distance-weighted average remap weights
@Parameter = grid
@BeginDescription
Generates distance-weighted average remapping weights of the four nearest neighbor
values for the first input field and writes the result to a file.
The format of this file is netCDF following the SCRIP convention.
Use the operator @mod{remap} to apply this remapping weights to a data file with the same source grid.
@EndDescription
@EndOperator
@BeginParameter
@Item = grid
STRING Target grid description file or name
@EndParameter
@BeginEnvironment
@Item = REMAP_EXTRAPOLATE
This variable is used to switch the extrapolation feature 'on' or 'off'.
By default the extrapolation is enabled for this remapping method.
@Item = CDO_REMAP_RADIUS
Remap search radius in degree, default 180 degree.
@EndEnvironment
......@@ -5,7 +5,7 @@
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = remapdis remapnn remaplaf
@Operators = remapnn remaplaf
@BeginDescription
This module contains operators to remap all input fields to a new horizontal grid.
......@@ -17,18 +17,6 @@ The search algorithm for the conservative remapping requires that no grid cell o
@EndModule
@BeginOperator_remapdis
@Name = remapdis
@Title = Distance-weighted average remapping
@Parameter = grid
@BeginDescription
Performs a distance-weighted average remapping of the four nearest neighbor
values on all input fields.
@EndDescription
@EndOperator
@BeginOperator_remapnn
@Name = remapnn
@Title = Nearest neighbor remapping
......
......@@ -375,11 +375,12 @@ void *Maggraph(void *argument);
#define RemapOperators {"remap"}
#define RemapbilOperators {"remapbil", "genbil"}
#define RemapbicOperators {"remapbic", "genbic"}
#define RemapdisOperators {"remapdis", "gendis"}
#define RemapyconOperators {"remapycon", "genycon"}
#define RemapconOperators {"remapcon", "gencon"}
#define Remapcon2Operators {"remapcon2", "gencon2"}
#define RemapgridOperators {"remapdis", "remapnn", "remaplaf", "remapsum"}
#define GenweightsOperators {"gendis", "gennn", "genlaf"}
#define RemapgridOperators {"remapnn", "remaplaf", "remapsum"}
#define GenweightsOperators {"gennn", "genlaf"}
#define RemapetaOperators {"remapeta", "remapeta_s", "remapeta_z"}
#define ReplaceOperators {"replace"}
#define ReplacevaluesOperators {"setvals", "setrtoc", "setrtoc2"}
......@@ -651,6 +652,7 @@ static modules_t Modules[] =
{ Remap, RemapHelp, RemapOperators, CDI_REAL, 1, 1 },
{ Remap, RemapbilHelp, RemapbilOperators, CDI_REAL, 1, 1 },
{ Remap, RemapbicHelp, RemapbicOperators, CDI_REAL, 1, 1 },
{ Remap, RemapdisHelp, RemapdisOperators, CDI_REAL, 1, 1 },
{ Remap, RemapyconHelp, RemapyconOperators, CDI_REAL, 1, 1 },
{ Remap, RemapconHelp, RemapconOperators, CDI_REAL, 1, 1 },
{ Remap, Remapcon2Help, Remapcon2Operators, CDI_REAL, 1, 1 },
......
......@@ -3450,6 +3450,42 @@ static const char *RemapbicHelp[] = {
NULL
};
static const char *RemapdisHelp[] = {
"NAME",
" remapdis, gendis - Distance-weighted average remapping",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
"",
"DESCRIPTION",
" This module contains operators for a distance-weighted average remapping of the four",
" nearest neighbor values of fields between grids in spherical coordinates.",
" The interpolation is based on an adapted SCRIP library version. ",
" For a detailed description of the interpolation method see SCRIP.",
" This interpolation method only works on quadrilateral curvilinear source grids.",
"",
"OPERATORS",
" remapdis Distance-weighted average remapping",
" Performs a distance-weighted average remapping of the four nearest neighbor ",
" values on all input fields.",
" gendis Generate distance-weighted average remap weights",
" Generates distance-weighted average remapping weights of the four nearest neighbor",
" values for the first input field and writes the result to a file.",
" The format of this file is netCDF following the SCRIP convention.",
" Use the operator remap to apply this remapping weights to a data file with the same source grid.",
"",
"PARAMETER",
" grid STRING Target grid description file or name",
"",
"ENVIRONMENT",
" REMAP_EXTRAPOLATE",
" This variable is used to switch the extrapolation feature 'on' or 'off'.",
" By default the extrapolation is enabled for this remapping method.",
" CDO_REMAP_RADIUS ",
" Remap search radius in degree, default 180 degree.",
NULL
};
static const char *RemapyconHelp[] = {
"NAME",
" remapycon, genycon - First order conservative remapping",
......@@ -3577,7 +3613,7 @@ static const char *Remapcon2Help[] = {
static const char *RemapgridHelp[] = {
"NAME",
" remapdis, remapnn, remaplaf - SCRIP grid interpolation",
" remapnn, remaplaf - SCRIP grid interpolation",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
......@@ -3590,9 +3626,6 @@ static const char *RemapgridHelp[] = {
" The search algorithm for the conservative remapping requires that no grid cell occurs more than once. ",
"",
"OPERATORS",
" remapdis Distance-weighted average remapping",
" Performs a distance-weighted average remapping of the four nearest neighbor ",
" values on all input fields.",
" remapnn Nearest neighbor remapping",
" Performs a nearest neighbor remapping on all input fields.",
" remaplaf Largest area fraction remapping",
......@@ -3627,7 +3660,7 @@ static const char *RemapgridHelp[] = {
static const char *GenweightsHelp[] = {
"NAME",
" gendis, gennn, genlaf - Generate SCRIP grid interpolation weights",
" gennn, genlaf - Generate SCRIP grid interpolation weights",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
......@@ -3645,9 +3678,6 @@ static const char *GenweightsHelp[] = {
" Each operator is using a different interpolation method.",
"",
"OPERATORS",
" gendis Generate distance-weighted average remap weights",
" Generates distance-weighted average remapping weights of the four",
" nearest neighbor values and writes the result to a file.",
" gennn Generate nearest neighbor remap weights",
" Generates nearest neighbor remapping weights and writes the result to a file.",
" genlaf Generate largest area fraction remap weights",
......
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