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

Collgrid: docu update

parent fab58511
......@@ -92,6 +92,7 @@ doc/tex/mod/Arith -text
doc/tex/mod/Arithc -text
doc/tex/mod/Arithdays -text
doc/tex/mod/Change -text
doc/tex/mod/Collgrid -text
doc/tex/mod/Comp -text
doc/tex/mod/Compc -text
doc/tex/mod/Cond -text
......@@ -155,7 +156,6 @@ doc/tex/mod/Filter -text
doc/tex/mod/Fldcor -text
doc/tex/mod/Fldcovar -text
doc/tex/mod/Fldstat -text
doc/tex/mod/Gather -text
doc/tex/mod/Genweights -text
doc/tex/mod/Gradsdes -text
doc/tex/mod/Gridboxstat -text
......
......@@ -58,6 +58,8 @@ Operator catalog:
Splittime splityear Split years
Splittime splitmon Split months
Splitsel splitsel Split time selection
Distgrid distgrid Distribute horizontal grid
Collgrid collgrid Collect horizontal grid
-------------------------------------------------------------
Selection
-------------------------------------------------------------
......
No preview for this file type
......@@ -13,7 +13,7 @@ Split File operations
Splittime File operations
Splitsel File operations
Distgrid File operations
Gather File operations
Collgrid File operations
Select Selection
Selvar Selection
Seltime Selection
......
@BeginModule
@NewPage
@Name = Collgrid
@Title = Collect horizontal grid
@Section = File operations
@Class = File operation
@Arguments = ifiles ofile
@Operators = collgrid
@EndModule
@BeginOperator_collgrid
@Title = Collect horizontal grid
@Parameter = [names]
@BeginDescription
This operator collects the data of the input files to one output file.
All input files need to have the same variables and the same number of timesteps on a different
horizonal grid region. A source region must be a rectilinear longitude/latitude grid box.
@EndDescription
@EndOperator
@BeginParameter names
@Item = names
STRING Comma separated list of variable names [default: all variables]
@EndParameter
@BeginNote
This operator needs to open all input files simultaneously.
The maximum number of open files depents on the operating system!
@EndNote
@BeginExample
Collect the horizonal grid of 6 input files. Each input file contains a lon/lat region of the target grid:
@BeginVerbatim
cdo collgrid ifile[1-6] ofile
@EndVerbatim
@IfDoc
Below is a schematic illustration of this example:
\vspace{1mm}
\includegraphics[width=\textwidth]{collgrid.pdf}
\vspace{1mm}
On the left side is the data of the six input files and on the right side is the collected data of the output file.
@EndifDoc
@EndExample
@BeginModule
@NewPage
@Name = Gather
@Title = Gather
@Section = File operations
@Class = File operation
@Arguments = ifiles ofile
@Operators = gather
@EndModule
@BeginOperator_gather
@Title = Gather
@BeginDescription
Merges grid points of all variables from @file{ifile2} to @file{ifile1} and write the result to @file{ofile}.
Only the non missing values of @file{ifile2} will be used. The horizontal grid of @file{ifile2} should
be smaller or equal to the grid of @file{ifile1} and the resolution must be the same.
Only rectilinear grids are supported. Both input files need to have the same variables
and the same number of timesteps.
@IfDoc
@EndifDoc
\includegraphics[width=\textwidth]{gather.pdf}
@EndDescription
@EndOperator
......@@ -396,6 +396,51 @@ static char *SplitselHelp[] = {
NULL
};
static char *DistgridHelp[] = {
"NAME",
" distgrid - Distribute horizontal grid",
"",
"SYNOPSIS",
" distgrid,nx[,ny] ifile obase",
"",
"DESCRIPTION",
" This operator distributes a dataset into smaller pieces. Each output file contains a different region of the horizontal ",
" source grid. A target grid region contains a regular longitude/latitude box of the source grid. Only rectilinear source ",
" grids are supported by this operator. The number of different regions can be specified with the parameter nx and ny.",
" The output files will be named <obase><xxx><suffix> where suffix is the filename extension derived from the file format. ",
" xxx will have five digits with the number of the target region.",
"",
"PARAMETER",
" nx INTEGER Number of regions in x direction",
" ny INTEGER Number of regions in y direction [default: 1]",
"",
"NOTE",
" This operator needs to open all output files simultaneously.",
" The maximum number of open files depents on the operating system!",
NULL
};
static char *CollgridHelp[] = {
"NAME",
" collgrid - Collect horizontal grid",
"",
"SYNOPSIS",
" collgrid[,names] ifiles ofile",
"",
"DESCRIPTION",
" This operator collects the data of the input files to one output file. ",
" All input files need to have the same variables and the same number of timesteps on a different",
" horizonal grid region. A source region must be a rectilinear longitude/latitude grid box.",
"",
"PARAMETER",
" names STRING Comma separated list of variable names [default: all variables]",
"",
"NOTE",
" This operator needs to open all input files simultaneously.",
" The maximum number of open files depents on the operating system!",
NULL
};
static char *SelectHelp[] = {
"NAME",
" select, delete - Select fields",
......
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