ToBeReviewed/LECTURE/
xncdf_lec.pro
Reading of a NetCdf file with widgets
Procedure called by xmanager when we press on a button of a second widget created by wid_var.
This procedure manage the second created widget when we call xncdf_lec.
This widget concern the reading of the variable.
Procedure called by xmanager when we press a button of the first widget
created by par xncdf_lec
Routine summary
- result = xncdf_lec([name], ATT=ATT, COUNT=vector, GROUP=GROUP, OFFSET=vector, IODIR=string, SHIFT=vector, STRIDE=vector, VAR=VAR)
-
-
- wid_var_event, event
-
-
- wid_var, widid_pere
-
-
- xncdf_lec_event, event
-
-
xncdf_lec
Widget
result = xncdf_lec([name], ATT=ATT, COUNT=vector, GROUP=GROUP, OFFSET=vector, IODIR=string, SHIFT=vector, STRIDE=vector, VAR=VAR)
Return value
2 different cases:
1) None attribute has been selected. In this case, res is the array we
wanted to read.
2) Some attributes has been selected. In this case, res is a structure
whose the first element having the name of the variable is the values
array and the other arguments are the select arguments.
Parameters
name
in
optional
type: string
It give the name of the file to be opened. If NAME
does not contain the separating character of directories ('/' under
unix for example), the file will be looked for in the current directory.
Keywords
ATT
COUNT
type: vector
An optional vector containing the counts to be used in
reading Value. COUNT is a 1-based vector with an element for
each dimension of the data to be written.The default matches
the size of the variable so that all data is written out.
GROUP
The widget ID of the widget that calls XNCDF_LEC. When
this ID is specified, a death of the caller results in a death
of XNCDF_LEC.
OFFSET
type: vector
default: [0, 0,...]
An optional vector containing the starting position
for the read. The default start position is [0, 0, ...].
IODIR
type: string
It contains the directory where to go look for the file to be read.
If NAME does not contain the separating character of directories ('/' under
unix for example), the file will be called iodir+nom_fichier.
SHIFT
type: vector
default: [0, 0,...]
A vector of integers, specifying for each dimension how much we have to shift it.
By default, it is [0,0,...]. See the function shift for more explanations. BEWARE,
the shift is done on the biggest array before a possible reduction determined
by OFFSET and COUNT. On the other hand, it is done after the possible extraction
created by the STRIDE.
STRIDE
type: vector
default: [1, 1,...]
An optional vector containing the strides, or sampling
intervals, between accessed values of the netCDF variable. The
default stride vector is that for a contiguous read, [1, 1,...].
VAR
Examples
IDL> help, xncdf_lec()
Version history
Version
$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
History
Sebastien Masson (smasson@lodyc.jussieu.fr)
24/8/1999
Other attributes
Uses routines
wididbase, infovariable, resultat, motcle
Common blocks used
wididbase
infovariable
resultat
motcle
wid_var_event
wid_var_event, event
Parameters
event
in
required
A structure characterizing the type of event which arrive to a widget number1 2
Version history
Version
$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
Other attributes
Uses routines
wididbase,resultat,infovariable,indicewid,motcle
Common blocks used
wididbase
resultat
infovariable
indicewid_var
motcle
wid_var
wid_var, widid_pere
Parameters
widid_pere
in
required
type: scalar
It contains the identity of the father widget which was
created by xncdf_lec and which has allowed to select the variable to be read.
Version history
Version
$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
Other attributes
Uses routines
resultat,infovariable,indicewid_var,motcle
Common blocks used
resultat
infovariable
indicewid_var
motcle
xncdf_lec_event
xncdf_lec_event, event
Parameters
event
A structure characterising the event type which arrive at the widget number 1.
Version history
Version
$Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $
Other attributes
Uses routines
resultat, infovariable, motcle
Common blocks used
resultat
infovariable
motcle
Produced by IDLdoc 2.0.