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
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')
Version history
Version
$Id: ncdf_getmask.pro 327 2007-12-13 16:22:35Z pinsard $
History
August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
Statistics
McCabe cyclic | 24 |
McCabe essential | 1 |
McCabe modular design | 1 |