Commit 8bf77e5a authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

added Remapbil docu

parent 05e6f56a
......@@ -195,6 +195,7 @@ doc/tex/mod/Outputgmt -text
doc/tex/mod/Outputtab -text
doc/tex/mod/Regres -text
doc/tex/mod/Remap -text
doc/tex/mod/Remapbil -text
doc/tex/mod/Remapcon -text
doc/tex/mod/Remapcon2 -text
doc/tex/mod/Remapeta -text
......
......@@ -444,18 +444,18 @@ Operator catalog:
-------------------------------------------------------------
Interpolation
-------------------------------------------------------------
Remapbil remapbil Bilinear interpolation
Remapbil genbil Generate bilinear interpolation 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 remapbil Bilinear interpolation
Remapgrid remapbic Bicubic interpolation
Remapgrid remapdis Distance-weighted average remapping
Remapgrid remapnn Nearest neighbor remapping
Remapgrid remaplaf Largest area fraction remapping
Genweights genbil Generate bilinear interpolation weights
Genweights genbic Generate bicubic interpolation weights
Genweights gendis Generate distance-weighted average remap weights
Genweights gennn Generate nearest neighbor remap weights
......
......@@ -92,6 +92,7 @@ Trend Regression
Subtrend Regression
EOFs EOFs
Eofcoeff EOFs
Remapbil Interpolation
Remapycon Interpolation
Remapcon Interpolation
Remapcon2 Interpolation
......
......@@ -5,7 +5,7 @@
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = genbil genbic gendis gennn genlaf
@Operators = genbic gendis 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_genbil
@Name = genbil
@Title = Generate bilinear interpolation weights
@Parameter = grid
@BeginDescription
Generates bilinear interpolation weights and writes the result to a file.
This interpolation method only works on quadrilateral curvilinear grids.
@EndDescription
@EndOperator
@BeginOperator_genbic
@Name = genbic
@Title = Generate bicubic interpolation weights
......
@BeginModule
@NewPage
@Name = Remapbil
@Title = Bilinear interpolation
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = remapbil genbil
@BeginDescription
This module contains operators for a bilinear remapping 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_remapbil
@Name = remapbil
@Title = Bilinear interpolation
@Parameter = grid
@BeginDescription
Performs a bilinear interpolation on all input fields.
@EndDescription
@EndOperator
@BeginOperator_genbil
@Name = genbil
@Title = Generate bilinear interpolation weights
@Parameter = grid
@BeginDescription
Generates bilinear interpolation weights 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 for circular grids.
@EndEnvironment
@BeginExample
Say @file{ifile} contains fields on a quadrilateral curvilinear grid.
To remap all fields bilinear to a Gaussian N32 grid, type:
@BeginVerbatim
cdo remapbil,n32 ifile ofile
@EndVerbatim
@EndExample
......@@ -29,6 +29,7 @@ Performs a first order conservative remapping on all input fields.
@BeginOperator_gencon
@Name = gencon
@Title = Generate 1st order conservative remap weights
@Parameter = grid
......
......@@ -29,6 +29,7 @@ Performs a second order conservative remapping on all input fields.
@BeginOperator_gencon2
@Name = gencon2
@Title = Generate 2nd order conservative remap weights
@Parameter = grid2
......
......@@ -5,7 +5,7 @@
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = remapbil remapbic remapdis remapnn remaplaf
@Operators = remapbic remapdis 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_remapbil
@Name = remapbil
@Title = Bilinear interpolation
@Parameter = grid
@BeginDescription
Performs a bilinear interpolation on all input fields.
This interpolation method only works on quadrilateral curvilinear grids.
@EndDescription
@EndOperator
@BeginOperator_remapbic
@Name = remapbic
@Title = Bicubic interpolation
......
......@@ -29,6 +29,7 @@ Performs a first order conservative remapping on all input fields.
@BeginOperator_genycon
@Name = genycon
@Title = Generate 1st order conservative remap weights
@Parameter = grid
......
......@@ -373,6 +373,7 @@ void *Maggraph(void *argument);
#define PressureOperators {"pressure_fl", "pressure_hl", "deltap"}
#define RegresOperators {"regres"}
#define RemapOperators {"remap"}
#define RemapbilOperators {"remapbil", "genbil"}
#define RemapyconOperators {"remapycon", "genycon"}
#define RemapconOperators {"remapcon", "gencon"}
#define Remapcon2Operators {"remapcon2", "gencon2"}
......@@ -647,6 +648,7 @@ static modules_t Modules[] =
{ Pressure, NULL, PressureOperators, CDI_REAL, 1, 1 },
{ Regres, RegresHelp, RegresOperators, CDI_REAL, 1, 1 },
{ Remap, RemapHelp, RemapOperators, CDI_REAL, 1, 1 },
{ Remap, RemapbilHelp, RemapbilOperators, 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 },
......
......@@ -3388,6 +3388,37 @@ static const char *EofcoeffHelp[] = {
NULL
};
static const char *RemapbilHelp[] = {
"NAME",
" remapbil, genbil - Bilinear interpolation",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
"",
"DESCRIPTION",
" This module contains operators for a bilinear remapping 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",
" remapbil Bilinear interpolation",
" Performs a bilinear interpolation on all input fields.",
" genbil Generate bilinear interpolation weights",
" Generates bilinear interpolation weights 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 for circular grids.",
NULL
};
static const char *RemapyconHelp[] = {
"NAME",
" remapycon, genycon - First order conservative remapping",
......@@ -3515,7 +3546,7 @@ static const char *Remapcon2Help[] = {
static const char *RemapgridHelp[] = {
"NAME",
" remapbil, remapbic, remapdis, remapnn, remaplaf - SCRIP grid interpolation",
" remapbic, remapdis, remapnn, remaplaf - SCRIP grid interpolation",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
......@@ -3528,9 +3559,6 @@ static const char *RemapgridHelp[] = {
" The search algorithm for the conservative remapping requires that no grid cell occurs more than once. ",
"",
"OPERATORS",
" remapbil Bilinear interpolation",
" Performs a bilinear interpolation on all input fields.",
" This interpolation method only works on quadrilateral curvilinear grids.",
" remapbic Bicubic interpolation",
" Performs a bicubic interpolation on all input fields.",
" This interpolation method only works on quadrilateral curvilinear grids.",
......@@ -3571,8 +3599,7 @@ static const char *RemapgridHelp[] = {
static const char *GenweightsHelp[] = {
"NAME",
" genbil, genbic, gendis, gennn, genlaf - ",
" Generate SCRIP grid interpolation weights",
" genbic, gendis, gennn, genlaf - Generate SCRIP grid interpolation weights",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
......@@ -3590,9 +3617,6 @@ static const char *GenweightsHelp[] = {
" Each operator is using a different interpolation method.",
"",
"OPERATORS",
" genbil Generate bilinear interpolation weights",
" Generates bilinear interpolation weights and writes the result to a file. ",
" This interpolation method only works on quadrilateral curvilinear grids.",
" genbic Generate bicubic interpolation weights",
" Generates bicubic interpolation weights and writes the result to a file.",
" This interpolation method only works on quadrilateral curvilinear grids.",
......
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