Changeset 231 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE

Timestamp:

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

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

Location:

trunk/SRC/ToBeReviewed/PLOTS/DESSINE

Files:

• plt.pro (modified) (28 diffs)
• plt1d.pro (modified) (17 diffs)
• pltbase.pro (modified) (3 diffs)
• pltsc.pro (modified) (10 diffs)
• pltt.pro (modified) (31 diffs)
• pltv.pro (modified) (13 diffs)
• pltz.pro (modified) (6 diffs)
• sbar_plot.pro (modified) (4 diffs)
• scontour.pro (modified) (3 diffs)
• splot.pro (modified) (3 diffs)
• tvplus.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Draw horizontal graph (map) with CONTOUR procedure
 ;
-; @categories 
+; @categories
 ; Graphics
 ;
-; @param TAB1 {in}{required} 
+; @param TAB1 {in}{required}
 ; The field whose we want to make the horizontal map can be:
 ;         1) an array. if needed, its mean along the z and t direction
 ;         will be automatically performed.
 ;         2) a structure respecting all criterions specified by
-;         litchamp.pro. cf. IDL> xhelp,'litchamp'
-;  
-; @param PARAM2 {in}{optional}{default=min of tab1 (on ocean points)} 
+;         <pro>litchamp</pro> cf. IDL> xhelp,'litchamp'
+;
+; @param PARAM2 {in}{optional}{default=min of tab1 (on ocean points)}
 ; Min value we want to consider in the contour's drawing.
 ;         Note: Could also be the type of plot that can be only 'xy' for plt
 ;
-; @param PARAM3 {in}{optional}{default=max of tab1 (on ocean points)} 
+; @param PARAM3 {in}{optional}{default=max of tab1 (on ocean points)}
 ; Max value we want to consider in the contour's drawing.
 ;         Note: if param2 is defined as 'xy' then param3 is used to define the min (see param2)
 ;
-; @param PARAM4 {in}{optional}{default='xy'} 
+; @param PARAM4 {in}{optional}{default='xy'}
 ; Type of plot (can be only 'xy' for plt).
 ;         Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3)
 ;
 ; @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]]
@@ -40 +37 @@
 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
 ;
-; @keyword REALCONT 
+; @keyword REALCONT
 ; Allow to draw continents defined in IDL. REALCONT can have 2 form:
 ;           /REALCONT: we draw continents in place of the mask
-;           REALCONT=2 we draw continent's contour over the mask (this allows 
+;           REALCONT=2 we draw continent's contour over the mask (this allows
 ;                      to see if the mask correspond at real continents).
 ;
-; @keyword CONTINTERVALLE 
-; When CONTOUR is activated, it is the value between 2 isolines 
-; traced by a trait. So it can be different from the one specified by INTERVALLE which, 
-; in this case, does not control colored isolines in color anymore. If there is noone 
-; specified min, we choose a contour min which goes well with the specified interval! 
-; If this keyword is not specified, we trace 20 isolines from the min to the max. 
+; @keyword CONTINTERVALLE
+; When CONTOUR is activated, it is the value between 2 isolines
+; traced by a trait. So it can be different from the one specified by INTERVALLE which,
+; in this case, does not control colored isolines in color anymore. If there is noone
+; specified min, we choose a contour min which goes well with the specified interval!
+; If this keyword is not specified, we trace 20 isolines from the min to the max.
 ;
 ; @keyword CONTLABEL {type=integer}
 ; It is an integer n. When CONTOUR is activated, if n
-; is different of 0, choose the label type corresponding to n cases for 
-; the traced by a traitisolines. To specify the type of label of the 
+; is different of 0, choose the label type corresponding to n cases for
+; the traced by a traitisolines. To specify the type of label of the
 ; colored contour, use LABEL
 ;
 ; @keyword CONTMAX {default=The max of the array passed in the keyword CONTOUR (on ocean points)}
-; When CONTOUR is activated, max value we want to consider in the isoline 
+; When CONTOUR is activated, max value we want to consider in the isoline
 ; traced by a trait's line
 ;
 ; @keyword CONTMIN {default=The min of the array passed in the keyword CONTOUR (on ocean points)}
-; When CONTOUR is activated, min value we want to consider in the isoline 
+; When CONTOUR is activated, min value we want to consider in the isoline
 ; traced by a trait's line.
 ;
@@ -72 +69 @@
 ; CONTLABEL=0)
 ;
-; @keyword CONTOUR 
-; If we want to trace contours of a different field than the one 
-; whose we have the colored drawing (by example E-P in color and QSR in contours). 
+; @keyword CONTOUR
+; If we want to trace contours of a different field than the one
+; whose we have the colored drawing (by example E-P in color and QSR in contours).
 ; It must be a field respecting same characteristics than the argument number one of plt.
 ;
@@ -80 +77 @@
 ; Comment: In this case, we should use a structure like field.
 ;
-; @keyword INTERVALLE 
-; Value of an internal between to isoline. If there is none specified min, 
-; we choose a min contour which goes well with the specified interval!. If this keyword is not 
-; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated, 
-; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval 
+; @keyword INTERVALLE
+; Value of an internal between to isoline. If there is none specified min,
+; we choose a min contour which goes well with the specified interval!. If this keyword is not
+; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
+; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
 ; between 2 isolines traced by a trait, use CONTINTERVALLE.
 ;
-; @keyword INV 
-; Invert the color vector used to color the graph 
+; @keyword INV
+; Invert the color vector used to color the graph
 ;               (without use the black, the white and the used palette)
-; 
+;
 ; @keyword LABEL {type=integer}
-; It is an integer n. If n different of 0, it choose the label's type 
-; corresponding to cases n. cf label.pro
-; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines. 
+; It is an integer n. If n different of 0, it choose the label's type
+; corresponding to cases n. cf <pro>label</pro>
+; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
 ; For these one traced by a trait, use CONTLABEL.
 ;       
@@ -101 +98 @@
 ; This keyword can be of two types:
 ;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET).
-;     /MAP: In this case, map is automatically calculated have the value: 
+;     /MAP: In this case, map is automatically calculated have the value:
 ;          map = [0, (lon1+lon2)/2., 0]
 ; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
 ; IDL> demo
 ; Then choose earth sciences and  mapping.
-; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map). 
+; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).
 ; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
 ; For example, for a polar projection centered on the south pole:
@@ -115 +112 @@
 ; Corresponds to label keywords of map_set.
 ;
-; @keyword MAXIN 
+; @keyword MAXIN
 ; to specify the max value we want to plot with a keyword instead of with the
 ; input parameter max. If max is defined by both, parameter and keyword, the
 ; keyword is retained.
 ;
-; @keyword MININ 
+; @keyword MININ
 ; to specify the min value we want to plot with a keyword instead of with the
 ; input parameter min. If min is defined by both, parameter and keyword, the
@@ -129 +126 @@
 ; LABEL=0 or is not specified.
 ;
-; @keyword NOTRI 
-; To force not to use the triangulation. Beware, in this case, the 
-; drawing only works if the grid is undeformed (It means that each point of a longitude 
-; give one latitude and each point of a latitude give one longitude) except if we use 
-; the keyword CELL_FILL=2. 
+; @keyword NOTRI
+; To force not to use the triangulation. Beware, in this case, the
+; drawing only works if the grid is undeformed (It means that each point of a longitude
+; give one latitude and each point of a latitude give one longitude) except if we use
+; the keyword CELL_FILL=2.
 ; Comment: if the field contain points !values.f_nan, then we even do a triangulation.
 ;
-; @keyword OVERPLOT 
-; To make a plot over an other one. 
-; Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword 
+; @keyword OVERPLOT
+; To make a plot over an other one.
+; Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
 ; does not the caption and/or the color bar.
 ;
-; @keyword STRICTFILL 
-; Activate this keyword to that the filling of contours be 
-; precisely done between the min and the max specified letting values inferior at the 
+; @keyword STRICTFILL
+; Activate this keyword to that the filling of contours be
+; precisely done between the min and the max specified letting values inferior at the
 ; specified min and values superior at the specified max in white.
 ;
@@ -158 +155 @@
 ;
 ; @keyword _EXTRA
-; used to pass your keywords
-; 
-; @keyword CONT_NOFILL       
-; Activate it not to fill the point mask to let them transparent! 
+; Used to pass keywords
+;
+; @keyword CONT_NOFILL
+; Activate it not to fill the point mask to let them transparent!
 ; Comment: Nevertheless, we trace mask's contour.
