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

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: tvplus
-;
-; PURPOSE: enhanced version of tvscl
-;
-; CATEGORY: quick exploration of 2D arrays 
-;
-; CALLING SEQUENCE: tvplus,z2d [,cellsize]
+;
+; @file_comments
+; Enhanced version of tvscl
+;
+; @categories quick exploration of 2D arrays 
 ;
 ; INPUTS: 
 ;
-;    z2d: 2D array to visualize
-;
-;    cellsize: (optional) this is the size (in pixel) of the square
-;    representing 1 array element. By default, this size is computed
-;    automatically in order that the size of the plotting window do
-;    not exceed the screen size. If the user specify a large value
-;    of cellsize that forces tvplus to create a window larger than
-;    the screen, a "scrolling window" will be displayed instead of a
-;    regular window. Unfortunately the nice fonctionnalities of tvplus
-;    are not coded for "scrolling window" case...
-;
-; KEYWORD PARAMETERS:
-;
-;       BOTTOM: The lowest color index of the colors to be loaded in
-;       the bar. default is 0.
-;
-;       C_NAN: The color number that should be used for the NaN values.
-;       default value is !d.n_colors < 255
-;
-;       C_MASK: The color number that should be used for the mask values.
-;       default value is 0
-;
-;       OFFSET: 2 elements vector used by tvplus itself when shoing zoom.
-;       It is used to shift the ranges of xaxis and yaxis.
-;       For example: tvplus,sst[x1:x2,y1:y2],offest=[x1,y1]
-;
-;       MASK: The mask value. Note that if abs(mask) < 1.e6, then the
-;       exact value of the mask is used to find the maskwd point.
-;       if abs(mask) > 1.e6, the test to find the masked value is ge
-;       abs(mask)/10. This is necessary to avoid the rounding errors
-;
-;       MIN and MAX: scalars used to specify the min and max values
-;       of the color bar. default is from 0 to !d.n_colors < 255
-;
-;       NCOLORS:  This is the number of colors in the color
-;       bar. default is !d.n_colors<255 -1
-;
-;       NOINTERP: used this keyword if you don't whant that the values
-;       are interpolated between 0 (or min) and !d.n_colors < 255 (or max).
-;       This can be for example usefull when working on byte type arrays.
-;
-;       NOUSEINFOS: activite to supress the printed message explaining
-;       how to use tvplus
-;
-;       WINDOW: Number of the window used to display the array values.
-;       default is window number 0.
-;
-; OUTPUTS: no (except the printed finformations, see below)
-;
-; COMMON BLOCKS: no
-;
-; SIDE EFFECTS:
-;
+; @param Z2D {in}{required}
+; 2D array to visualize
+;
+; @param CELLSIZE {in}{optiona}
+; This is the size (in pixel) of the square
+; representing 1 array element. By default, this size is computed
+; automatically in order that the size of the plotting window do
+; not exceed the screen size. If the user specify a large value
+; of cellsize that forces tvplus to create a window larger than
+; the screen, a "scrolling window" will be displayed instead of a
+; regular window. Unfortunately the nice fonctionnalities of tvplus
+; are not coded for "scrolling window" case...
+;
+; @keyword BOTTOM
+; The lowest color index of the colors to be loaded in
+; the bar. default is 0.
+;
+; @keyword C_NAN
+; The color number that should be used for the NaN values.
+; default value is !d.n_colors < 255
+;
+; @keyword C_MASK
+; The color number that should be used for the mask values.
+; default value is 0
+;
+; @keyword OFFSET 
+; 2 elements vector used by tvplus itself when shoing zoom.
+; It is used to shift the ranges of xaxis and yaxis.
+; For example: tvplus,sst[x1:x2,y1:y2],offest=[x1,y1]
+;
+; @keyword MASK 
+; The mask value. Note that if abs(mask) < 1.e6, then the
+; exact value of the mask is used to find the maskwd point.
+; if abs(mask) > 1.e6, the test to find the masked value is ge
+; abs(mask)/10. This is necessary to avoid the rounding errors
+;
+; @keyword MIN 
+; Scalar used to specify the min value of the color bar. default is 0
+;
+; @keyword MAX
+; Scalar used to specify the max value of the color bar. default is !d.n_colors < 255
+;
+; @keyword NCOLORS
+; This is the number of colors in the color bar. default is !d.n_colors<255 -1
+;
+; @keyword NOINTERP
+; Used this keyword if you don't whant that the values
+; are interpolated between 0 (or min) and !d.n_colors < 255 (or max).
+; This can be for example usefull when working on byte type arrays.
+;
+; @keyword NOUSEINFOS
+; Activite to supress the printed message explaining how to use tvplus
+;
+; @keyword WINDOW
+; Number of the window used to display the array values.
+; default is window number 0.
+;
+; @restrictions 
 ; use your mouse to scan the array values...
 ;     left button  : mouse position and associated array value
@@ -71 +74 @@
 ;     right button : quit
 ;
-; RESTRICTIONS: the nice fonctionnalities of tvplus are not coded
-;               for "scrolling window" case...
-;
-; EXAMPLE:  IDL> tvplus, dist(100)
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; the nice fonctionnalities of tvplus are not coded
+; for "scrolling window" case...
+;
+; @examples
+; IDL> tvplus, dist(100)
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       18/12/98
 ; Aug 2005: quick cleaning + english
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -246 +255 @@
       device, decomposed = 0
     endif
-    slide_image, arr $          ; on le dessine ds une fenetre avec une scrolling bar
+    slide_image, arr $          ; We draw it in a window with a scrolling bar
                  , xsize = nx, ysize = ny $
                  , xvisible = round(.7*dimensions[0]) < (size(arr))[1] $