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

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

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

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

@@ -1 +1 @@
 ;+
-; @file_comments 
-; 
-; 
+;
+; @file_comments
+;
 ; @categories
-; 
-; 
+;
 ; @param TYPE {in}{required}{type=string}
 ; A string of two characters specifying the type of plot we do
@@ -21 +20 @@
 ;
 ; @returns
-; 
-; 
+;
 ; @restrictions
-; 
-; 
+;
 ; @examples
 ;
-;
 ; @history
-; 
 ;
 ; @version
 ; $Id$
 ;-
+;
 FUNCTION err_1d, type, n1, name, n2
 ;
@@ -45 +41 @@
 ;
 ;+
-; @file_comments 
-; 
-; 
+;
+; @file_comments
+;
 ; @categories
-; 
-; 
+;
 ; @param TYPE {in}{required}{type=string}
 ; A string of two characters specifying the type of plot we do
 ;
-; @param SZ {in}{optional}{default=defined by grille.pro} 
-; 
-; @param NX {in}{optional}{default=defined by grille.pro} 
-; 
-; @param NY {in}{optional}{default=defined by grille.pro}  
-; 
+; @param SZ {in}{optional}{default=defined by <pro>grille<pro>}
+;
+; @param NX {in}{optional}{default=defined by <pro>grille</pro>}
+;
+; @param NY {in}{optional}{default=defined by <pro>grille</pro>}
+;
 ; @param NZ
-; 
-; 
+;
 ; @returns
-; 
-; 
+;
 ; @restrictions
-; 
-; 
+;
 ; @examples
 ;
-;
 ; @history
-; 
 ;
 ; @version
 ; $Id$
 ;-
+;
 FUNCTION err_2d, type, sz, nx, ny, nz
 ;
@@ -95 +86 @@
 ;
 ;+
-; @file_comments 
-; 
-; 
+;
+; @file_comments
+;
 ; @categories
-; 
-; 
+;
 ; @param TYPE {in}{required}{type=string}
 ; A string of two characters specifying the type of plot we do
 ;
-; @param SZ {in}{optional}{default=defined by grille.pro} 
-; 
-; @param NX {in}{optional}{default=defined by grille.pro} 
-; 
-; @param NY {in}{optional}{default=defined by grille.pro}  
-; 
+; @param SZ {in}{optional}{default=defined by <pro>grille</pro>}
+;
+; @param NX {in}{optional}{default=defined by <pro>grille</pro>}
+;
+; @param NY {in}{optional}{default=defined by <pro>grille</pro>}
+;
 ; @param NZ
-; 
-; 
+;
 ; @returns
-; 
-; 
+;
 ; @restrictions
-; 
-; 
+;
 ; @examples
 ;
-;
 ; @history
-; 
 ;
 ; @version
 ; $Id$
+;
 ;-
+;
 FUNCTION err_3d, type, sz, nx, ny, nz
 ;
@@ -143 +130 @@
                   + ', ' + 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 
+; 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'.
@@ -156 +141 @@
 ; @categories
 ; Graphics
-; 
+;
 ; @param FIELD {in}{required}{type=field}
-; It respect litchamp.pro's criterions. See IDL>xhelp,'litchamp'
+; It respect <pro>litchamp</pro>'s criterions. See IDL>xhelp,'litchamp'
 ;
 ; @param PROCEDURE {in}{required}
 ;
-; 
 ; @keyword TYPE
 ;
-;
 ; @keyword NOQUESTION
 ;
-;
 ; @keyword BOXZOOM {type=vector}
-; Vector indicating the geographic zone on which we want to cut the map. 
+; 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]]
@@ -181 +163 @@
 ;
 ; @keyword WDEPTH
-; to specify that the field is at W depth instead of T 
+; to specify that the field is at W depth instead of T
 ; depth (automatically activated if vargrid eq 'W')
-; 
+;
 ; @keyword VECTEUR{type=vetcor}
 ; It is a structure composed by 2 elements containing the 2 fields U
@@ -193 +175 @@
 ;
 ; @keyword _EXTRA
-; used to pass your keywords
-;
-; @keyword DIREC   
-;
-;
-; @uses 
+; Used to pass keywords
+;
+; @keyword DIREC
+;
+; @uses
 ; common.pro
 ;
@@ -208 +189 @@
 ; $Id$
 ;
