LIBRARIES_NCDF_GET
Name
NCDF_GET
Purpose
Get a set of variables from a NetCDF file.
Category
Calling Sequence
ncdf_get, file, list, out
Inputs
file = Name of NetCDF file. in
list = Array of variable names. in
May contain regular expressions.
May also contain aliases, other names the
variable may go by. Give as a string with the
names separated by spaces. The first name will
be the output name. Example:
'U_10m UGRD_10maboveground U_GRD_3_MWSL_10'
where either UGRD_10maboveground or
U_GRD_3_MWSL_10 will be returned as U_10m,
whichever is found first in the file.
If neither is found then U_10m is added to the
array of missing variables.
Keyword Parameters
Keywords
GATT=gatt Return Global Attributes in hash gatt.
!NULL if none.
/STRUCT Convert outputs to structures instead of hashes.
/QUIET inhibit some messages.
ERROR=err Error flag: 0=ok.
If err GT 0 then it is the number of missing variables.
Some NC errors:
-31: File not found.
-51: File not NetCDF.
MISSING=miss Return an array of missing variables
names (requested but not found).
FOUND=fnd Return an array of found variables.
Outputs
out = Returned a hash of requested items. out
!NULL if none.
Common Blocks
Notes
Modification History
R. Sterner, 2012 Jun 11 from wrf_varget.pro in IDLWRF.
R. Sterner, 2012 Jun 27 --- Renamed from ncdf_getvar.pro and used hashes.
R. Sterner, 2012 Jun 29 --- Added GATT=gatt, /STRUCT.
R. Sterner, 2012 Aug 15 --- Allowed regular expressions in list.
R. Sterner, 2012 Oct 01 --- Added an error handler.
R. Sterner, 2012 Oct 01 --- Counted # missing vars in err.
R. Sterner, 2012 Oct 08 --- Allowed multi-possible var names (aliases).
R. Sterner, 2012 Oct 24 --- Returned an array of found variables.
Copyright (C) 2012, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.