-; 
+;
 ; @keyword USETRI
 ; To force using triangulation.
-; 
-; @keyword MASKFILL 
-; 
+;
+; @keyword MASKFILL
+;
 ; @keyword DUPLICATE
 ;
@@ -176 +173 @@
 ; common.pro
 ;
-; @history 
+; @history
 ; Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ; 7/1999
 ; Sebastien Masson 08/02/2000 checkfield and
 ; notri keyword (or triangule = -1) .
-; 
+;
 ; @version
 ; $Id$
-; 
-; @todo seb 
+;
+; @todo seb
 ; Changer param "tab1",keyword "REMPLI", "UNLABSUR", "UNSUR2",
 ; "UNVECTSUR"+ quelques trucs dans la routine.
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-pro plt, tab1, param2, param3, param4, REALCONT = realcont, CONTOUR = contour $
+;
+PRO plt, tab1, param2, param3, param4, REALCONT = realcont, CONTOUR = contour $
          , INTERVALLE = intervalle, INV = inv, GRIDTYPE = gridtype, BOXZOOM = boxzoom $
          , CONTINTERVALLE = contintervalle, LABEL = label, CONTLABEL = contlabel $
@@ -201 +196 @@
          , DUPLICATE = duplicate, STRICTFILL = strictfill, OVERPLOT = overplot $
          , DECIMATETRI = decimatetri,  LABMAP = labmap, _extra = ex
-;---------------------------------------------------------
-; include common
 ;
   compile_opt idl2, strictarrsubs
@@ -239 +232 @@
   if n_elements(param3) NE 0 then min = param3
   if n_elements(param4) NE 0 then max = param4
-  if n_elements(minin) NE 0 then min = minin 
+  if n_elements(minin) NE 0 then min = minin
   if n_elements(maxin) NE 0 then max = maxin
   checktypeminmax, 'plt', TYPE = type, MIN = min, MAX = max, _extra = ex
-  z2d = checkfield(tab1, 'plt', TYPE = type, BOXZOOM = boxzoom, DIREC = direc, VECTEUR = vecteur, _extra = ex) 
-  if z2d[0] EQ -1 then BEGIN 
+  z2d = checkfield(tab1, 'plt', TYPE = type, BOXZOOM = boxzoom, DIREC = direc, VECTEUR = vecteur, _extra = ex)
+  if z2d[0] EQ -1 then BEGIN
     IF keyword_set(savedbox) THEN restoreboxparam, 'boxparam4plt.dat'
     return
@@ -249 +242 @@
   IF n_elements(usetri) EQ 0 THEN BEGIN
 ; do we have holes in the triangulation?
-    holeintri = n_elements(triangles_list)/3 LT (jpi-1+keyword_set(key_periodic))*(jpj-1)*2 ; -> the triangulation must be used to draw the field 
+    holeintri = n_elements(triangles_list)/3 LT (jpi-1+keyword_set(key_periodic))*(jpj-1)*2 ; -> the triangulation must be used to draw the field
 ; do we have a triangulation?
     wehavetri = triangles_list[0] NE -1 ; -> the triangulation must be used to draw the continents
@@ -260 +253 @@
       'F':nx = nxf
     ENDCASE
-    mapperio = keyword_set(map)*keyword_set(key_periodic)*(nx eq jpi) 
+    mapperio = keyword_set(map)*keyword_set(key_periodic)*(nx eq jpi)
     usetri = (wehavetri*(wehavetri+holeintri+mapperio+keyword_set(key_irregular))) < 2
     IF n_elements(notri) NE 0 THEN usetri = 0 > (2-notri)
@@ -273 +266 @@
 ;---------------------------------------------------------------
   IF  strupcase(vargrid) EQ 'W' THEN profond = firstzw NE 0 $
-  ELSE profond = firstzt NE 0 
+  ELSE profond = firstzt NE 0
 ; do we need to extract now the triangulation that will be use for
 ; contouring the field?
@@ -288 +281 @@
   ENDELSE
 ;----------------------------------------------------------------------------
-; I5 determination of the mi:min and of the ma:max of z2d in the same way 
+; I5 determination of the mi:min and of the ma:max of z2d in the same way
 ; as max: max and min: min for the drawing.
 ;-----------------------------------------------------------------------------
   masknan = finite(z2d)
-  nan = total(masknan) NE n_elements(z2d) 
+  nan = total(masknan) NE n_elements(z2d)
 ; Do we need to do an autoscale ???
   autoscale = testvar(var = min) EQ testvar(var = max) AND NOT keyword_set(intervalle)
@@ -302 +295 @@
 ;--------------------------------------------------------------
 ;--------------------------------------------------------------
-; II) We put the drawing in its place on the window or the page 
+; II) We put the drawing in its place on the window or the page
 ; and possible opening of the window or of the page.
 ;--------------------------------------------------------------
@@ -361 +354 @@
 ;----------------------------------------------------------
 ; check mask and triangulation according to the grid type and NaN
-;---------------------------------------------------------- 
-; If we make a drawing at depth, we must redefine a triangulation 
+;----------------------------------------------------------
+; If we make a drawing at depth, we must redefine a triangulation
 ; on the zoom because the land/sea mask at depth may differ from
 ; the one at the surface.
@@ -385 +378 @@
 ;  IF n_elements(twin_corners_up) EQ 0 THEN coinmontemask = -1 ELSE coinmontemask = twin_corners_up
 ;  IF n_elements(twin_corners_dn) EQ 0 THEN coindescendmask =  -1 ELSE coindescendmask = twin_corners_dn
-  if vargrid EQ 'T' OR vargrid EQ 'W' then BEGIN 
+  if vargrid EQ 'T' OR vargrid EQ 'W' then BEGIN
     glammsk = glam
     gphimsk = gphi
   ENDIF ELSE begin
-; decoupe terre: To draw the coast in a clean way, we try to take additionally 
+; decoupe terre: To draw the coast in a clean way, we try to take additionally
 ; points to draw the land. Like that, we do not see gap between T and U/V/F grid.
 ; It is what decoupeterre do. We also redefine trimsk.
@@ -402 +395 @@
 ;------------------------------------------------------------
   typetrace = 'classique'
-  if keyword_set(map) AND key_onearth then BEGIN 
+  if keyword_set(map) AND key_onearth then BEGIN
 ; Call of  mapset when we want to do projections.
     IF n_elements(map) NE 3 THEN map = [0, ((lon1+lon2)/2.) MOD 360, 0]
@@ -410 +403 @@
     map_rot = map[2]
     if chkstru(ex, 'TITLE') then begin
-      maptitre = ex.title 
+      maptitre = ex.title
       ex.title = ''
     endif
@@ -418 +411 @@
     if n_elements(trifield) GE 2 then trifield = ciseauxtri(trifield, glam, gphi, _EXTRA = ex)
     if n_elements(trimsk) GE 2 then trimsk = ciseauxtri(trimsk, glammsk, gphimsk, _EXTRA = ex)
-    if n_elements(trinan) GE 2 then BEGIN 
+    if n_elements(trinan) GE 2 then BEGIN
       trinan = ciseauxtri(trinan, glam, gphi, _EXTRA = ex)
       if trinan[0] EQ -1 then undefine, trinan
     endif
-  ENDIF ELSE BEGIN 
+  ENDIF ELSE BEGIN
 ;To axes of coordinates be considerated.
     if !x.type EQ 0 AND n_elements(contour) LE 4 then $
-      plot, [0], [0], /nodata, xstyle = 5, ystyle = 5, title = '', subtitle = '', /noerase 
+      plot, [0], [0], /nodata, xstyle = 5, ystyle = 5, title = '', subtitle = '', /noerase
     if keyword_set(key_periodic) then BEGIN
-; In this case, triangulation is closed in x and cover all the sphere. 
+; In this case, triangulation is closed in x and cover all the sphere.
 ; We have to cut it at the level where we cut the sphere to make the drawing.
       if n_elements(trifield) GE 2 then trifield = ciseauxtri(trifield, glam, gphi, _EXTRA = ex)
@@ -461 +454 @@
                            , Connout, vertices = Vertsout $
                            , percent_vertices = decimatetri)
-    connout = reform(connout, 4,  n_elements(connout)/4, /over) 
+    connout = reform(connout, 4,  n_elements(connout)/4, /over)
     trifield = (temporary(connout))[1:3, *]
     glam = reform(Vertsout[0, *])
@@ -467 +460 @@
     z2d = reform(Vertsout[2, *])
     undefine, Vertsout