-; @todo seb: mettre les param 
+; @todo seb: mettre les param
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;--------------------------------------------------------------
 ;
 FUNCTION checkfield, field, procedure, TYPE = type, BOXZOOM = boxzoom, DIREC = direc, NOQUESTION = noquestion, VECTEUR = vecteur, WDEPTH = wdepth, _EXTRA = ex
-;--------------------------------------------------------------
 ;
   compile_opt idl2, strictarrsubs
 ;
-; include commons
 @cm_4mesh
 @cm_4cal
@@ -237 +213 @@
     if arr EQ -1 then $
       return, report('Error: input array = -1. Maybe the reading did ont perform well...', /simple) $
-    ELSE return, report('Error: input array is a scalar', /simple)     
+    ELSE return, report('Error: input array is a scalar', /simple)
   ENDIF
   nan = total(finite(arr, /nan)) < 1
@@ -264 +240 @@
   ENDIF
 ;
-; The procedure domdef determine elements which are inside the boxzoom. 
-; 
+; 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 
+    if NOT keyword_set(localbox) then BEGIN
       localbox = [minprof, profdefault]
       if keyword_set(wdepth) then grillechoice = 'W' $
@@ -275 +251 @@
     nelbox = n_elements(localbox)
 ;we keep yranges (z axis) before changing the boxzoom.
-    !y.range = [localbox[nelbox-1], localbox[nelbox-2]] 
+    !y.range = [localbox[nelbox-1], localbox[nelbox-2]]
     if vargrid EQ 'W' OR keyword_set(wdepth) then BEGIN
       firstzw = 0 > (firstzw-1)
@@ -329 +305 @@
                             , 'Impossible to make a "'+type+'" plot with a 1D array'], /simple)
       ENDCASE
-    END 
+    END
 ;--------------------------------------------------------------
     2:BEGIN
@@ -372 +348 @@
         'zt':IF sz[1] NE nz OR sz[2] NE jpt THEN return, err_2d(type, sz, nx, ny, nz) ; zt array
       ENDCASE
-    END 
+    END
 ;--------------------------------------------------------------
     3:BEGIN
@@ -426 +402 @@
             sz[1] EQ nx AND sz[2] EQ ny AND sz[3] EQ  nz:direc = 'x' ; xyz array
             nx EQ 1 AND sz[1] EQ ny AND sz[2] EQ nz AND sz[3] EQ jpt:direc = 't' ; (x)yzt
-            ELSE:return, err_3d(type, sz, nx, ny, nz) 
+            ELSE:return, err_3d(type, sz, nx, ny, nz)
           endcase
         END
@@ -433 +409 @@
             sz[1] EQ nx AND sz[2] EQ ny AND sz[3] EQ jpt:direc = 'y' ; xyt array
             sz[1] EQ nx AND ny EQ 1 AND sz[2] EQ nz AND sz[3] EQ jpt:direc = 'z' ; x(y)zt array
-            ELSE:return, err_3d(type, sz, nx, ny, nz) 
+            ELSE:return, err_3d(type, sz, nx, ny, nz)
           endcase
         END
@@ -440 +416 @@
             sz[1] EQ nx AND sz[2] EQ ny AND sz[3] EQ jpt:direc = 'x' ; xyt array
             nx EQ 1 AND sz[1] EQ ny AND sz[2] EQ nz AND sz[3] EQ jpt:direc = 'z' ; (x)yzt array
-            ELSE:return, err_3d(type, sz, nx, ny, nz) 
+            ELSE:return, err_3d(type, sz, nx, ny, nz)
           endcase
         END
@@ -447 +423 @@
             sz[1] EQ nx AND ny EQ 1 AND sz[2] EQ nz AND sz[3] EQ jpt:direc = 'x' ; x(y)zt array
             nx EQ 1 AND sz[1] EQ ny AND sz[2] EQ nz AND sz[3] EQ jpt:direc = 'y' ; (x)yzt array
-            ELSE:return, err_3d(type, sz, nx, ny, nz) 
+            ELSE:return, err_3d(type, sz, nx, ny, nz)
           ENDCASE
-        END 
-      ENDCASE 
-    END 
-;--------------------------------------------------------------
-    4:BEGIN 
+        END
+      ENDCASE
+    END
+;--------------------------------------------------------------
+    4:BEGIN
       CASE type OF
         'x':direc = 'yzt'
@@ -465 +441 @@
         'yt':direc = 'xz'
         'zt':direc = 'xy'
-      ENDCASE 
+      ENDCASE
     END
   ENDCASE