topncdf_getmask
Read NetCDF file
Return value
the land/sea mask 2D or 3D array or -1 in case of error or mask absence
Parameters
fileid
in
required
type: salar string or long
Keywords
ADDSCL_BEFORE
type: scalar: 0 or 1
default: 0
MASKNAME
type: string
USEASMASK
type: scalar string
MISSING_VALUE
type: scalar
INVMASK
type: scalar: 0 or 1
default: 0
XMINMESH
type: scalar
default: 0L
XMAXMESH
type: scalar
default: jpiglo-1
YMINMESH
type: scalar
default: 0L
YMAXMESH
type: scalar
default: jpjglo-1
ZMINMESH
type: scalar
default: 0L
ZMAXMESH
type: scalar
default: jpkglo-1
TESTOP
type: scalar string, for example 'GT 0.5'
default: 'NE'
Examples
IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)
IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')
Version history
Version
$Id: ncdf_getmask.pro 399 2009-07-02 08:38:54Z smasson $
History
August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
Statistics
McCabe cyclic | 43 |
McCabe essential | 5 |
McCabe modular design | 5 |