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

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:axis4pltz
 ;
-; PURPOSE:compute the mask and the axis for a vertical section
+; @file_comments
+; compute the mask and the axis for a vertical section
 ;
-; CATEGORY:
+; @param MASK {in}{required}
+;  3d mask
+;        
+; @param GLAM {in}{required}
+; 2d longitude 
+; 
+; @param GPHI {in}{required}
+; 2d latitude
 ;
-; CALLING SEQUENCE:
+; @param Z {in}{required}
+; 1d depth
+;
+; @keyword XXAXIS 
+; to get the xaxis we need to use in pltbase
+;      
+; @keyword ZZAXIS 
+; to get the yaxis we need to use in pltbase
+;
+; @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 ZRATIO
+; When the drawing has a zoomed part, it is the size rapport between the zoomed part, 
+; hz (zoom height), and the whole drawing, ht (total height). By default =2./3
+;
+; @keyword _EXTRA
+; used to pass your keywords
 ; 
-; INPUTS:mask: 3d mask
-;        glam, gphi: 2d longitudes and latitudes
-;        z:1d depth
+;  Others: see pltz 
 ;
-; KEYWORD PARAMETERS:
-;        XXAXIS to get the xaxis we need to use in pltbase
-;        ZZAXIS to get the yaxis we need to use in pltbase
 ;
-;        Others: see pltz 
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                      June 24, 2002
 ;
-; OUTPUTS:
+; @version
+; $Id$
 ;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                      June 24, 2002
 ;-
 ;------------------------------------------------------------
@@ -83 +96 @@
   ENDELSE 
 ;----------------------------------------------------------
-; on projette l''axe z dans [0,1]
+; We project the z axis in [0,1]
 ;----------------------------------------------------------
   if not keyword_set(zratio) then zratio = 2./3