Ignore:
Timestamp:
08/29/06 14:59:46 (18 years ago)
Author:
navarro
Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

Location:
trunk/SRC/ToBeReviewed/PLOTS/DESSINE
Files:
12 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/bar_plot.pro

    r142 r163  
    77; Graphics 
    88; 
    9 ; @param Values {in}{required}  
     9; @param Values {in}{required} {type=vector} 
    1010; A vector containing the values to be represented by the bars. 
    1111; Each element in VALUES corresponds to a single bar in the 
    1212; output. 
    1313; 
    14 ; @keyword BASELINES  
     14; @keyword BASELINES {type=vector} 
    1515; A vector, the same size as VALUES, that contains the 
    1616; base value associated with each bar.  If not specified, 
    1717; a base value of zero is used for all bars. 
    1818; 
    19 ; @keyword COLORS  
     19; @keyword COLORS {type=vector} 
    2020; A vector, the same size as VALUES, containing the color index 
    2121; to be used for each bar.  If not specified, the colors are 
    22 ; selected based on spacing the color indices as widely as 
     22; selected based on spacing the color indexes as widely as 
    2323; possible within the available colors (specified by D.N_COLORS). 
    2424; 
    25 ; @keyword BARNAMES  
     25; @keyword BARNAMES {type=string} 
    2626; A string array, containing one string label per bar. 
    2727; If the bars are vertical, the labels are placed beneath 
    … …  
    2929; are placed to the left of the bars. 
    3030; 
    31 ; @keyword TITLE  
     31; @keyword TITLE {type=string} 
    3232; A string containing the main title to for the bar plot. 
    3333; 
    34 ; @keyword XTITLE  
     34; @keyword XTITLE {type=string} 
    3535; A string containing the title for the X axis. 
    3636; 
    37 ; @keyword YTITLE  
     37; @keyword YTITLE {type=string} 
    3838; A string containing the title for the Y axis. 
    3939; 
    40 ; @keyword BASERANGE  
     40; @keyword BASERANGE {type=float} 
    4141; A floating-point scalar in the range 0.0 to 1.0, that 
    4242; determines the fraction of the total available plotting area 
    … …  
    4444; If not specified, the full available area is used. 
    4545; 
    46 ; @keyword BARWIDTH  
     46; @keyword BARWIDTH {type=float} 
    4747; A floating-point value that specifies the width of the bars 
    4848; in units of "nominal bar width".  The nominal bar width is 
    … …  
    5252; keyword). 
    5353; 
    54 ; @keyword BARSPACE  
     54; @keyword BARSPACE {type=scalar} 
    5555; A scalar that specifies, in units of "nominal bar width", 
    5656; the spacing between bars.  For example, if BARSPACE is 1.0, 
    … …  
    5959; width. 
    6060; 
    61 ; @keyword BAROFFSET  
     61; @keyword BAROFFSET {default=BARSPACE}{type=scalar} 
    6262; A scalar that specifies the offset to be applied to the 
    6363; first bar, in units of "nominal bar width".  This keyword 
    6464; allows, for example, different groups of bars to be overplotted 
    65 ; on the same graph.  If not specified, the default offset is 
    66 ; equal to BARSPACE. 
     65; on the same graph. 
    6766; 
    6867; @keyword OUTLINE  
    … …  
    7473; overplotted on an existing graph. 
    7574; 
    76 ; @keyword BACKGROUND  
     75; @keyword BACKGROUND {default=The normal IDL background color is used}{type=scalar} 
    7776; A scalar that specifies the color index to be used for 
    78 ; the background color.  By default, the normal IDL background 
    79 ; color is used. 
     77; the background color. 
    8078; 
    8179; @keyword ROTATE  

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

    r157 r163  
    2929;         Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3) 
    3030; 
    31 ; @keyword BOXZOOM  
     31; @keyword BOXZOOM {type=vector} 
    3232; Vector indicating the geographic zone on which we want to cut the map.  
    3333;  If BOXZOOM has : 
    … …  
    4242; @keyword REALCONT  
    4343; Allow to draw continents defined in IDL. REALCONT can have 2 form: 
    44 ;           /REALCONT: we draww continents in place of the mask 
    45 ;           REALCONT=2 we draw cnotinents's contour over the mask (this allows  
     44;           /REALCONT: we draw continents in place of the mask 
     45;           REALCONT=2 we draw continent's contour over the mask (this allows  
    4646;                      to see if the mask correspond at real continents). 
    4747; 
    … …  
    5353; If this keyword is not specified, we trace 20 isolines from the min to the max.  
    5454; 
    55 ; @keyword CONTLABEL  
    56 ; It is an integer n. When CONTOUR is actvated, if n 
     55; @keyword CONTLABEL {type=integer} 
     56; It is an integer n. When CONTOUR is activated, if n 
    5757; is different of 0, choose the label type corresponding to n cases for  
    5858; the traced by a traitisolines. To specify the type of label of the  
    5959; colored contour, use LABEL 
    6060; 
    61 ; @keyword CONTMAX  
     61; @keyword CONTMAX {default=The max of the array passed in the keyword CONTOUR (on ocean points)} 
    6262; When CONTOUR is activated, max value we want to consider in the isoline  
    63 ; traced by a trait's line. By default, we take the max (on ocean points) of the array  
    64 ; passed in the keyword CONTOUR.  
    65 ; 
    66 ; @keyword CONTMIN  
     63; traced by a trait's line 
     64; 
     65; @keyword CONTMIN {default=The min of the array passed in the keyword CONTOUR (on ocean points)} 
    6766; When CONTOUR is activated, min value we want to consider in the isoline  
    68 ; traced by a trait's line. By default, we take the min (on ocean points) of the array  
    69 ; passed in the keyword CONTOUR.  
    70 ; 
    71 ; @keyword CONTNLEVEL  
    72 ; When  CONTOUR is activated, it is the numbre of contours 
     67; traced by a trait's line. 
     68; 
     69; @keyword CONTNLEVEL {default=20} 
     70; When  CONTOUR is activated, it is the number of contours 
    7371; traced by a trait for drawing (active if 
    74 ; CONTLABEL=0) by default=20. 
     72; CONTLABEL=0) 
    7573; 
    7674; @keyword CONTOUR  
    7775; If we want to trace contours of a different field than the one  
    78 ; whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    79 ; It must be a field respecting same caracteristics than the argument number one of plt. 
    80 ; 
    81 ; @keyword GRIDTYPE 'U','T','V','W' or 'F' to specify possibly the grid on wiche the field is joined. 
     76; whose we have the colored drawing (by example E-P in color and QSR in contours).  
     77; It must be a field respecting same characteristics than the argument number one of plt. 
     78; 
     79; @keyword GRIDTYPE 'U','T','V','W' or 'F' to specify possibly the grid on which the field is joined. 
    8280; Comment: In this case, we should use a structure like field. 
    8381; 
    … …  
    9391;               (without use the black, the white and the used palette) 
    9492;  
    95 ; @keyword LABEL  
     93; @keyword LABEL {type=integer} 
    9694; It is an integer n. If n different of 0, it choose the label's type  
    9795; corresponding to cases n. cf label.pro 
    9896; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.  
    99 ; For tese one traced by a trait, use CONTLABEL. 
     97; For these one traced by a trait, use CONTLABEL. 
    10098;        
    101 ; @keyword MAP  
     99; @keyword MAP {default=Cylindrical projection} 
    102100; We use it when we want to do a projection. 
    103101; This keyword can be of two types: 
    104 ;     MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET). 
    105 ;     /MAP: In this case, map is automatically caculated have the value:  
     102;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET). 
     103;     /MAP: In this case, map is automatically calculated have the value:  
    106104;          map = [0, (lon1+lon2)/2., 0] 
    107105; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    108106; IDL> demo 
    109107; Then choose earth sciences and  mapping. 
    110 ; Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map).  
     108; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).  
    111109; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
    112110; For example, for a polar projection centered on the south pole: 
    … …  
    114112; IDL> plt, tab, /stereo,map=[-90,0,0] 
    115113; 
    116 ; @keyword LABMAP  
    117 ; Corresponds to label keywords of map_set. Defaut 
    118 ;       definition is labmap=1 
    119 ; 
     114; @keyword LABMAP {default=labmap=1} 
     115; Corresponds to label keywords of map_set. 
    120116; 
    121117; @keyword MAXIN  
    … …  
    129125; keyword is retained. 
    130126; 
    131 ; @keyword NLEVEL  
     127; @keyword NLEVEL {default=20} 
    132128; Number of contour to draw by default =20. active if 
    133129; LABEL=0 or is not specified. 
    … …  
    136132; To force not to use the triangulation. Beware, in this case, the  
    137133; drawing only works if the grid is undeformed (It means that each point of a longitude  
    138 ; give one latitude and each point of a latitude give one longitude) exept if we use  
     134; give one latitude and each point of a latitude give one longitude) except if we use  
    139135; the keyword CELL_FILL=2.  
    140136; Comment: if the field contain points !values.f_nan, then we even do a triangulation. 
    … …  
    150146; specified min and values superior at the specified max in white. 
    151147; 
    152 ; @keyword STYLE  
    153 ; Contour's style to adopt to draw isolines(by default, style=0. see style.pro) 
    154 ; 
    155 ; @keyword VECTEUR 
     148; @keyword STYLE {default=style=0} 
     149; Contour's style to adopt to draw isolines. 
     150; 
     151; @keyword VECTEUR {type=struct} 
    156152; It is a structure composed by 2 elements containing the 2 fields U 
    157153; and V of values of the zonal and meridian component of the vector of the fields 
    158154; to draw. These fields can be an array or a structure. 
    159155;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
    160 ;       Comment: name of elements of vectors are inconsenquential. 
     156;       Comment: name of elements of vectors are inconsequential. 
    161157;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated. 
    162158; 

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

    r157 r163  
    33; 
    44; @file_comments 
    5 ; Trace 1d graphes: x,y,z (or t but in this case, we recall directly pltt) 
     5; Trace 1d graphs: x,y,z (or t but in this case, we recall directly pltt) 
    66; 
    77; @categories 
    … …  
    1212;       1) An array which can be: 
    1313;          * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array will pass  
    14 ;          in moyenne or grossemoyenne to be averaged and becomme  an array 1d.  
     14;          in moyenne or grossemoyenne to be averaged and become  an array 1d.  
    1515;          * 1d:Nevertheless, the type must be specified in order to we know which trace  
    16 ;          it is about. To have a correct caption, respecify the  xctraction zone via BOXZOOM. 
     16;          it is about. To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    1717;       2) a structure respecting all criterions specified by litchamp.pro.  
    1818;          See IDL> xhelp,'litchamp'. The array contained in the structure  
    … …  
    3232; 
    3333; @keyword BOXZOOM 
    34 ; Vector indicating the geographique zone (3d) on which the extraction of the field must  
     34; Vector indicating the geographic zone (3d) on which the extraction of the field must  
    3535; be done to do the hovmoeller. 
    3636;  If BOXZOOM has : 
    … …  
    4848; 
    4949; @keyword ENDPOINTS  
    50 ; keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    51 ; of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     50; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     51; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    5252; coordinates. 
    5353; 
    … …  
    8484; allows to specify the type of hovmoller we want to do 
    8585;             'xt','yt','zt','t'   
    86 ; with help of a keyword rather than the argument type. If the argument andthe  
     86; with help of a keyword rather than the argument type. If the argument and the  
    8787; keyword are specified in the same time, it is the value specified by the  
    8888; keyword which is retained. 

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

    r157 r163  
    2020; Axis. Vector or array of the same size that z2d. This is the coordinate of z2d on y. 
    2121; 
    22 ; @param MASK {in}{required} 
     22; @param MASK {in}{required}{type=array} 
    2323; It is the array who mask z2d (with 0s on points we want to mask and 1s on others).  
    2424; If z2d is not masked, put this argument equal to 1. 
    … …  
    3232; This is the coordinate of mask on y. 
    3333; 
    34 ; @param LEVELS {in}{optional} 
     34; @param LEVELS {in}{optional}{type=vector} 
    3535; Vectors which contain levels needed at the contour.  
    3636; If it is not given, we take 20 levels between the min and the max. 
    3737;   
    38 ; @param COLORS {in}{optional} 
     38; @param COLORS {in}{optional}{type=vector} 
    3939; Vectors which contain colors needed at the contour.  
    4040; If it is not given, we take 20 levels between the min and the max. 
    … …  
    5050; with filling in color  
    5151; 
    52 ; @keyword /CONT_NOFILL  
     52; @keyword CONT_NOFILL  
    5353; Activate it not to fill the point mask to let them transparent!  
    5454; Comment: Nevertheless, we trace mask's contour. 
    5555; 
    56 ; @keyword CONT_COLOR  
    57 ; The color of the continent. defaut value is 
    58 ;        (!d.n_colors - 1) < 255 => white 
    59 ; 
    60 ; @keyword /DESSTRICHAMP  
     56; @keyword CONT_COLOR {default= (!d.n_colors - 1) < 255 =>white} 
     57; The color of the continent. 
     58; 
     59; @keyword DESSTRICHAMP  
    6160; To draw the triangulation which is used to make field's contours.  
    6261; 
    63 ; @keyword /DESSTRIMASK  
     62; @keyword DESSTRIMASK  
    6463; To draw the triangulation which is used to make mask's contours. 
    6564;  
    66 ; @keyword /FORPLT  
     65; @keyword FORPLT  
    6766; To activate if we want that the drawing of coast be realized by tracecote rather than tracemask. 
    6867; 
    69 ; @keyword I_COLORS  
    70 ; It is a vector specifing the colors to use to trace contours.  
     68; @keyword I_COLORS {type=vector} 
     69; It is a vector specifying the colors to use to trace contours.  
    7170; It is the same thing that c_colors which act on contours. 
    7271; 
    73 ; @keyword MORE  
     72; @keyword MORE {default=10} 
    7473; Number to give to avoid style's bugs: 
    7574;  % Out of range subscript encountered: <LONG      Array[38911]>. 
    7675;  % Execution halted at:  PLTBASE           151 
    77 ;             By default more=10 If the bug still exist, increase the value of more!  
     76;             If the bug still exist, increase the value of more!  
    7877; (The explanation and the justification of this method do not have scientific bases yet...). 
    7978; 
    80 ; @keyword /NOFILL 
     79; @keyword NOFILL 
    8180; To make just isolines. 
    8281; 
    83 ; @keyword /NOCONTOUR 
     82; @keyword NOCONTOUR 
    8483; To make just colors. 
    8584; 
    86 ; @keyword /UNSUR2 To trace one isoline on two. 
    87 ; 
    88 ; @keyword UNLABSUR  
    89 ; Is an integer n. specifying we only label one contour on two 
     85; @keyword UNSUR2 
     86; To trace one isoline on two. 
     87; 
     88; @keyword UNLABSUR {type=integer} 
     89; I specify we only label one contour on two. 
    9090; 
    9191; @keyword CONTOUR  

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

    r142 r163  
    11;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param TAB1 
     9; 
     10; 
     11; @param TAB2 
     12; 
     13; 
     14; @param MIN1 
     15; 
     16; 
     17; @param MAX1 
     18; 
     19; 
     20; @param MIN2 
     21; 
     22; 
     23; @param MAX2 
     24; 
     25; 
     26; @param VARNAME2 
     27; 
     28; 
     29; @keyword BOXZOOM 
     30; Vector indicating the geographic zone on which we want to cut the map.  
     31;  If BOXZOOM has : 
     32; 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 
     33; 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] 
     34; 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])] 
     35; 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
     36; 6 elements: The extraction is made on Boxzoom 
     37; 
     38; @keyword COL1D 
     39; 
     40; 
     41; @keyword STY1D 
     42; 
     43; 
     44; @keyword OV1D 
     45; 
     46; 
     47; @keyword _EXTRA 
     48; Used to pass your keywords 
     49; 
     50; @returns 
     51; 
     52; 
     53; @uses 
     54; 
     55; 
     56; @restrictions 
     57; 
     58; 
     59; @examples 
     60; 
     61; 
     62; @history 
     63; 
     64; 
     65; @version 
     66; $Id$ 
    267; 
    368; @todo seb 
    469; 
    570;- 
     71; 
    672PRO  pltsc,tab1,tab2, min1, max1, min2, max2, varname2, BOXZOOM = boxzoom, $ 
    773           COL1D=col1d,STY1D=sty1d,OV1D=ov1d, _extra = ex 
    8 ; 
    974; scatter plot (inspired from plt1d) 
    1075; 

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

    r157 r163  
    1515;            be masked at the value valmask) and nevertheless,type must be specified  
    1616;            to we know of which trace it is about. 
    17 ;            To have a correct caption, respecify the  xctraction zone via BOXZOOM. 
     17;            To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    1818;          * 1d: only for traces of the 't' type. Nevertheless, type must be specified  
    1919;            to we know of which trace it is about. 
    20 ;            To have a correct caption, respecify the  xctraction zone via BOXZOOM. 
     20;            To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    2121;       2) a structure respecting all criterions specified by litchamp.pro.  
    2222;          See IDL> xhelp,'litchamp'. The array contained in the structure  
    … …  
    3838; 
    3939; @keyword BOXZOOM 
    40 ; Vector indicating the geographique zone (3d) on which the extraction of the field must  
     40; Vector indicating the geographic zone (3d) on which the extraction of the field must  
    4141; be done to do the hovmoeller. 
    4242;  If BOXZOOM has : 
    … …  
    5656; If this keyword is not specified, we trace 20 isolines from the min to the max.  
    5757; 
    58 ; @keyword CONTLABEL  
    59 ; It is an integer n. When CONTOUR is actvated, if n 
     58; @keyword CONTLABEL {type=integer} 
     59; When CONTOUR is activated, if n 
    6060; is different of 0, choose the label type corresponding to n cases for  
    6161; the traced by a traitisolines. To specify the type of label of the  
    6262; colored contour, use LABEL 
    6363; 
    64 ; @keyword CONTMAX  
     64; @keyword CONTMAX {default=we take the max of the array passed in the keyword CONTOUR (on ocean points)} 
    6565; When CONTOUR is activated, max value we want to consider in the isoline  
    66 ; traced by a trait's line. By default, we take the max (on ocean points) of the array  
    67 ; passed in the keyword CONTOUR.  
    68 ; 
    69 ; @keyword CONTMIN  
     66; traced by a trait's line.  
     67; 
     68; @keyword CONTMIN {default=we take the min of the array passed in the keyword CONTOUR (on ocean points)} 
    7069; When CONTOUR is activated, min value we want to consider in the isoline  
    71 ; traced by a trait's line. By default, we take the min (on ocean points) of the array  
    72 ; passed in the keyword CONTOUR.  
    73 ; 
    74 ; @keyword CONTNLEVEL  
    75 ; When  CONTOUR is activated, it is the numbre of contours 
     70; traced by a trait's line.  
     71; 
     72; @keyword CONTNLEVEL {default=20} 
     73; When  CONTOUR is activated, it is the number of contours 
    7674; traced by a trait for drawing (active if 
    77 ; CONTLABEL=0) by default=20. 
     75; CONTLABEL=0). 
    7876; 
    7977; @keyword CONTOUR  
    8078; If we want to trace contours of a different field than the one  
    81 ; whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    82 ; It must be a field respecting same caracteristics than the argument number one of pltt. 
     79; whose we have the colored drawing (by example E-P in color and QSR in contours).  
     80; It must be a field respecting same characteristics than the argument number one of pltt. 
    8381; 
    8482; @keyword ENDPOINTS  
    85 ; keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    86 ; of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     83; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     84; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    8785; coordinates.  
    8886; 
    … …  
    104102;               (without use the black, the white and the used palette) 
    105103;  
    106 ; @keyword LABEL  
    107 ; It is an integer n. If n different of 0, it choose the label's type  
     104; @keyword LABEL {type=integer} 
     105; If n different of 0, it choose the label's type  
    108106; corresponding to cases n. cf label.pro 
    109107; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.  
    110 ; For tese one traced by a trait, use CONTLABEL.  
     108; For these one traced by a trait, use CONTLABEL.  
    111109; 
    112110; @keyword COL1d 
    … …  
    124122; keyword is retained. 
    125123; 
    126 ; @keyword NLEVEL  
     124; @keyword NLEVEL {default=20} 
    127125; Number of contour to draw by default =20. active if 
    128126; LABEL=0 or is not specified. 
    129127; 
    130 ; @keyword CONTNLEVEL  
    131 ; When  CONTOUR is activated, it is the numbre of contours 
     128; @keyword CONTNLEVEL {default=20} 
     129; When  CONTOUR is activated, it is the number of contours 
    132130; traced by a trait for drawing (active if 
    133 ; CONTLABEL=0) by default=20. 
     131; CONTLABEL=0). 
    134132; 
    135133; @keyword OV1D  
    … …  
    146144; specified min and values superior at the specified max in white. 
    147145; 
    148 ; @keyword STYLE  
    149 ; Contour's style to adopt to draw isolines(by default, style=0. see style.pro) 
     146; @keyword STYLE {default=style=0} 
     147; Contour's style to adopt to draw isolines 
    150148; 
    151149; @keyword STY1D  
    … …  
    161159; allows to specify the type of hovmoller we want to do 
    162160;             'xt','yt','zt','t'   
    163 ; with help of a keyword rather than the argument type. If the argument andthe  
     161; with help of a keyword rather than the argument type. If the argument and the  
    164162; keyword are specified in the same time, it is the value specified by the  
    165163; keyword which is retained. 
     164; 
     165; @keyword _EXTRA 
     166; Used to pass your keywords 
    166167; 
    167168; @uses 

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

    r159 r163  
    4949; 
    5050; @keyword NOINTERP 
    51 ; Used this keyword if you don't whant that the values 
     51; Used this keyword if you don't want that the values 
    5252; are interpolated from BOTTOM using NCOLORS colors. 
    53 ; This can be for example usefull when working on byte type arrays. 
     53; This can be for example useful when working on byte type arrays. 
    5454; 
    5555; @keyword _EXTRA 

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

    r157 r163  
    1616;         If the field is 3d, we extract the section on we average possibly before to do the plot. 
    1717;         2)  a structure respecting all criterions specified by litchamp.pro.  
    18 ;          See IDL> xhelp,'litchamp'. The array contin in the structure must be 2 or 3d (See case 1) 
     18;          See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1) 
    1919; 
    2020; ces arguments ne sont pas obligatoires: 
    … …  
    4444; If this keyword is not specified, we trace 20 isolines from the min to the max.  
    4545; 
    46 ; @keyword CONTLABEL  
    47 ; It is an integer n. When CONTOUR is actvated, if n 
     46; @keyword CONTLABEL {type=integer} 
     47; When CONTOUR is activated, if n 
    4848; is different of 0, choose the label type corresponding to n cases for  
    4949; the traced by a traitisolines. To specify the type of label of the  
    5050; colored contour, use LABEL 
    5151; 
    52 ; @keyword CONTMAX  
     52; @keyword CONTMAX {default=max of the keyword CONTOUR (on ocean points)} 
    5353; When CONTOUR is activated, max value we want to consider in the isoline  
    54 ; traced by a trait's line. By default, we take the max (on ocean points) of the array  
    55 ; passed in the keyword CONTOUR. 
    56 ; 
    57 ; @keyword CONTMIN  
     54; traced by a trait's line. 
     55; 
     56; @keyword CONTMIN {default=min of the keyword CONTOUR (on ocean points)} 
    5857; When CONTOUR is activated, min value we want to consider in the isoline  
    59 ; traced by a trait's line. By default, we take the min (on ocean points) of the array  
    60 ; passed in the keyword CONTOUR.  
    61 ; 
    62 ; @keyword CONTNLEVEL  
    63 ; When  CONTOUR is activated, it is the numbre of contours 
     58; traced by a trait's line.  
     59; 
     60; @keyword CONTNLEVEL {default=20} 
     61; When  CONTOUR is activated, it is the number of contours 
    6462; traced by a trait for drawing (active if 
    65 ; CONTLABEL=0) by default=20. 
     63; CONTLABEL=0). 
    6664; 
    6765; @keyword CONTOUR  
    6866; If we want to trace contours of a different field than the one  
    69 ; whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    70 ; It must be a field respecting same caracteristics than the argument number one of plt. 
     67; whose we have the colored drawing (by example E-P in color and QSR in contours).  
     68; It must be a field respecting same characteristics than the argument number one of plt. 
    7169; 
    7270; @keyword ENDPOINTS  
    73 ; keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    74 ; of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     71; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     72; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    7573; coordinates.  
    7674; 
    … …  
    8684;               (without use the black, the white and the used palette) 
    8785; 
    88 ; @keyword ZRATIO 
     86; @keyword ZRATIO {default=2./3} 
    8987; When the drawing has a zoomed part, it is the size rapport between the zoomed part,  
    90 ; hz (zoom height), and the whole drawing, ht (total height). By default =2./3 
    91 ; 
    92 ; @keyword LABEL  
    93 ; It is an integer n. If n different of 0, it choose the label's type  
    94 ; corresponding to cases n. cf label.pro 
     88; hz (zoom height), and the whole drawing, ht (total height). 
     89; 
     90; @keyword LABEL {default=0}{type=integer} 
     91; It choose the label's type corresponding to cases in label.pro. 
    9592; Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.  
    96 ; For tese one traced by a trait, use CONTLABEL.  
     93; For these one traced by a trait, use CONTLABEL.  
    9794; 
    9895; @keyword MAXIN  
    … …  
    106103; keyword is retained. 
    107104; 
    108 ; @keyword NLEVEL  
     105; @keyword NLEVEL {default=20} 
    109106; Number of contour to draw by default =20. active if 
    110107; LABEL=0 or is not specified. 
    … …  
    113110; To force not to use the triangulation. Beware, in this case, the  
    114111; drawing only works if the grid is undeformed (It means that each point of a longitude  
    115 ; give one latitude and each point of a latitude give one longitude) exept if we use  
     112; give one latitude and each point of a latitude give one longitude) except if we use  
    116113; the keyword CELL_FILL=2.  
    117114; Comment: if the field contain points !values.f_nan, then we even do a triangulation. 
    … …  
    131128; specified min and values superior at the specified max in white. 
    132129; 
    133 ; @keyword STYLE  
    134 ; Contour's style to adopt to draw isolines(by default, style=0. see style.pro) 
     130; @keyword STYLE {default=style=0} 
     131; Contour's style to adopt to draw isolines 
    135132; 
    136133; @keyword WDEPTH  
    … …  
    144141; Force to make a cut following yz 
    145142; 
    146 ; @keyword ZOOM  
    147 ; Depth where i can make our maximum zoom. By default 200m or max depth if it is inferior at 200m 
     143; @keyword ZOOM  {default=200m or max depth if it is inferior at 200m} 
     144; Depth where i can make our maximum zoom. 
    148145; 
    149146; @uses 

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

    r157 r163  
    55; 
    66; @file_comments  
    7 ; Same thing that bar_plot but compatible with the whole environnement (common.pro inclued) 
     7; Same thing that bar_plot but compatible with the whole environment (common.pro included) 
    88; 
    99; @categories Graphics 
    1010; 
    11 ; @keyword COLORS  
     11; @keyword COLORS {type=vector} 
    1212; A vector, the same size as VALUES, containing the color index 
    1313; to be used for each bar.  If not specified, the colors are 
    … …  
    1515; possible within the available colors (specified by D.N_COLORS). 
    1616; 
    17 ; @keyword COLORS  
    18 ; Is an integer giving color of all colorbars. (contrarily to colors  
     17; @keyword COLORS {type=integer} 
     18; I gives color of all colorbars. (contrarily to colors  
    1919; which is a vector giving the color of each colorbar). 
    2020; 
    2121; @keyword NOREINITPLT 
    22 ; We active it if we do not want environnement variables !p, !x, !y, !z  
    23 ; to be reinitilalizted by the procedure reinitplt 
     22; We active it if we do not want environment variables !p, !x, !y, !z  
     23; to be reinitializated by the procedure reinitplt 
    2424; 
    2525; @keyword _EXTRA 
    … …  
    3030; 
    3131; @restrictions  
    32 ; If NOREINITPLT is not activated, all environnement  
    33 ; variables !p, !x, !y, !z are reinitializtedby the procedure reinitplt 
     32; If NOREINITPLT is not activated, all environment  
     33; variables !p, !x, !y, !z are reinitializted by the procedure reinitplt 
    3434; 
    3535; @examples 

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

    r157 r163  
    55; 
    66; @File_comments 
    7 ; Same thing that contour but compatible with the whole environnement (common.pro inclued) 
     7; Same thing that contour but compatible with the whole environment (common.pro included) 
    88; 
    99; @categories  
    … …  
    1111; 
    1212; @keyword NOREINITPLT 
    13 ; We active it if we do not want environnement variables !p, !x, !y, !z  
    14 ; to be reinitilalizted by the procedure reinitplt 
     13; We active it if we do not want environment variables !p, !x, !y, !z  
     14; to be reinitilalizated by the procedure reinitplt 
    1515;  
    1616; @keyword _EXTRA 

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

    r157 r163  
    55; 
    66; file_comments  
    7 ; Same thing that plot but compatible with the whole environnement (common.pro inclued) 
     7; Same thing that plot but compatible with the whole environment (common.pro included) 
    88; 
    99; @categories  
    … …  
    1111; 
    1212; @keyword NOREINITPLT 
    13 ; We active it if we do not want environnement variables !p, !x, !y, !z  
    14 ; to be reinitilalizted by the procedure reinitplt 
     13; We active it if we do not want environment variables !p, !x, !y, !z  
     14; to be reinitilalizated by the procedure reinitplt 
    1515;  
    1616; @keyword _EXTRA 
    … …  
    2121; 
    2222; @restrictions  
    23 ; If NOREINITPLT is not activated, all environnement  
    24 ; variables !p, !x, !y, !z are reinitializtedby the procedure reinitplt 
     23; If NOREINITPLT is not activated, all environment  
     24; variables !p, !x, !y, !z are reinitializted by the procedure reinitplt 
    2525; 
    2626; @examples 

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

    r157 r163  
    1414; 2D array to visualize 
    1515; 
    16 ; @param CELLSIZE {in}{optiona} 
     16; @param CELLSIZE {in}{optional} 
    1717; This is the size (in pixel) of the square 
    1818; representing 1 array element. By default, this size is computed 
    … …  
    2121; of cellsize that forces tvplus to create a window larger than 
    2222; the screen, a "scrolling window" will be displayed instead of a 
    23 ; regular window. Unfortunately the nice fonctionnalities of tvplus 
     23; regular window. Unfortunately the nice functionnalities of tvplus 
    2424; are not coded for "scrolling window" case... 
    2525; 
    … …  
    3434; 
    3535; @keyword OFFSET  
    36 ; 2 elements vector used by tvplus itself when shoing zoom. 
     36; 2 elements vector used by tvplus itself when showing zoom. 
    3737; It is used to shift the ranges of xaxis and yaxis. 
    3838; For example: tvplus,sst[x1:x2,y1:y2],offest=[x1,y1] 
    … …  
    5454; 
    5555; @keyword NOINTERP 
    56 ; Used this keyword if you don't whant that the values 
     56; Used this keyword if you don't want that the values 
    5757; are interpolated from BOTTOM using NCOLORS colors. 
    58 ; This can be for example usefull when working on byte type arrays. 
     58; This can be for example useful when working on byte type arrays. 
    5959; 
    6060; @keyword NOUSEINFOS 
    61 ; Activite to supress the printed message explaining how to use tvplus 
     61; Activate to suppress the printed message explaining how to use tvplus 
    6262; 
    6363; @keyword WINDOW 
    … …  
    7474;     right button : quit 
    7575; 
    76 ; the nice fonctionnalities of tvplus are not coded 
     76; the nice functionnalities of tvplus are not coded 
    7777; for "scrolling window" case... 
    7878; 
Note: See TracChangeset for help on using the changeset viewer.