-    print, 'temps decimatetri', systime(1)-tempsdeux 
+    print, 'temps decimatetri', systime(1)-tempsdeux
   ENDIF
   pltbase, z2d, glam, gphi $
@@ -486 +479 @@
     return
   endif
-  if keyword_set(contour) THEN BEGIN 
+  if keyword_set(contour) THEN BEGIN
     pourlegende = [1, 1, 1, 1]
     oldattributs = saveatt()
@@ -507 +500 @@
 ; V1) Possible add of vectors in double exposure.
 ;------------------------------------------------------------
-  if keyword_set(vecteur) then BEGIN 
+  if keyword_set(vecteur) then BEGIN
     oldattributs = saveatt()
     ajoutvect, vecteur, vectlegende, _extra = ex
@@ -545 +538 @@
 ;------------------------------------------------------------
   legende, mi, ma, 'xy', CONTOUR = pourlegende, VECTLEGENDE = vectlegende, INTERVALLE = intervalle, DIREC = direc, _EXTRA = ex
-  if n_elements(ex) NE 0 then BEGIN 
+  if n_elements(ex) NE 0 then BEGIN
 ; To keep frame's axes in black
     if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = coast_color
@@ -553 +546 @@
     'classique': $
       plot, [0], [0], /nodata, /noerase, color = 0, xstyle = 1, ystyle = 1, _extra = ex
-    'projection': BEGIN 
+    'projection': BEGIN
       if chkstru(ex, 'NOERASE') then begin
         oldnoerase = ex.noerase
@@ -592 +585 @@
 sortie:
   if keyword_set(savedbox) THEN restoreboxparam, 'boxparam4plt.dat'
-  if keyword_set(key_performance) NE 0 THEN print, 'temps plt', systime(1)-tempsun 
+  if keyword_set(key_performance) NE 0 THEN print, 'temps plt', systime(1)-tempsun
 ;------------------------------------------------------------
 ;------------------------------------------------------------

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt1d.pro

@@ -1 @@
-;------------------------------------------------------------
 ;+
 ;
@@ -8 +7 @@
 ; Graphics
 ;
-; @param TAB {in}{required} 
+; @param TAB {in}{required}
 ; The field whose we want to make the hovmoller map can be 2 kind of thing:
 ;       1) An array which can be:
-;          * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array will pass 
-;          in moyenne or grossemoyenne to be averaged and become  an array 1d. 
-;          * 1d:Nevertheless, the type must be specified in order to we know which trace 
+;          * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array will pass
+;          in moyenne or grossemoyenne to be averaged and become  an array 1d.
+;          * 1d:Nevertheless, the type must be specified in order to we know which trace
 ;          it is about. To have a correct caption, respecify the  extraction zone via BOXZOOM.
-;       2) a structure respecting all criterions specified by litchamp.pro. 
-;          See IDL> xhelp,'litchamp'. The array contained in the structure 
-;          respecting criterions of case 1) 
-;
-; @param PARAM2 {in}{required} 
+;       2) a structure respecting all criterions specified by <pro>litchamp</pro>
+;          See IDL> xhelp,'litchamp'. The array contained in the structure
+;          respecting criterions of case 1)
+;
+; @param PARAM2 {in}{required}
 ; Min value we want to consider in the contour's drawing.
 ; Note: could also be the type of plot:'x','y','z'
-;  
-; @param PARAM3 {in}{optional}{default=min/max of tab (on ocean points)} 
+;
+; @param PARAM3 {in}{optional}{default=min/max of tab (on ocean points)}
 ; Max value we want to consider in the contour's drawing.
 ; Note: if param2 is defined as 'x','y','z' then param3 is used to define the min (see param2)
 ;
-; @param PARAM4 {in}{optional}{default=max of tab (on ocean points)} 
+; @param PARAM4 {in}{optional}{default=max of tab (on ocean points)}
 ; Type of plot (can be only 'x','y','z' for plt1d).
 ; Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3)
 ;
 ; @keyword BOXZOOM
-; Vector indicating the geographic zone (3d) on which the extraction of the field must 
+; Vector indicating the geographic zone (3d) on which the extraction of the field must
 ; be done to do the hovmoeller.
 ;  If BOXZOOM has :
@@ -44 +43 @@
 ;
 ; @keyword COL1d
-;  --OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the 
-; keyword COLOR used by plot.
-;
-; @keyword ENDPOINTS 
-; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
-; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
-; coordinates.
-;
-; @keyword MAXIN 
-; Allows to specify the max value we want to consider in the drawing of contour 
-; helping by the keyword instead of the argument max. If the argument and the keyword are 
-; specified in the same time, it is the value specified by the keyword which is retained.
-;
-; @keyword MININ 
-; Allows to specify the min value we want to consider in the drawing of contour 
-; helping by the keyword instead of the argument min. If the argument and the keyword are 
-; specified in the same time, it is the value specified by the keyword which is retained.
+;  --OBSOLETE--Color number when we make a trace 1d by default, 0.
+; It is better to use the keyword COLOR used by plot.
+;
+; @keyword ENDPOINTS
+; keyword specifying that we want to make a vertical cut in diagonal.
+; Then coordinated of extremities of these one are defined by the 4 elements
+; of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates.
+;
+; @keyword MAXIN
+; Allows to specify the max value we want to consider in the drawing of contour
+; helping by the keyword instead of the argument max.
+; If the argument and the keyword are specified in the same time, it is the
+; value specified by the keyword which is retained.
+;
+; @keyword MININ
+; Allows to specify the min value we want to consider in the drawing of contour
+; helping by the keyword instead of the argument min.
+; If the argument and the keyword are specified in the same time, it is the
+; value specified by the keyword which is retained.
 ;
 ; @keyword OV1D
 ; Allow the double exposure of an 1d curve to a precedent 1d trace.
 ;
-; @keyword REVERSE_X 
+; @keyword REVERSE_X
 ; To invert the x axis (so as the drawing)
 ;
-; @keyword REVERSE_Y 
+; @keyword REVERSE_Y
 ; To invert the y axis (so as the drawing)
 ;
-; @keyword SIN 
-; Activate this keyword if we want the x axis to be traced in sinus of the 
+; @keyword SIN
+; Activate this keyword if we want the x axis to be traced in sinus of the
 ; latitude when we make a drawing f(y)
 ;
-; @keyword STY1D 
+; @keyword STY1D
 ; --OBSOLETE--
-; Number of the style used when we make a 1d drawing. We should better use the 
-; keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still 
+; Number of the style used when we make a 1d drawing. We should better use the
+; keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still
 ; useful if we want to d bars instead of curves, put sty1d='bar'
 ;
 ; @keyword TYPEIN
 ; allows to specify the type of hovmoller we want to do
-;             'xt','yt','zt','t'  
-; with help of a keyword rather than the argument type. If the argument and the 
-; keyword are specified in the same time, it is the value specified by the 
+;             'xt','yt','zt','t'
+; with help of a keyword rather than the argument type. If the argument and the
+; keyword are specified in the same time, it is the value specified by the
 ; keyword which is retained.
 ;
-; @keyword _EXTRA 
-; used to pass your keywords
-;
-; @history 
-; creation 24/6/99 Eric Guilyardi 
+; @keyword _EXTRA
+; Used to pass keywords
+;
+; @history
+; creation 24/6/99 Eric Guilyardi
 ; (a partir routine pltt de Sebastien Masson)
-; 8/7/1999 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
+; 8/7/1999 Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ; inspection des travaux finis
 ; 8/2/2000 Sebastien Masson: checkfield
 ;
-; @version 
+; @version
 ; $Id$
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-pro plt1d, tab, param2, param3, param4, BOXZOOM = boxzoom, SIN = sin $
+;
+PRO plt1d, tab, param2, param3, param4, BOXZOOM = boxzoom, SIN = sin $
            , MININ = minin, MAXIN = maxin, TYPEIN = typein, ENDPOINTS = endpoints $
            , COL1D = col1d, STY1D = sty1d, OV1D = ov1d, X = x, Y = y, Z = z, TT = tt $
@@ -137 +136 @@
   if n_elements(maxin) NE 0 then max = maxin
   if keyword_set(tt) then typein = 't'
-  if keyword_set(typein) then BEGIN 
+  if keyword_set(typein) then BEGIN
     if size(type, /type) NE 7 AND size(type, /type) NE 0 then begin
       if n_elements(min) NE 0 then max = min
