ToBeReviewed/LECTURE/
litchamp.pro
Allows to read an array or a structure corresponding to a field.
If we have in input:
- an array, litchamp send back the array.
- a structure, litchamp send back the first element of the structure
which must be the field in an array.
litchamp profit of this to look other elements of the structure and
update if needed global variables which refer to the field:
vargrid, varname, varunit, vardate, varexp , valmask et time
litchamp
Graphics
result = litchamp(struct, GRID=GRID, NAME=NAME, UNIT=UNIT, EXP=EXP, DATE=DATE, LEVEL=LEVEL, MASK=MASK)
Return value
It is the array containing the field.
Parameters
struct
in
required
type: array or structure
If STRUCT is a structure, it must follow following rules:
-the first element is the array containing the field.
-other elements are strings containing informations on the field except
for the one about the date. This one can be either a string to designate
a particular date (ex: 'August 1999') or a vector of julian days (of IDL)
corresponding to the calendar to be associated with the field if it is a
temporal series.
-the order of elements (except the first) has not any importance.
-the other elements (except the first) are optional.
-they are recognized by the first letter of their names:
g to update vargrid,
u to update varunit,
e to update varexp,
d to update vardate,
n to update varname,
m to update valmask
Keywords
GRID
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'g' if it exist
and '' if it does not.
NAME
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'n' if it exist
and '' if it does not.
UNIT
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'u' if it exist
and '' if it does not.
EXP
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'u' if it exist
and '' if it does not.
DATE
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'd' if it exist
and '' if it does not.
LEVEL
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'l' if it exist
and -1 if it does not.
MASK
We activate this keyword if we want litchamp to send back the variable
associated with the element of the structure starting by 'm' if it exist
and -1 if it does not.
Examples
IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
T, , , 0,
IDL> help, litchamp({a:indgen(5), u:'C', name:'toto'})
INT = Array[5]
IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
T, toto, C, 0,
IDL> help, litchamp({a:indgen(5), da:'1999'})
INT = Array[5]
IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp
T, toto, C, 1999,
Version history
Version
$Id: litchamp.pro 371 2008-08-07 09:32:02Z pinsard $
History
Sebastien Masson (smasson@lodyc.jussieu.fr)
28/5/1999
Known issues
Restrictions
Update if needed global variables vargrid,
varname, varunit, vardate, varexp, valmask and time.
Other attributes
Uses routines
common
Produced by IDLdoc 2.0.
