Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS/determineminmax.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/determineminmax.pro (modified) (3 diffs)

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:determineminmax
 ;
-; PURPOSE:determiner le min et le max d''un tableau masque
+; @file_comments
+; Determine the min and the max of a mask array
 ;
-; CATEGORY: delestage de l''ecriture de plt, pltz, pltt
+; @categories 
+; Lightening of the writting of plt, pltz and pltt
 ;
-; CALLING SEQUENCE:determineminmax, tab, mask, vraimin, vraimax
+; @param TAB {in}{required}
+; The array whose we determine the min and the max
 ;
-; INPUTS:
+; @param MASK {in}{required}
+; The mask array 
 ;
-;       tab: le tableau dont il faut determiner le min et le max
-;       mask: le tableau de masque 
+; @keyword MININ 
+; It is a scalar which, if it is not defined, take the value of VRAIMIN
 ;
-; KEYWORD PARAMETERS:
+; @keyword MAXIN 
+; It is a scalar which, if it is not defined, take the value of VRAIMAX
 ;
-;       minin et maxin deux scalaire qui s''il ne sont pas definits
-;       prennent la valeur de vraimin et vraimax
+; @keyword ZEROMIDDLE 
+; Force the middle of the colorbar to be equal
+; to 0 (force max=max(abs([min,max])) and min=-max)
+; 
+; @keyword _EXTRA
+; used to pass your keywords
 ;
-;       /ZEROMIDDLE: fo force the middle of the colorbar to be equal
-;       to 0 (force max=max(abs([min,max])) and min=-max)
+; @keyword USETRI
+; To force using triangulation.
+; 
+; @param VRAIMIN {out}
+; The min of the array
 ;
-; OUTPUTS:
+; @param VRAIMAX {out}
+; The max of the array
 ;
-;       vraimin et vraimax: le min et le max du tableau
+; @uses
+; Common.pro
 ;
-; COMMON BLOCKS:
-;       common.pro
+; @restrictions
+; Look if the field is constant on the sea
 ;
-; SIDE EFFECTS:degarde si le champ est constant sur la mer
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       11/12/98
 ;
-; RESTRICTIONS:
+; @version
+; $Id$
 ;
-; EXAMPLE:
+; @todo seb: manque les param glam et gphi
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       11/12/98
 ;-
 ;------------------------------------------------------------
@@ -50 +64 @@
 ;-----------------------------------------------------------------------------
 ;-----------------------------------------------------------------------------
-; type de grille verticale:
+; Type o fthe vertical grid:
   if vargrid EQ 'W' then nz = nzw ELSE nz = nzt
 ; liste des points mer
   if (size(mask))[0] EQ 3 then mer = mask[*, *, 0] $
   ELSE mer = mask
-; si key_irregular eq 1, on masque aussi les points qui ne rentrent
-; pas ds le domaine geographique definit par lon1,lon2,lat1,lat2
+; If key_irregular eq 1, we mask also points which are not in the geographic 
+; domain defined by lon1,lon2,lat1,lat2
   if keyword_set(key_irregular) AND n_elements(glam) NE 0 AND n_elements(gphi) NE 0 then begin
     dom =   where(glam LT lon1 OR glam GT lon2 OR gphi LT lat1 OR gphi GT lat2)
@@ -73 +87 @@
     return
   endif
-; ma et mi : max et min sur les points mer
+; ma and mi : max and min on ocean points
   vraimax = max(tab[mer], min = vraimin, _extra = ex)
   sameminmax = testvar(var = minin) EQ testvar(var = maxin)