@@ -146 +145 @@
 ;
   checktypeminmax, 'plt1d', TYPE = type, MIN = min, MAX = max, ENDPOINTS = endpoints $
-    , XX = keyword_set(x), YY = keyword_set(y), ZZ = keyword_set(z) 
+    , XX = keyword_set(x), YY = keyword_set(y), ZZ = keyword_set(z)
   if type EQ 't' then BEGIN
     pltt, tab, type, min, max, BOXZOOM = boxzoom, SIN = sin, TYPEIN = typein $
@@ -168 +167 @@
     section, tab, z1d, glam, gphi, ENDPOINTS = endpoints, TYPE = type $
       , BOXZOOM = boxzoom, DIREC = direc
-    nx = n_elements(glam) 
+    nx = n_elements(glam)
     ny = nx
     if strupcase(vargrid) EQ 'W' then begin
@@ -177 +176 @@
       nz = nzt
     ENDELSE
-  ENDIF ELSE BEGIN 
+  ENDIF ELSE BEGIN
     z1d = checkfield(tab, 'plt1d', TYPE = type, BOXZOOM = boxzoom $
                      , direc = direc, _extra = ex)
     grille, mask, glam, gphi, gdep, nx, ny, nz, type = type
   ENDELSE
-  if z1d[0] EQ -1 then BEGIN 
+  if z1d[0] EQ -1 then BEGIN
     IF keyword_set(savedbox) THEN restoreboxparam, 'boxparam4plt1d.dat'
     return
 endif
-; We build the mask. For this, the array must be hidden (Automaticaly done at valmask 
+; We build the mask. For this, the array must be hidden (Automaticaly done at valmask
 ; value if we pass in moyenne or grossemoyenne)
   mask = fltarr(n_elements(z1d))
@@ -212 +211 @@
 ;-----------------------------------------------------------------------------
 ; definition of the abscisse and ordinate vectors.
-; The triangulation is defined in order to the drawing be done from the 
-; left bottom to the right up. So the matrix have to be shown like this, 
+; The triangulation is defined in order to the drawing be done from the
+; left bottom to the right up. So the matrix have to be shown like this,
 ; from which some transpose and reverse
 ;-----------------------------------------------------------------------------
@@ -220 +219 @@
     'y': begin
       yy = z1d
-      IF (size(gphi))[0] EQ 1 then xx = gphi ELSE BEGIN 
-        IF keyword_set(key_irregular) THEN BEGIN 
+      IF (size(gphi))[0] EQ 1 then xx = gphi ELSE BEGIN
+        IF keyword_set(key_irregular) THEN BEGIN
           cln = (where(gphi EQ max(gphi)))[0]
           xx = reform(gphi[cln MOD nx, *])
@@ -233 +232 @@
       xx = glam[*, 0]
       min0 = lon1 & max0 = lon2
-    END 
+    END
     'z':begin
       yy = reverse(gdep, 1)
@@ -247 +246 @@
       endcase
       if NOT keyword_set(ov1d) then !y.range = reverse(!y.range)
-    END 
-  ENDCASE 
+    END
+  ENDCASE
 ;-----------------------------------------------------------
 ;-----------------------------------------------------------
@@ -263 +262 @@
   if type EQ 'z' then begin
     idx = where(xx NE valmask)
-    if NOT keyword_set(ov1d) then BEGIN 
+    if NOT keyword_set(ov1d) then BEGIN
       if min EQ mi then !x.range = [min-abs(max-min)/5., max+abs(max-min)/5.] $
       ELSE !x.range = [min, max]
     ENDIF
-  ENDIF ELSE BEGIN 
+  ENDIF ELSE BEGIN
     idx = where(yy NE valmask)
-    if NOT keyword_set(ov1d) then BEGIN 
+    if NOT keyword_set(ov1d) then BEGIN
       if min EQ mi then !y.range = [min-abs(max-min)/5., max+abs(max-min)/5.] $
       ELSE !y.range = [min, max]
     ENDIF
-  ENDELSE 
-;
-  if NOT keyword_set(ov1d) then BEGIN 
+  ENDELSE
+;
+  if NOT keyword_set(ov1d) then BEGIN
     legende, mi, ma, type, CONTOUR = contour, DIREC = direc, ENDPOINTS = endpoints, _EXTRA = ex
 ;
@@ -283 +282 @@
     xx = yy
     yy = temporary(tmp)
-    if NOT keyword_set(ov1d) then BEGIN 
+    if NOT keyword_set(ov1d) then BEGIN
       tmp = !x
       !x = !y
@@ -289 +288 @@
     ENDIF
   ENDIF
-  if NOT keyword_set(ov1d) then BEGIN 
+  if NOT keyword_set(ov1d) then BEGIN
     if keyword_set(reverse_x) then !x.range = reverse(!x.range)
     if keyword_set(reverse_y) then !y.range = reverse(!y.range)
@@ -299 +298 @@
   if keyword_set(sty1d) then BEGIN ;If we want to make bars
     IF strlowcase(strtrim(sty1d)) EQ 'bar' then begin
-      !y.range = [!y.range[0]-(!y.range[1]-!y.range[0])*.05, !y.range[1]] 
+      !y.range = [!y.range[0]-(!y.range[1]-!y.range[0])*.05, !y.range[1]]
       bar_plot, yy, background = (!d.n_colors-1) < 255,  $
         baselines = replicate(!y.range[0], n_elements(yy)), barnames = ['', ''], $
         colors    = replicate(col1d, n_elements(yy)), /outline
-      if n_elements(ex) NE 0 then BEGIN 
+      if n_elements(ex) NE 0 then BEGIN
 ; To have a black frame
         if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = 0
@@ -309 +308 @@
       plot, [0], [0], /noerase, /nodata, _extra = ex
       GOTO, fini
-    ENDIF 
-  ENDIF
-;
-  if NOT keyword_set(ov1d) then BEGIN 
+    ENDIF
+  ENDIF
+;
+  if NOT keyword_set(ov1d) then BEGIN
 ;
     plot, xx, yy, color = col1d, linestyle = sty1d, thick = 2, title = '', subtitle = '', _extra = ex
-    if n_elements(ex) NE 0 then BEGIN 
+    if n_elements(ex) NE 0 then BEGIN
 ; To have a 0 colored frame and trace a line at y=0
       if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = 0
@@ -340 +339 @@
 ;------------------------------------------------------------
   if n_elements(key_performance) NE 0 then $
-    IF key_performance EQ 1 THEN print, 'temps plt1d', systime(1)-tempsun 
+    IF key_performance EQ 1 THEN print, 'temps plt1d', systime(1)-tempsun
 ;------------------------------------------------------------
 ;------------------------------------------------------------

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltbase.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
@@ -93 +90 @@
 ;
 ; @keyword _EXTRA
-; Used to pass your keywords
+; Used to pass keywords
 ;
 ; @uses
@@ -113 +110 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 PRO pltbase, z2d, x, y, mask, xm, ym, levels, colors, UNSUR2 = unsur2, CONTOUR = contour $
              , NOCONTOUR = nocontour, NOFILL = nofill $

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltsc.pro

@@ -2 +2 @@
 ; @file_comments
 ;
-;
 ; @categories
-;
 ;
 ; @param TAB1
 ;
-;
 ; @param TAB2
-;
 ;
 ; @param MIN1
 ;
-;
 ; @param MAX1
-;
 ;
 ; @param MIN2
 ;
-;
 ; @param MAX2
-;
 ;
 ; @param VARNAME2
 ;
-;
 ; @keyword BOXZOOM
-; 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]]
@@ -38 +29 @@
 ; @keyword COL1D
 ;
-;
 ; @keyword STY1D
-;
 ;
 ; @keyword OV1D
 ;
-;
 ; @keyword _EXTRA
-; Used to pass your keywords
+; Used to pass keywords
 ;
 ; @returns
 ;
-;
 ; @uses
-;
 ;
 ; @restrictions
 ;
-;
 ; @examples
 ;
-;
 ; @history
-;
 ;
 ; @version
@@ -74 +57 @@
 ; scatter plot (inspired from plt1d)
 ;
-;
   compile_opt idl2, strictarrsubs
 ;
-
-;---------------------------------------------------------
-; include common
 @cm_4mesh
 @cm_4data
@@ -86 +65 @@
 @updatekwd
   ENDIF
-;--------------------------------------------------------------
 
 ; Comment: We do not reinitializate when we call back pltsc
@@ -92 +70 @@
    ;; reduce data xyzt domain
 
