Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro (modified) (7 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-;+
-; NAME:checkfield
-;
-; PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le
-; champ donne a bien une taille compatible avec le domaine et fait au
-; besoin les moyennes pour ressortir en fin de fonction un tableau 2d
-; si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un
-; tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'.
-;
-; CATEGORY:en entree de plt, pltz, pltt et plt1d
-;
-; CALLING SEQUENCE:res=checkfield(field, procedure)
-; 
-; INPUTS:
-;        filed: un champ recomdant aux criteres de litchamp.pro, cf.
-;        IDL>xhelp,'litchamp'
-;
-; KEYWORD PARAMETERS:
-; 
-;         /WDEPTH: to specify that the field is at W depth instad of T 
-;         depth (automatically activated if vargrid eq 'W')
-;
-; OUTPUTS:
-;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                      08/02/2000
-;-
-;------------------------------------------------------------
-;------------------------------------------------------------
 FUNCTION err_1d, type, n1, name, n2
 ;
@@ -79 +39 @@
                   + ', ' + strtrim(jpt, 1) + ']'], /simple)
 END
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;+
+;
+; @file_comments
+; In input of plt, pltz, pltt and plt1d, it check that the field give 
+; a size compatible with the domain and, if needed, average to give us 
+; a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt'
+; , 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'.
+;
+; @categories
+; graphic
+; 
+; @param FIELD {in}{required}
+; A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp'
+;
+; @keyword BOXZOOM 
+; Vector indicating the geographic zone on which we want to cut the map. 
+;  If BOXZOOM has :
+; 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
+; 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
+; 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
+; 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
+; 6 elements: The extraction is made on Boxzoom
+;
+; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
+;
+; @keyword WDEPTH
+; to specify that the field is at W depth instad of T 
+; depth (automatically activated if vargrid eq 'W')
+; 
+; @keyword VECTEUR
+; It is a structure composed by 2 elements containing the 2 fields U
+; and V of values of the zonal and meridian component of the vector of the fields
+; to draw. These fields can be an array or a structure.
+;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')}
+;       Comment: name of elements of vectors are inconsenquential.
+;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
+;
+; @keyword _EXTRA
+; used to pass your keywords
+;
+; @keyword DIREC   
+;
+; @uses 
+; common.pro
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                      08/02/2000
+;
+; @version
+; $Id$
+;
+; @todo seb: mettre les param 
+;
+;-
+;------------------------------------------------------------
+;------------------------------------------------------------
 ;--------------------------------------------------------------
 ;
@@ -95 +115 @@
   ENDIF
 ;--------------------------------------------------------------
-; I1) lecture du champ
+; I1) Reading of the field
 ;--------------------------------------------------------------
   if n_elements(field) EQ 0 then return, report('field undefined')
@@ -107 +127 @@
   nan = total(finite(arr, /nan)) < 1
 ;---------------------------------------------------------------
-; redefinition du domaine 
+; redefinition of the domain
 ;---------------------------------------------------------------
   minprof = 0.
@@ -130 +150 @@
   ENDIF
 ;
-; la procedure domdef determine les elements qui sont a l''interieur
-; de la boxzoom. 
-; si on fait un plot contenant l''axe z:
-; Suivant l''axe z si on veut par ex faire un dessin
-; entre 0 et 1000 il se peut que l''on selectionne les niveaux
-; correspondants aux profondeurs comprises entre 0 et 900m (vu la
-; discretisation assez lache de cet axe qd on atteint des profondeurs
-; elevees). Pour ne pas que le dessin s''arrete a 900 mais bien a
-; 1000, on va aller chercher le niveau au dessous de 1000, d''ou la
-; manip suivante sur la boxzoom: l''approfondir de 1 niveau sur la
-; verticale (si possible) sans changer les y range. 
+; The procedure domdef determine elements which are inside the boxzoom. 
+; 
   if strpos(type, 'z') NE -1 THEN BEGIN
     if NOT keyword_set(localbox) then BEGIN 
@@ -149 +160 @@
     END
     nelbox = n_elements(localbox)
-;on garde les yranges (axe z) avant de changer la boxzoom.
+;we keep yranges (z axis) before changing the boxzoom.
     !y.range = [localbox[nelbox-1], localbox[nelbox-2]] 
     if vargrid EQ 'W' OR keyword_set(wdepth) then BEGIN
@@ -169 +180 @@
     if (lon2-lon1) gt (lat2-lat1) then type = 'xt' else type = 'yt'
 ;--------------------------------------------------------------
-; verification de la taille du tableau d''entree et de la valeur de type
+; verification of the input array size and the value of the type
 ;--------------------------------------------------------------
   grille, -1, -1, -1, -1, nx, ny, nz, firstx, firsty $