ReadWrite/idl-NetCDF/ncdf_quickread/
ncdf_quickread_helper.pro
This function returns the filename name from the full path.
This function returns the directory name from the full path.
This routine ensures that the given name does not start with a number,
nor contain a dash. IDL cannot accept a variable starting with a
number or containing a dash. If the name starts with a number, an
underscore is prepended to the name, and if it contains a dash, the
dash is replaced with an underscore.
This procedure creates a script to read the data in a given netCDF
file into IDL. The default output file is the name of the netCDF
file with idl replacing any existing suffix. The default output is
variable data only.
Routine summary
- result = ncdf_quickread_getfile(fullpath, suffix=suffix)
-
- result = ncdf_quickread_getdir(fullpath)
-
- result = ncdf_quickread_validatename(varname)
-
- result = ncdf_quickread_helper(infile, verbose=verbose, prefix=prefix, fields=fields, reform=reform)
-
ncdf_quickread_getfile
result = ncdf_quickread_getfile(fullpath, suffix=suffix)
Return value
file - filename
Parameters
fullpath
full directory+file path
Keywords
suffix
include input suffix in output file name
Examples
Call: file = ncdf_quickread_getfile(fullpath)
Version history
Version
$Id: ncdf_quickread_helper.pro 163 2006-08-29 12:59:46Z navarro $
History
Known issues
Restrictions
ncdf_quickread_getdir
result = ncdf_quickread_getdir(fullpath)
Return value
directory path
Parameters
fullpath
full directory+file path
Examples
Call: dir = ncdf_quickread_getdir(fullpath)
Version history
Version
$Id: ncdf_quickread_helper.pro 163 2006-08-29 12:59:46Z navarro $
History
Known issues
Restrictions
ncdf_quickread_validatename
result = ncdf_quickread_validatename(varname)
Return value
Parameters
varname
The name of the variable to be read
Examples
Version history
Version
$Id: ncdf_quickread_helper.pro 163 2006-08-29 12:59:46Z navarro $
History
Known issues
Restrictions
ncdf_quickread_helper
result = ncdf_quickread_helper(infile, verbose=verbose, prefix=prefix, fields=fields, reform=reform)
Return value
array of commands to run at top level
Parameters
infile
full path to netCDF file of interest
Keywords
verbose
Set this keyword to return an error message in case of an error.
prefix
see changelog above.
fields
reform
see changelog above.
Examples
Version history
Version
$Id: ncdf_quickread_helper.pro 163 2006-08-29 12:59:46Z navarro $
History
Known issues
Restrictions
Produced by IDLdoc 2.0 on Wed Sep 13 16:32:24 2006.