-   if keyword_set(boxzoom) then BEGIN 
+   if keyword_set(boxzoom) then BEGIN
      Case 1 Of
        N_Elements(Boxzoom) Eq 1:bte = [lon1, lon2, lat1, lat2, 0., boxzoom[0]]
@@ -100 +78 @@
        N_Elements(Boxzoom) Eq 6:bte = Boxzoom
        Else: Begin
-         ras = report('Wrong Definition of Boxzoom') 
+         ras = report('Wrong Definition of Boxzoom')
          return
        End
@@ -122 +100 @@
    IF finite(min2) EQ 0 THEN min2 = min(tab2)
    IF finite(max2) EQ 0 THEN max2 = max(tab2)
-   
+
 
 ; init plot if not overlay
-   
+
    IF NOT keyword_set(ov1d) THEN placedessin, 'yfx', posfenetre, posbar, $
     contour = contour, _extra = ex
@@ -137 +115 @@
    IF (NOT keyword_set(sty1d)) THEN sty1d = 0
    IF (NOT keyword_set(col1d)) THEN col1d = 0
-   IF  NOT keyword_set(ov1d) THEN  BEGIN 
-      legende, min1, max1, 'yfx', VARNAME2 = varname2, NPTS = npts, _EXTRA = ex 
+   IF  NOT keyword_set(ov1d) THEN  BEGIN
+      legende, min1, max1, 'yfx', VARNAME2 = varname2, NPTS = npts, _EXTRA = ex
 ;
       plot,xx,yy, background = 255, psym = sty1d+1, color=col1d, thick=2 $
        , title = '', subtitle = '',_extra = ex
 
-      if n_elements(ex) NE 0 then BEGIN 
+      if n_elements(ex) NE 0 then BEGIN
 ; To have a 0 colored frame and trace a line at y=0
          if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = 0
@@ -162 +140 @@
 ;------------------------------------------------------------
    if n_elements(key_performance) NE 0 then $
-    IF key_performance EQ 1 THEN print, 'temps plt1d', systime(1)-tempsun 
+    IF key_performance EQ 1 THEN print, 'temps plt1d', systime(1)-tempsun
 ;------------------------------------------------------------
 ;------------------------------------------------------------
@@ -168 +146 @@
    return
 end
-
-

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltt.pro

@@ -1 @@
-;------------------------------------------------------------
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Trace hovmoller graphs: xt,yt,zt,t
 ;
 ; @categories Graphics
 ;
-; @param TAB {in}{required} 
+; @param TAB {in}{required}
 ; The field whose we want to make the hovmoller map can be 2 kind of thing:
 ;       1) An array which can be:
-;          * 3d or 4d: array  'xt','yt','zt','t'. The last component is the time. In this case, the array will 
+;          * 3d or 4d: array  'xt','yt','zt','t'. The last component is the time. In this case, the array will
 ;            pass in grossemoyenne to be averaged and become an 1d or 2d array.
-;          * 2d: If the array is already 2d, it is not modified (beware, lands must 
-;            be masked at the value valmask) and nevertheless,type must be specified 
+;          * 2d: If the array is already 2d, it is not modified (beware, lands must
+;            be masked at the value valmask) and nevertheless,type must be specified
 ;            to we know of which trace it is about.
 ;            To have a correct caption, respecify the  extraction zone via BOXZOOM.
-;          * 1d: only for traces of the 't' type. Nevertheless, type must be specified 
+;          * 1d: only for traces of the 't' type. Nevertheless, type must be specified
 ;            to we know of which trace it is about.
 ;            To have a correct caption, respecify the  extraction zone via BOXZOOM.
-;       2) a structure respecting all criterions specified by litchamp.pro. 
-;          See IDL> xhelp,'litchamp'. The array contained in the structure 
-;          respecting criterions of case 1) 
-;  
+;       2) a structure respecting all criterions specified by <pro>litchamp</pro>
+;          See IDL> xhelp,'litchamp'. The array contained in the structure
+;          respecting criterions of case 1)
+;
 ; PARAM:        
 ;       MAX: valeur maximum que l''on veut prendre en compte dans le trace
@@ -38 +37 @@
 ;
 ; @keyword BOXZOOM
-; Vector indicating the geographic zone (3d) on which the extraction of the field must 
+; Vector indicating the geographic zone (3d) on which the extraction of the field must
 ; be done to do the hovmoeller.
 ;  If BOXZOOM has :
@@ -49 +48 @@
 ; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last domdef!
 ;
-; @keyword CONTINTERVALLE 
-; When CONTOUR is activated, it is the value between 2 isolines 
-; traced by a trait. So it can be different from the one specified by INTERVALLE which, 
-; in this case, does not control colored isolines in color anymore. If there is noone 
-; specified min, we choose a contour min which goes well with the specified interval! 
-; If this keyword is not specified, we trace 20 isolines from the min to the max. 
+; @keyword CONTINTERVALLE
+; When CONTOUR is activated, it is the value between 2 isolines
+; traced by a trait. So it can be different from the one specified by INTERVALLE which,
+; in this case, does not control colored isolines in color anymore. If there is noone
+; specified min, we choose a contour min which goes well with the specified interval!
+; If this keyword is not specified, we trace 20 isolines from the min to the max.
 ;
 ; @keyword CONTLABEL {type=integer}
 ; When CONTOUR is activated, if n
-; is different of 0, choose the label type corresponding to n cases for 
-; the traced by a traitisolines. To specify the type of label of the 
+; is different of 0, choose the label type corresponding to n cases for
+; the traced by a traitisolines. To specify the type of label of the
 ; colored contour, use LABEL
 ;
 ; @keyword CONTMAX {default=we take the max of the array passed in the keyword CONTOUR (on ocean points)}
-; When CONTOUR is activated, max value we want to consider in the isoline 
-; traced by a trait's line. 
+; When CONTOUR is activated, max value we want to consider in the isoline
+; traced by a trait's line.
 ;
 ; @keyword CONTMIN {default=we take the min of the array passed in the keyword CONTOUR (on ocean points)}
-; When CONTOUR is activated, min value we want to consider in the isoline 
-; traced by a trait's line. 
+; When CONTOUR is activated, min value we want to consider in the isoline
+; traced by a trait's line.
 ;
 ; @keyword CONTNLEVEL {default=20}
@@ -75 +74 @@
 ; CONTLABEL=0).
 ;
-; @keyword CONTOUR 
-; If we want to trace contours of a different field than the one 
-; whose we have the colored drawing (by example E-P in color and QSR in contours). 
+; @keyword CONTOUR
+; If we want to trace contours of a different field than the one
+; whose we have the colored drawing (by example E-P in color and QSR in contours).
 ; It must be a field respecting same characteristics than the argument number one of pltt.
 ;
-; @keyword ENDPOINTS 
-; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
-; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
-; coordinates. 
+; @keyword ENDPOINTS
+; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
+; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
+; coordinates.
 ;
 ; @keyword EXCHANGE_XY
 ; Allows to invert axes.
-; 
+;
 ; @keyword FILTER
 ; Apply a slippery average of width FILTER
-; 
-; @keyword INTERVALLE 
-; Value of an internal between to isoline. If there is none specified min, 
-; we choose a min contour which goes well with the specified interval!. If this keyword is not 
-; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated, 
-; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval 
+;
+; @keyword INTERVALLE
+; Value of an internal between to isoline. If there is none specified min,
+; we choose a min contour which goes well with the specified interval!. If this keyword is not
+; specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
+; INTERVALLE only specify the interval between 2 colored isoline. To specify the interval
 ; between 2 isolines traced by a trait, use CONTINTERVALLE.
 ;
-; @keyword INV 
-; Invert the color vector used to color the graph 
+; @keyword INV
+; Invert the color vector used to color the graph
 ;               (without use the black, the white and the used palette)
-; 
+;
 ; @keyword LABEL {type=integer}
-; If n different of 0, it choose the label's type 
-; corresponding to cases n. cf label.pro
-; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines. 
-; For these one traced by a trait, use CONTLABEL. 
+; If n different of 0, it choose the label's type
+; corresponding to cases n. cf <pro>label</pro>
+; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
+; For these one traced by a trait, use CONTLABEL.
 ;
 ; @keyword COL1d
-; --OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the 
+; --OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the
 ; keyword COLOR used by plot.
 ;
-; @keyword MAXIN 
+; @keyword MAXIN
 ; to specify the max value we want to plot with a keyword instead of with the
 ; input parameter max. If max is defined by both, parameter and keyword, the
 ; keyword is retained.
 ;
