Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/scontour.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DESSINE/scontour.pro (modified) (3 diffs)

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:scontour (super contour)
 ;
-; PURPOSE: meme chose que contour mais compatible avec l''ensemble de
-; l'environnement (common.pro est inclu)
+; @File_comments
+; Same thing that contour but compatible with the whole environnement (common.pro inclued)
 ;
-; CATEGORY:dessine
+; @categories graphics
 ;
-; CALLING SEQUENCE: scontour, z [, x, y]
-; 
 ; INPUTS:cd IDL>?contour
 ;
-; KEYWORD PARAMETERS:
+; @keyword NOREINITPLT
+; We active it if we do not want environnement variables !p, !x, !y, !z 
+; to be reinitilalizted by the procedure reinitplt
+; 
+; @keyword _EXTRA
+; used to pass your keywords
 ;
-;  meme que ceux de bar_plot avec en plus:
-;      NOREINITPLT: a actier si on ne veut pas que les variables
-;      d''environnemet !p, !x, !y, !z soient reinitialisees par la
-;      procedure reinitplt
+; @uses
+; common.pro
 ;
-; OUTPUTS:
-;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples
 ;      IDL> z = dist(100) 
 ;      IDL> scontour, z, nlevels=10,small=[1,2,1],xstyle=1,ystyle=1
-;      IDL> @ps
+;      IDL> \@ps
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      10/10/1999
+; 
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -45 +41 @@
 ;
 @common
-; 1) je reinitialise l''environnememt graphique (les variables !x, !y et !p): 
+; 1) I reinitializate the graphic environment (variables !x, !y et !p): 
   if NOT keyword_set(NOREINITPLT) then reinitplt, _extra = ex 
-; 2) je place le dessin a l'ecran comme sur le postcript 
+; 2) i put the drawing on the screen like on the postcript 
 ; if ex contains norease and c_orientation keywords we force ex.noerase = 0
   IF chkstru(ex, 'overplot') EQ 0 THEN placedessin, 'autre', _extra = ex
 ; fiddle when noerase is used with c_orentation...
-; call contour with /nodata to get the graphic envoronment, then force
+; call contour with /nodata to get the graphic environment, then force
 ; noerase = 0 and overplot = 1
   IF size(ex, /type) EQ 8 THEN BEGIN
@@ -85 +81 @@
     ENDCASE
   ENDIF
-; 4) je termine le dessin 
+; 4) End of drawing
   terminedessin, _extra = ex