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

added Remapbic docu

parent 8bf77e5a
......@@ -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/Remapbic -text
doc/tex/mod/Remapbil -text
doc/tex/mod/Remapcon -text
doc/tex/mod/Remapcon2 -text
......
......@@ -446,17 +446,17 @@ Operator catalog:
-------------------------------------------------------------
Remapbil remapbil Bilinear interpolation
Remapbil genbil Generate bilinear interpolation weights
Remapbic remapbic Bicubic interpolation
Remapbic genbic Generate bicubic 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 remapbic Bicubic interpolation
Remapgrid remapdis Distance-weighted average remapping
Remapgrid remapnn Nearest neighbor remapping
Remapgrid remaplaf Largest area fraction remapping
Genweights genbic Generate bicubic interpolation weights
Genweights gendis Generate distance-weighted average remap weights
Genweights gennn Generate nearest neighbor remap weights
Genweights genlaf Generate largest area fraction remap weights
......
......@@ -93,6 +93,7 @@ Subtrend Regression
EOFs EOFs
Eofcoeff EOFs
Remapbil Interpolation
Remapbic Interpolation
Remapycon Interpolation
Remapcon Interpolation
Remapcon2 Interpolation
......
......@@ -5,7 +5,7 @@
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = genbic gendis gennn genlaf
@Operators = 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_genbic
@Name = genbic
@Title = Generate bicubic interpolation weights
@Parameter = grid
@BeginDescription
Generates bicubic interpolation weights and writes the result to a file.
This interpolation method only works on quadrilateral curvilinear grids.
@EndDescription
@EndOperator
@BeginOperator_gendis
@Name = gendis
@Title = Generate distance-weighted average remap weights
......
@BeginModule
@NewPage
@Name = Remapbic
@Title = Bicubic interpolation
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = remapbic genbic
@BeginDescription
This module contains operators for a bicubic 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_remapbic
@Name = remapbic
@Title = Bicubic interpolation
@Parameter = grid
@BeginDescription
Performs a bicubic interpolation on all input fields.
@EndDescription
@EndOperator
@BeginOperator_genbic
@Name = genbic
@Title = Generate bicubic interpolation weights
@Parameter = grid
@BeginDescription
Generates bicubic 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 bicubic to a Gaussian N32 grid, type:
@BeginVerbatim
cdo remapbic,n32 ifile ofile
@EndVerbatim
@EndExample
......@@ -5,7 +5,7 @@
@Section = Interpolation
@Class = Interpolation
@Arguments = ifile ofile
@Operators = remapbic remapdis remapnn remaplaf
@Operators = 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_remapbic
@Name = remapbic
@Title = Bicubic interpolation
@Parameter = grid
@BeginDescription
Performs a bicubic interpolation on all input fields.
This interpolation method only works on quadrilateral curvilinear grids.
@EndDescription
@EndOperator
@BeginOperator_remapdis
@Name = remapdis
@Title = Distance-weighted average remapping
......
......@@ -374,11 +374,12 @@ void *Maggraph(void *argument);
#define RegresOperators {"regres"}
#define RemapOperators {"remap"}
#define RemapbilOperators {"remapbil", "genbil"}
#define RemapbicOperators {"remapbic", "genbic"}
#define RemapyconOperators {"remapycon", "genycon"}
#define RemapconOperators {"remapcon", "gencon"}
#define Remapcon2Operators {"remapcon2", "gencon2"}
#define RemapgridOperators {"remapbil", "remapbic", "remapdis", "remapnn", "remaplaf", "remapsum"}
#define GenweightsOperators {"genbil", "genbic", "gendis", "gennn", "genlaf"}
#define RemapgridOperators {"remapdis", "remapnn", "remaplaf", "remapsum"}
#define GenweightsOperators {"gendis", "gennn", "genlaf"}
#define RemapetaOperators {"remapeta", "remapeta_s", "remapeta_z"}
#define ReplaceOperators {"replace"}
#define ReplacevaluesOperators {"setvals", "setrtoc", "setrtoc2"}
......@@ -649,6 +650,7 @@ static modules_t Modules[] =
{ Regres, RegresHelp, RegresOperators, CDI_REAL, 1, 1 },
{ Remap, RemapHelp, RemapOperators, CDI_REAL, 1, 1 },
{ Remap, RemapbilHelp, RemapbilOperators, CDI_REAL, 1, 1 },
{ Remap, RemapbicHelp, RemapbicOperators, 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 },
......
......@@ -3419,6 +3419,37 @@ static const char *RemapbilHelp[] = {
NULL
};
static const char *RemapbicHelp[] = {
"NAME",
" remapbic, genbic - Bicubic interpolation",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
"",
"DESCRIPTION",
" This module contains operators for a bicubic 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",
" remapbic Bicubic interpolation",
" Performs a bicubic interpolation on all input fields.",
" genbic Generate bicubic interpolation weights",
" Generates bicubic 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",
......@@ -3546,7 +3577,7 @@ static const char *Remapcon2Help[] = {
static const char *RemapgridHelp[] = {
"NAME",
" remapbic, remapdis, remapnn, remaplaf - SCRIP grid interpolation",
" remapdis, remapnn, remaplaf - SCRIP grid interpolation",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
......@@ -3559,9 +3590,6 @@ static const char *RemapgridHelp[] = {
" The search algorithm for the conservative remapping requires that no grid cell occurs more than once. ",
"",
"OPERATORS",
" remapbic Bicubic interpolation",
" Performs a bicubic interpolation on all input fields.",
" This interpolation method only works on quadrilateral curvilinear grids.",
" remapdis Distance-weighted average remapping",
" Performs a distance-weighted average remapping of the four nearest neighbor ",
" values on all input fields.",
......@@ -3599,7 +3627,7 @@ static const char *RemapgridHelp[] = {
static const char *GenweightsHelp[] = {
"NAME",
" genbic, gendis, gennn, genlaf - Generate SCRIP grid interpolation weights",
" gendis, gennn, genlaf - Generate SCRIP grid interpolation weights",
"",
"SYNOPSIS",
" <operator>,grid ifile ofile",
......@@ -3617,9 +3645,6 @@ static const char *GenweightsHelp[] = {
" Each operator is using a different interpolation method.",
"",
"OPERATORS",
" 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.",
" 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.",
......
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