-; @keyword MININ 
+; @keyword MININ
 ; to specify the min value we want to plot with a keyword instead of with the
 ; input parameter min. If min is defined by both, parameter and keyword, the
@@ -131 +130 @@
 ; CONTLABEL=0).
 ;
-; @keyword OV1D 
+; @keyword OV1D
 ; Allows to overprint a 1d curve over a precedent 1d drawing.
 ;
-; @keyword OVERPLOT 
-; To make a plot over an other one. 
-; Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword 
+; @keyword OVERPLOT
+; To make a plot over an other one.
+; Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
 ; does not the caption and/or the color bar.
 ;
-; @keyword STRICTFILL 
-; Activate this keyword to that the filling of contours be 
-; precisely done between the min and the max specified letting values inferior at the 
+; @keyword STRICTFILL
+; Activate this keyword to that the filling of contours be
+; precisely done between the min and the max specified letting values inferior at the
 ; specified min and values superior at the specified max in white.
 ;
@@ -147 +146 @@
 ; Contour's style to adopt to draw isolines
 ;
-; @keyword STY1D 
+; @keyword STY1D
 ; --OBSOLETE--
-; Number of the style used when we make a 1d drawing. We should better use the 
-; keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still 
+; Number of the style used when we make a 1d drawing. We should better use the
+; keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still
 ; useful if we want to d bars instead of curves, put sty1d='bar'
 ;
 ; @keyword TREND_TYPE
-; Modify field by calling trends.pro
+; Modify field by calling <pro>trends</pro>
 ;
 ; @keyword TYPEIN
 ; allows to specify the type of hovmoller we want to do
-;             'xt','yt','zt','t'  
-; with help of a keyword rather than the argument type. If the argument and the 
-; keyword are specified in the same time, it is the value specified by the 
+;             'xt','yt','zt','t'
+; with help of a keyword rather than the argument type. If the argument and the
+; keyword are specified in the same time, it is the value specified by the
 ; keyword which is retained.
 ;
 ; @keyword _EXTRA
-; Used to pass your keywords
+; Used to pass keywords
 ;
 ; @uses
 ; common.pro
 ;
-; @history 
+; @history
 ; Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       27/5/98
@@ -177 +176 @@
 ;                       15/1/98
 ; Adaptation for arrays 3 and 4d to the average be done in pltt rather than during the reading.
-;                       Sebastien Masson 14/8/98 
-;                       7/1999 
+;                       Sebastien Masson 14/8/98
+;                       7/1999
 ;                       Eric Guilyardi 29/7/99 FILTER, TREND_TYPE,
-;                       REPEAT_C 
+;                       REPEAT_C
 ;                       Sebastien Masson 08/02/2000 checkfield and
 ;                       usetri keyword.
-; 
-; @version 
+;
+; @version
 ; $Id$
 ;
 ; @todo seb: L.24 à 36, L.426 à 427, L. 492 à 493
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 pro pltt,tab,giventype,givenmin,givenmax,datmin,datmax,BOXZOOM = boxzoom, CONTOUR=contour $
          ,ENDPOINTS=endpoints,INTERVALLE=intervalle,INV=inv  $
@@ -203 +200 @@
          , EXCHANGE_XY = exchange_xy $
          , _extra = ex
-;---------------------------------------------------------
-; include common
 ;
   compile_opt idl2, strictarrsubs
@@ -237 +232 @@
    if n_elements(minin) NE 0 then min = minin
    if n_elements(maxin) NE 0 then max = maxin
-   if keyword_set(typein) then BEGIN 
+   if keyword_set(typein) then BEGIN
       if size(type, /type) NE 7 AND size(type, /type) NE 0 then begin
          if n_elements(min) NE 0 then max = min
@@ -251 +246 @@
       section, tab, z2d, glam, gphi, ENDPOINTS = endpoints, TYPE = type $
         , BOXZOOM = boxzoom, DIREC = direc
-      nx = n_elements(glam) 
+      nx = n_elements(glam)
       ny = nx
       if strupcase(vargrid) EQ 'W' then begin
@@ -260 +255 @@
          nz = nzt
       ENDELSE
-   ENDIF ELSE BEGIN 
+   ENDIF ELSE BEGIN
       z2d = checkfield(tab, 'pltt', TYPE = type, BOXZOOM = boxzoom $
                        , direc = direc, _extra = ex)
-      if z2d[0] EQ -1 then BEGIN 
+      if z2d[0] EQ -1 then BEGIN
         IF keyword_set(savedbox) THEN restoreboxparam, 'boxparam4pltt.dat'
         return
@@ -278 +273 @@
 
 ;---------------------------------------------------------------
-; Filtering of fields in the 't' case. 
-;---------------------------------------------------------------
-
-   IF type EQ 't' AND keyword_set(filter) THEN BEGIN 
+; Filtering of fields in the 't' case.
+;---------------------------------------------------------------
+
+   IF type EQ 't' AND keyword_set(filter) THEN BEGIN
       print, '    Applying a running mean filter of width '+string(filter, format = '(I3)')
       z2d = smooth(z2d, filter)
       z2d[0:filter/2-1] = 0.
       z2d[(size(z2d))[1]-filter/2-1:(size(z2d))[1]-1] = 0.
-   ENDIF 
+   ENDIF
 
 ;---------------------------------------------------------------
@@ -302 +297 @@
             z2d = z2d[*]#replicate(1, repeat_c)
             z2d = reform(z2d, taille[1], taille[2]*repeat_c, /over)
-         END 
-         ELSE: 
+         END
+         ELSE:
       ENDCASE
       temps = [temps, (lindgen(jpt*(REPEAT_c-1))+1)*(temps[1]-temps[0])+temps[jpt-1]]
-   ENDIF 
-
-;---------------------------------------------------------------
-; Selection of graphic's type. 
+   ENDIF
+
+;---------------------------------------------------------------
+; Selection of graphic's type.
 ;---------------------------------------------------------------
    taille=size(z2d)
@@ -332 +327 @@
       end
   endcase
-; We build the mask. For that, the table must be masked (automaticaly done at the 
+; We build the mask. For that, the table must be masked (automaticaly done at the
 ; value valmask if we pass in moyenne or grossemoyenne)
    nan = total(finite(z2d,/nan)) < 1
@@ -365 +360 @@
 ;-----------------------------------------------------------------------------
 ; definition of the abscisse and ordinate vectors.
-; The triangulation is defined in order to the drawing be done from the 
-; left bottom to the right up. So the matrix have to be shown like this, 
+; The triangulation is defined in order to the drawing be done from the
+; left bottom to the right up. So the matrix have to be shown like this,
 ; from which some transpose and reverse
 ;-----------------------------------------------------------------------------
@@ -401 +396 @@
             end
             type eq 'yt' : begin
-               IF (size(gphi))[0] EQ 1 then yy = gphi ELSE BEGIN 
-                 IF keyword_set(key_irregular) THEN BEGIN 
+               IF (size(gphi))[0] EQ 1 then yy = gphi ELSE BEGIN
+                 IF keyword_set(key_irregular) THEN BEGIN
                    cln = (where(gphi EQ max(gphi)))[0]
                    yy = reform(gphi[cln MOD nx, *])
@@ -422 +417 @@
    endcase
 ;--------------------------------------------------------------
-   if NOT keyword_set(overplot) THEN axe, type, tempsmin, tempsmax, _EXTRA = ex ELSE BEGIN 
-      if type EQ 'xt' then BEGIN 
-         !y.range=!y.range-tempsmin 
+   if NOT keyword_set(overplot) THEN axe, type, tempsmin, tempsmax, _EXTRA = ex ELSE BEGIN
+      if type EQ 'xt' then BEGIN
+         !y.range=!y.range-tempsmin
          !y.tickv=!y.tickv-tempsmin
-      ENDIF ELSE BEGIN 
+      ENDIF ELSE BEGIN
          !x.range=!x.range-tempsmin
          !x.tickv=!x.tickv-tempsmin
@@ -469 +464 @@
                                   , coindescend = coindescendmask)
         usetri = 1
-      ENDIF ELSE triangulation = -1 
+      ENDIF ELSE triangulation = -1
       IF size(gdep, /n_dimensions) EQ 2 THEN BEGIN
         usetri = 2
@@ -475 +470 @@
            triangulation = triangule(mask, /basic, coinmonte = coinmontemask $
                                      , coindescend = coindescendmask)
