Changeset 142 for trunk/SRC/ToBeReviewed/LECTURE/ncdf_lec.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/LECTURE/ncdf_lec.pro (modified) (7 diffs)

trunk/SRC/ToBeReviewed/LECTURE/ncdf_lec.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:ncdflec
 ;
-; PURPOSE:donne des infos sur un fichier netcdf et permet de recupere
-; les variables qui y sont ecrites 
+; @file_comments
+; Give informations on a file net cdf and allows to recuperate 
+; variables which are write in.
 ;
-; CATEGORY:lecture de fichiers netcdf
+; @categories
+; Reading
 ;
-; CALLING SEQUENCE: res=ncdflec('nom_de _fichier')
+; @param NOM {in}{required}
+; Name of a file net cdf situated in the directory stipulated by iodir.
 ;
-; INPUTS:nom_de _fichier:nom d'un fichier net cdf situe ds e repertoire
-; stipule par iodir
+; @keyword ATT
+; 'global' or at the name of a variable. Allows to see all attributes 
+; joined at a variable
 ;
-; KEYWORD PARAMETERS:
+; @keyword DIM
+; Give the list of dimensions.
 ;
-;       ATT: 'global' ou au nom d'une variable. permet de voir tous les
-; attributs rattaches a une variable.
+; @keyword VAR
+;       1) /var: Gove the list of dimensions.
+;       2) var='nom de variable': in this case the function send back the variable.
 ;
-;       /DIM:donne la liste des dimensions
+; @keyword IODIR
+; String containing the directory containing the file to be read
 ;
-;       VAR:
-;       1) /var: donne la liste des variables
-;       2) var='nom de variable': ds ce cas la fonction retourne la variable
+; @keyword _EXTRA
+; Allows to pass keywords defined by IDL to functions NETCDF ( particularly OFFSET 
+; and COUNT in ncdf_varget)
 ;
-;       IODIR: string contenant le repertoire ou aller chercher le
-;       fichier a lire.
+; @returns
+; -1 (exept if var='nom de variable', then the function send back the variable).
 ;
-;       _EXTRA: permet de passer les mots cles definits par IDL pour
-;       les fonction NETCDF (en particulier OFFSET et COUNT ds ncdf_varget)
+; @restrictions
+; Variables's names of the program are similar to these used by the IDL manual 
+; 'scientific data formats'
 ;
-; OUTPUTS:-1 sauf si var='nom de variable' auquel cas la fonction retourne la variable
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       4/1/98
 ;
-; REMARQUE:les noms des variables du programme sont similaires a ceux employes
-; ds le manuel IDL 'scientific data formats'
+; @version
+; $Id$
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       4/1/98
 ;-
 ;------------------------------------------------------------
@@ -57 +64 @@
    endif
 ;------------------------------------------------------------
-; ouverture du fichier nom
+; opening of the file name.
 ;------------------------------------------------------------
    cdfid=ncdf_open(iodir+nom)
 ;------------------------------------------------------------
-; que contient le fichier??
+; Wht does the file contain??
 ;------------------------------------------------------------
    wathinside=ncdf_inquire(cdfid)
-;   print,'dans le fichier, ',iodir+nom,', il y a:'
+;   print,'in the file, ',iodir+nom,', there are:'
    if keyword_set(dim) then begin 
       print,'nombre de dimensions: ',strtrim(wathinside.ndims,1)
@@ -76 +83 @@
    endif
 ;------------------------------------------------------------
-; attributs globaux
+; Global attributes
 ;------------------------------------------------------------
    if keyword_set(att) then begin
@@ -82 +89 @@
       print,'ATTRIBUTS GLOBAUX'
       for attiq=0,wathinside.ngatts-1 do begin
-         name=ncdf_attname(cdfid,attiq,/global) ;nom de l''atribut
-         ncdf_attget,cdfid,name,value,/global ;valeur de l''atribut
+         name=ncdf_attname(cdfid,attiq,/global) ;attribute's name
+         ncdf_attget,cdfid,name,value,/global ;attribute's value
          print,name,': ',string(value)
       endfor
@@ -89 +96 @@
 nonglobal:
 ;------------------------------------------------------------
-; affichage des differentes dimensions
+; Display of different dimensions.
 ;------------------------------------------------------------
    if keyword_set(dim) then begin 
@@ -98 +105 @@
    tailledim=lonarr(wathinside.ndims)
    for dimiq=0,wathinside.ndims-1 do begin
-      ncdf_diminq,cdfid,dimiq,name,value ; nom et valeur de la dimension
+      ncdf_diminq,cdfid,dimiq,name,value ; dimension's name and value
       nomdim[dimiq]=name
       tailledim[dimiq]=value
@@ -107 +114 @@
    endfor
 ;------------------------------------------------------------
-; affichage des differentes variables
+; Display of different variables.
 ;------------------------------------------------------------
 ;
    if keyword_set(att) or keyword_set(var) then begin 
-; vature de var ? string ou 1
+; var's value? string or 1
    help, var, output = nature
    if (strpos(nature, 'STRING'))[0] NE -1 then nature = 'string' ELSE nature = '1'
-; si on doit juste lire la variable
+; If we just have to read the variable.
    if nature EQ 'string' then begin
       ncdf_varget, cdfid, var, res, _extra = ex
       GOTO, sortie
    ENDIF 
-; si c''est pour avoir des renseignements
+; If it is to have pieces of information.
    if not keyword_set(att) then att='rien'
       print, '----------------------------'
       for varid=0,wathinside.nvars-1 do begin
-         varcontent=ncdf_varinq(cdfid,varid) ; que contient la variable
+         varcontent=ncdf_varinq(cdfid,varid) ; What does variable contain??
          if strlowcase(att) eq strlowcase(varcontent.name) or keyword_set(var) $
           then begin