<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/LECTURE/

litchamp.pro

toplitchamp

result = litchamp(struct, GRID=GRID, NAME=NAME, UNIT=UNIT, EXP=EXP, DATE=DATE, LEVEL=LEVEL, MASK=MASK)

NAME:litchamp PURPOSE:permet de lire un simple tableau ou une structure correspondant a un champ. Si en entree on a : -un simple tableau, litchamp renvoie le tableau -une stucture, litchamp renvoie le premier element de la structure qui doit obligatoirement etre le champ sous forme d''un tableau. Au passage litchamp regarde les autres elements de la structure et met a jour si besoin les variables globales qui se rapportent au champ: vargrid, varname, varunit, vardate, varexp , valmask et time CATEGORY:permet d''appeler plt, pltz, pltt ... avec un tableau ou une structure et de mettre a jour les variables globales liees au champ. CALLING SEQUENCE:res=litchamp(struct) INPUTS: struct: c''est soit un tableau soit une structure. Si struct est une structure, elle doit suivre les regles suivantes: -le premier element est le tableau contenant le champ. -les autres elements sont des strings qui contiennent des informations sur le champ SAUF pour l''element relatif a date. Ce dernier peut etre soit un string pour designer une date particuliere (ex: 'August 1999') ou bien un vecteur de jours juliens (d''IDL) correspondant au calendrier a associer au champ si c'est une serie temporelle. -l''ordre des elements (autre que le premier) n''a pas d''importance. -les autres elements (autre que le premier) sont tous optionnels. -ils sont reconnus par la premiere lettre de leur nom: g pour actualiser vargrid u pour actualiser varunit e pour actualiser varexp d pour actualiser vardate n pour actualiser varname m pour actualiser valmask KEYWORD PARAMETERS: /GRID: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'g' si il existe et '' dans le cas contraire. /UNIT: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'u' si il existe et '' dans le cas contraire. /EXP: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'e' si il existe et '' dans le cas contraire. /DATE: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'd' si il existe et '' dans le cas contraire. /NAME: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'n' si il existe et '' dans le cas contraire. /LEVEL: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'l' si il existe et -1 dans le cas contraire. /MASK: activer ce mot cle si on veut que litchamp renvoie la variable associee a l''element de la structure commencant par 'm' si il existe et -1 dans le cas contraire. OUTPUTS:c''est le tableau qui continent le champ. COMMON BLOCKS: common.pro SIDE EFFECTS: actualise au besion les variables globales vargrid, varname, varunit, vardate, varexp, valmask et time. RESTRICTIONS: EXAMPLE: 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,

Parameters

struct       

Keywords

GRID       

NAME       

UNIT       

EXP       

DATE       

LEVEL       

MASK       

Produced by IDLdoc 2.0.