-      ENDIF  
+      ENDIF
 ;----------------------------------------------------------------------
       pltbase, z2d, xx, yy, mask, xx, yy, level_z2d, colnumb, contour = contour, /noerase $
@@ -488 +483 @@
       endif
 ;------------------------------------------------------------
-      if keyword_set(contour) then BEGIN 
+      if keyword_set(contour) then BEGIN
          pourlegende = [1, 1, 1, 1]
          oldattributs = saveatt()
@@ -506 +501 @@
       IF key_onearth THEN BEGIN
         CASE type OF
-          'xt':oplot, [180, 180] - 360*(!x.range[1] LT 180), !y.range 
+          'xt':oplot, [180, 180] - 360*(!x.range[1] LT 180), !y.range
           'yt':oplot, !x.range, [0, 0]
           ELSE:
@@ -523 +518 @@
 ; the top (right) axis by hand using axis.
 ;
-      if n_elements(ex) NE 0 then BEGIN 
+      if n_elements(ex) NE 0 then BEGIN
 ; pour avoir un cadre de la couleur noire
         if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = 0
@@ -533 +528 @@
 ; call axis for the missing axis.
       IF type EQ 'xt' AND NOT keyword_set(endpoints) THEN BEGIN
-        if n_elements(ex) NE 0 then $ 
+        if n_elements(ex) NE 0 then $
           if (where(tag_names(ex) EQ 'YTICKNAME'))[0] NE -1 then $
           ex.YTICKNAME = replicate(' ', n_elements(ex.YTICKNAME))
@@ -540 +535 @@
       ENDIF
       IF (type EQ 'yt' OR type EQ 'zt') AND NOT keyword_set(endpoints) THEN BEGIN
-        if n_elements(ex) NE 0 then $ 
+        if n_elements(ex) NE 0 then $
           if (where(tag_names(ex) EQ 'XTICKNAME'))[0] NE -1 then $
           ex.XTICKNAME = replicate(' ', n_elements(ex.XTICKNAME))
@@ -564 +559 @@
       if keyword_set(sty1d) then BEGIN ;if we want to make bars
          IF strlowcase(strtrim(sty1d)) EQ 'bar' then begin
-            !y.range = [!y.range[0]-(!y.range[1]-!y.range[0])*.05,!y.range[1]] 
+            !y.range = [!y.range[0]-(!y.range[1]-!y.range[0])*.05,!y.range[1]]
             bar_plot, yy, background = (!d.n_colors-1) < 255,  $
              baselines = replicate(!y.range[0], n_elements(yy)), barnames = ['', ''], $
              colors    = replicate(col1d, n_elements(yy)), /outline
-            if n_elements(ex) NE 0 then BEGIN 
+            if n_elements(ex) NE 0 then BEGIN
 ; To have a black frame
               if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = 0
@@ -574 +569 @@
             plot, [0], [0], /nodata, /noerase, _extra = ex
             GOTO, fini
-         ENDIF 
+         ENDIF
       ENDIF
-      if NOT keyword_set(ov1d) then BEGIN 
+      if NOT keyword_set(ov1d) then BEGIN
          !y.range=[min-abs(max-min)/50.,max+abs(max-min)/50.]
          legende,mi,ma,type, DIREC = direc, _extra = ex
@@ -596 +591 @@
 ; use xstyle=1 then each axis (up and down) have majorticks with a
 ; length of 1 (-> not very nice when xgridstyle=2), same if
-; xticklen=0.5 (not very nice in the middle). 
+; xticklen=0.5 (not very nice in the middle).
 ; => so we draw the top axis by hand using axis.
-         if n_elements(ex) NE 0 then BEGIN 
+         if n_elements(ex) NE 0 then BEGIN
 ; To have a black frame
             if (where(tag_names(ex) EQ 'COLOR'))[0] NE -1 then ex.COLOR = 0
@@ -606 +601 @@
            , ystyle = 1+8*keyword_set(exchange_xy), _extra = ex
 ; call axis for the missing axis.
-         if n_elements(ex) NE 0 then BEGIN 
+         if n_elements(ex) NE 0 then BEGIN
 ; force tickname to blank array
             if (where(tag_names(ex) EQ 'YTICKNAME'))[0] NE -1 AND keyword_set(exchange_xy) then ex.YTICKNAME = replicate(' ', n_elements(ex.YTICKNAME))
@@ -619 +614 @@
 fini:
 ;------------------------------------------------------------
-; we reput time axis in IDL julian days and not in julian days count from tempsmin 
-;------------------------------------------------------------
-   if type EQ 'xt' then BEGIN 
-      !y.range=!y.range+tempsmin 
+; we reput time axis in IDL julian days and not in julian days count from tempsmin
+;------------------------------------------------------------
+   if type EQ 'xt' then BEGIN
+      !y.range=!y.range+tempsmin
       !y.tickv=!y.tickv+tempsmin
-   ENDIF ELSE BEGIN 
+   ENDIF ELSE BEGIN
       !x.range=!x.range+tempsmin
       !x.tickv=!x.tickv+tempsmin
@@ -640 +635 @@
 ;------------------------------------------------------------
    if n_elements(key_performance) NE 0 then $
-    IF key_performance EQ 1 THEN print, 'temps pltt', systime(1)-tempsun 
+    IF key_performance EQ 1 THEN print, 'temps pltt', systime(1)-tempsun
 ;------------------------------------------------------------
 ;------------------------------------------------------------
@@ -646 +641 @@
    return
 end
-
-

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltv.pro

@@ -1 @@
-;------------------------------------------------------------
 ;+
+;
 ; @file_comments
 ; Draw 2d plots with TV procedure
@@ -7 +7 @@
 ; graphic
 ;
-; @param DATA {in}{required} 
+; @param DATA {in}{required}
 ; The field we want to display can be:
 ;    1) an array. If the array is not a 2D array, its mean along
@@ -13 +13 @@
 ;       (as it is done in plt).
 ;    2) a structure respecting all criterions specified by
-;       litchamp.pro. cf. IDL> xhelp,'litchamp'
+;       <pro>litchamp</pro> cf. IDL> xhelp,'litchamp'
 ;
-; @param MIN {in}{optional}{default=min of DATA (on non-masked points)} 
+; @param MIN {in}{optional}{default=min of DATA (on non-masked points)}
 ;
-; @param MAX {in}{optional}{default=max of DATA (on non-masked points)} 
+; @param MAX {in}{optional}{default=max of DATA (on non-masked points)}
 ;
 ; @keyword BOTTOM {default=0}
 ; The lowest color index of the colors to be used
 ;
-; @keyword BOXZOOM 
-; Vector indicating the geographic zone on which we want to cut the map. 
+; @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]]
@@ -54 +54 @@
 ;
 ; @keyword _EXTRA
-; used to pass keywords to PLACEDESSIN, TV, AXE, LEGENDE, BARRECOULEUR, TERMINEDESSIN
-; 
+; Used to pass keywords to <pro>PLACEDESSIN</pro>, <pro>TV</pro>, <pro>AXE</pro>, <pro>LEGENDE</pro>, <pro>BARRECOULEUR</pro>, <pro>TERMINEDESSIN</pro>
+;
 ; @examples
 ; IDL> tvplus, dist(100)
@@ -66 +66 @@
 ;
 ;-
-;--------------------------------------------------------------
-
+;
 PRO pltv, data, min, max, BOTTOM = bottom, BOXZOOM = boxzoom $
           , C_MASK = c_mask, C_NAN = c_nan, MININ = minin, MAXIN = maxin $
@@ -82 +81 @@
 ; I2) Reading of the field and checkup.
 ;--------------------------------------------------------------
-  IF n_elements(minin) NE 0 THEN min = minin 
+  IF n_elements(minin) NE 0 THEN min = minin
   IF n_elements(maxin) NE 0 THEN max = maxin
   IF size(data, /type) NE 8 THEN z2d = reform(float(data)) ELSE z2d = data
@@ -90 +89 @@
       saveboxparam, 'boxparam4pltv.dat'
     ENDIF
-    z2d = checkfield(temporary(z2d), 'plt', TYPE = 'xy', direc = direc, BOXZOOM = boxzoom) 
-    if z2d[0] EQ -1 then BEGIN 
+    z2d = checkfield(temporary(z2d), 'plt', TYPE = 'xy', direc = direc, BOXZOOM = boxzoom)
+    if z2d[0] EQ -1 then BEGIN
       IF keyword_set(savedbox) THEN restoreboxparam, 'boxparam4pltv.dat'
       return
