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

setmisstodis: added docu

parent e09eb3fd
......@@ -164,6 +164,7 @@ Operator catalog:
Setmiss setrtomiss Set range to missing value
Setmiss setvrange Set valid range
Setmiss setmisstonn Set missing value to nearest neighbor
Setmiss setmisstodis Set missing value to distance-weighted average
-------------------------------------------------------------
Arithmetic
-------------------------------------------------------------
......
No preview for this file type
......@@ -4,7 +4,7 @@
@Title = Set missing value
@Section = Modification
@Arguments = ifile ofile
@Operators = setmissval setctomiss setmisstoc setrtomiss setvrange setmisstonn
@Operators = setmissval setctomiss setmisstoc setrtomiss setvrange setmisstonn setmisstodis
@BeginDescription
This module sets part of a field to missing value or missing values
......@@ -153,22 +153,35 @@ o(t,x) = \left\{
@EndOperator
@BeginOperator_setmisstodis
@Title = Set missing value to distance-weighted average
@Parameter = [neighbors]
@BeginDescription
Set all missing values to the distance-weighted average of the nearest non missing values.
The default number of nearest neighbors is 4.
@EndifDoc
@EndDescription
@EndOperator
@BeginParameter rmax
@Item = neighbors
INTEGER Number of nearest neighbors
@Item = newmiss
FLOAT New missing value
FLOAT New missing value
@Item = c
FLOAT Constant
FLOAT Constant
@Item = rmin
FLOAT Lower bound
FLOAT Lower bound
@Item = rmax
FLOAT Upper bound
FLOAT Upper bound
@EndParameter
@BeginExample
Assume an input dataset has one field with temperatures
in the range from 246 to 304 Kelvin. To set all values
below 273.15 Kelvin to missing value use:
Assume an input dataset has one field with temperatures in the range from 246 to 304 Kelvin.
To set all values below 273.15 Kelvin to missing value use:
@BeginVerbatim
cdo setrtomiss,0,273.15 ifile ofile
@EndVerbatim
......
......@@ -1230,8 +1230,8 @@ static const char *EnlargeHelp[] = {
static const char *SetmissHelp[] = {
"NAME",
" setmissval, setctomiss, setmisstoc, setrtomiss, setvrange, setmisstonn - ",
" Set missing value",
" setmissval, setctomiss, setmisstoc, setrtomiss, setvrange, setmisstonn, ",
" setmisstodis - Set missing value",
"",
"SYNOPSIS",
" setmissval,newmiss ifile ofile",
......@@ -1240,6 +1240,7 @@ static const char *SetmissHelp[] = {
" setrtomiss,rmin,rmax ifile ofile",
" setvrange,rmin,rmax ifile ofile",
" setmisstonn ifile ofile",
" setmisstodis[,neighbors] ifile ofile",
"",
"DESCRIPTION",
" This module sets part of a field to missing value or missing values",
......@@ -1247,37 +1248,41 @@ static const char *SetmissHelp[] = {
" chosen operator.",
"",
"OPERATORS",
" setmissval Set a new missing value",
" / newmiss if i(t,x) EQ miss",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE miss",
" setctomiss Set constant to missing value",
" / miss if i(t,x) EQ c",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE c",
" setmisstoc Set missing value to constant",
" / c if i(t,x) EQ miss",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE miss",
" setrtomiss Set range to missing value",
" / miss if i(t,x) GE rmin AND i(t,x) LE rmax",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) LT rmin OR i(t,x) GT rmax",
" setvrange Set valid range",
" / miss if i(t,x) LT rmin OR i(t,x) GT rmax",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) GE rmin AND i(t,x) LE rmax",
" setmisstonn Set missing value to nearest neighbor",
" Set all missing values to the nearest non missing value.",
" / i(t,y) if i(t,x) EQ miss AND i(t,y) NE miss",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE miss",
" setmissval Set a new missing value",
" / newmiss if i(t,x) EQ miss",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE miss",
" setctomiss Set constant to missing value",
" / miss if i(t,x) EQ c",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE c",
" setmisstoc Set missing value to constant",
" / c if i(t,x) EQ miss",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE miss",
" setrtomiss Set range to missing value",
" / miss if i(t,x) GE rmin AND i(t,x) LE rmax",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) LT rmin OR i(t,x) GT rmax",
" setvrange Set valid range",
" / miss if i(t,x) LT rmin OR i(t,x) GT rmax",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) GE rmin AND i(t,x) LE rmax",
" setmisstonn Set missing value to nearest neighbor",
" Set all missing values to the nearest non missing value.",
" / i(t,y) if i(t,x) EQ miss AND i(t,y) NE miss",
" o(t,x) = ",
" \\ i(t,x) if i(t,x) NE miss",
" setmisstodis Set missing value to distance-weighted average",
" Set all missing values to the distance-weighted average of the nearest non missing values.",
" The default number of nearest neighbors is 4.",
"",
"PARAMETER",
" newmiss FLOAT New missing value",
" c FLOAT Constant",
" rmin FLOAT Lower bound",
" rmax FLOAT Upper bound",
" neighbors INTEGER Number of nearest neighbors",
" newmiss FLOAT New missing value",
" c FLOAT Constant",
" rmin FLOAT Lower bound",
" rmax FLOAT Upper bound",
NULL
};
......
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