@@ -114 +113 @@
 ;------------------------------------------------------------
   IF n_elements(maskval) EQ 0 THEN maskval = 1.e20
-  IF abs(maskval) LT 1e6 THEN BEGIN 
+  IF abs(maskval) LT 1e6 THEN BEGIN
     IF keyword_set(nan) THEN z2d[nanind] = 1.e20
-    msk = z2d NE maskval 
-  ENDIF ELSE BEGIN 
+    msk = z2d NE maskval
+  ENDIF ELSE BEGIN
     IF keyword_set(nan) THEN z2d[nanind] = 0
     msk = abs(z2d) LT abs(maskval)/10.
@@ -129 +128 @@
   z2d = min > temporary(z2d) < max
 ;------------------------------------------------------------
-; apply other keywords (nointerp, c_nan, c_mask) 
+; apply other keywords (nointerp, c_nan, c_mask)
 ;------------------------------------------------------------
   IF NOT keyword_set(nointerp) THEN BEGIN
@@ -137 +136 @@
     z2d = m * temporary(z2d) + p
   ENDIF
-; set c_nan for NaN values 
+; set c_nan for NaN values
   IF keyword_set(nan) THEN BEGIN
     IF n_elements(c_nan) NE 0 THEN cnan = 0 > c_nan < (ncolmax -1) ELSE cnan = (ncolmax -1)
@@ -143 +142 @@
   ENDIF
 ; c_mask for masked values
-  IF keyword_set(masked) THEN BEGIN   
+  IF keyword_set(masked) THEN BEGIN
     IF n_elements(c_mask) NE 0 THEN cmask = 0 > c_mask < (ncolmax - 1) ELSE cmask = (ncolmax -1)
     z2d[maskind] = cmask
-  ENDIF 
-  z2d = round(temporary(z2d)) 
+  ENDIF
+  z2d = round(temporary(z2d))
 ; use byte type to save memory
   z2d = byte(temporary(z2d))
@@ -161 +160 @@
    xsize = !p.position[2] - !p.position[0]
    ysize = !p.position[3] - !p.position[1]
-   IF !d.name EQ 'X' THEN BEGIN 
+   IF !d.name EQ 'X' THEN BEGIN
      xsize = ceil(xsize * !d.x_size)
      ysize = ceil(ysize * !d.y_size)
      z2d = congrid(z2d, xsize, ysize)
    ENDIF
-   
+
    tv, z2d, !p.position[0], !p.position[1] $
        , xsize = xsize, ysize = ysize $
@@ -185 +184 @@
 ;------------------------------------------------------------
    barrecouleur, 0, min,  max, 10, bottom = bottom, position = posbar, ncolors = (topcol-bottom+1), _extra = ex
-; 4) End of drawing 
-   terminedessin, _extra=ex 
+; 4) End of drawing
+   terminedessin, _extra=ex
 ;
   if keyword_set(savedbox) THEN restoreboxparam, 'boxparam4pltv.dat'
-  if keyword_set(key_performance) NE 0 THEN print, 'time pltv', systime(1)-tempsun 
+  if keyword_set(key_performance) NE 0 THEN print, 'time pltv', systime(1)-tempsun
 ;
    return

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltz.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
@@ -15 +12 @@
 ;         If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom.
 ;         If the field is 3d, we extract the section on we average possibly before to do the plot.
-;         2)  a structure respecting all criterions specified by litchamp.pro.
+;         2)  a structure respecting all criterions specified by <pro>litchamp</pro>.
 ;          See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1)
 ;
@@ -89 +86 @@
 ;
 ; @keyword LABEL {default=0}{type=integer}
-; It choose the label's type corresponding to cases in label.pro.
+; It choose the label's type corresponding to cases in <pro>label</pro>
 ; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
 ; For these one traced by a trait, use CONTLABEL.
@@ -159 +156 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-pro pltz, tab, giventype, givenmin, givenmax, BOXZOOM = boxzoom, CONTOUR = contour $
+;
+PRO pltz, tab, giventype, givenmin, givenmax, BOXZOOM = boxzoom, CONTOUR = contour $
           , ENDPOINTS = endpoints, INTERVALLE = intervalle, INV = inv, ZRATIO = zratio $
           , CONTINTERVALLE = contintervalle, LABEL = label, CONTLABEL = contlabel $
@@ -172 +167 @@
           , WDEPTH = wdepth, REALSECTION = realsection $
           , _EXTRA = ex
-;---------------------------------------------------------
-; include common
 ;
   compile_opt idl2, strictarrsubs
@@ -483 +476 @@
   return
 end
-
-
-

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/sbar_plot.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Same thing that bar_plot but compatible with the whole environment (common.pro included)
 ;
@@ -16 +13 @@
 ;
 ; @keyword COLORS {type=integer}
-; I gives color of all colorbars. (contrarily to colors 
+; I gives color of all colorbars. (contrarily to colors
 ; which is a vector giving the color of each colorbar).
 ;
 ; @keyword NOREINITPLT
-; We active it if we do not want environment variables !p, !x, !y, !z 
+; We active it if we do not want environment variables !p, !x, !y, !z
 ; to be reinitializated by the procedure reinitplt
 ;
 ; @keyword _EXTRA
-; used to pass your keyword
+; Used to pass keyword
 ;
 ; @uses
 ; common.pro
 ;
-; @restrictions 
-; If NOREINITPLT is not activated, all environment 
+; @restrictions
+; If NOREINITPLT is not activated, all environment
 ; variables !p, !x, !y, !z are reinitializted by the procedure reinitplt
 ;
@@ -46 +43 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-
-PRO sbar_plot, Values, COLORS = colors, NOREINITPLT = noreinitplt, _extra = ex 
+;
+PRO sbar_plot, Values, COLORS = colors, NOREINITPLT = noreinitplt, _extra = ex
 ;
   compile_opt idl2, strictarrsubs
 ;
 @common
-; 1) I reinitialize the graphic environment (variables !x, !y et !p): 
-   if NOT keyword_set(NOREINITPLT) then reinitplt, _extra = ex 
-; 2) I place the drawing on the screen like on the postscript 
+; 1) I reinitialize the graphic environment (variables !x, !y et !p):
+   if NOT keyword_set(NOREINITPLT) then reinitplt, _extra = ex
+; 2) I place the drawing on the screen like on the postscript
    IF chkstru(ex, 'overplot')EQ 0 THEN placedessin, 'autre', _extra = ex
-; 3) Drawing 
+; 3) Drawing
    if n_elements(COLORS) NE 0 then BEGIN
       if n_elements(COLORS) EQ n_elements(Values) then col = colors $
@@ -67 +61 @@
    bar_plot, Values, background = !p.background, colors = col $
              , xstyle = 1, ystyle = 1, _extra = ex
-; 4) End of drawing 
-   terminedessin, _extra=ex 
+; 4) End of drawing
+   terminedessin, _extra=ex
 
    return

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/scontour.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
@@ -15 +12 @@
 ;
 ; @keyword _EXTRA
-; used to pass your keywords
+; Used to pass keywords
 ;
 ; @uses
@@ -33 +30 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 PRO scontour, x, y, z, NOREINITPLT = noreinitplt, _EXTRA = ex
 ;

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/splot.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
@@ -15 +12 @@
 ;
 ; @keyword _EXTRA
-; used to pass your keywords
+; Used to pass keywords
 ;
 ; @uses
@@ -37 +34 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 PRO splot, x, y, NOREINITPLT = noreinitplt, _EXTRA = ex
 ;

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/tvplus.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
@@ -7 +4 @@
 ; Enhanced version of tvscl
 ;
-; @categories quick exploration of 2D arrays
+; @categories
+; quick exploration of 2D arrays
 ;
 ; @param Z2D {in}{required}
@@ -64 +62 @@
 ;
 ; @keyword _EXTRA
-; used to pass keywords to TV, PLOT, COLORBAR
+; Used to pass keywords to <pro>TV</pro>, <pro>PLOT</pro>, <pro>COLORBAR</pro>
 ;
 ; @restrictions
@@ -87 +85 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 PRO tvplus, z2d, cellsize, BOTTOM = bottom, C_MASK = c_mask, C_NAN = c_nan, WINDOW = window $
             , MIN = min, MAX = max, MASK = mask, OFFSET = offset, NOUSEINFOS = NOUSEINFOS $
             , NCOLORS = ncolors, NOINTERP = nointerp, _EXTRA = ex
-;
 ;
   compile_opt idl2, strictarrsubs