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)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/plt.html

    r157 r163  
    721721         
    722722          <p class="header"> 
    723             plt<span class="result">, <a href="#_plt_param_tab1">tab1</a>[, <a href="#_plt_param_param2">param2</a>][, <a href="#_plt_param_param3">param3</a>][, <a href="#_plt_param_param4">param4</a>]</span>, <a href="#_plt_keyword_REALCONT">REALCONT</a>=<span class="result">REALCONT</span>, <a href="#_plt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_plt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_plt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_plt_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">GRIDTYPE</span>, <a href="#_plt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_plt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_plt_keyword_LABEL">LABEL</a>=<span class="result">LABEL</span>, <a href="#_plt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">CONTLABEL</span>, <a href="#_plt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_plt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_plt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_plt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_plt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_plt_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_plt_keyword_MAP">MAP</a>=<span class="result">MAP</span>, <a href="#_plt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_plt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_plt_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_plt_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_plt_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_plt_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_plt_keyword_DUPLICATE">DUPLICATE</a>=<span class="result">DUPLICATE</span>, <a href="#_plt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_plt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_plt_keyword_DECIMATETRI">DECIMATETRI</a>=<span class="result">DECIMATETRI</span>, <a href="#_plt_keyword_LABMAP">LABMAP</a>=<span class="result">LABMAP</span>, <a href="#_plt_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     723            plt<span class="result">, <a href="#_plt_param_tab1">tab1</a>[, <a href="#_plt_param_param2">param2</a>][, <a href="#_plt_param_param3">param3</a>][, <a href="#_plt_param_param4">param4</a>]</span>, <a href="#_plt_keyword_REALCONT">REALCONT</a>=<span class="result">REALCONT</span>, <a href="#_plt_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_plt_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_plt_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_plt_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">GRIDTYPE</span>, <a href="#_plt_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">vector</span>, <a href="#_plt_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_plt_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_plt_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_plt_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_plt_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_plt_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_plt_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_plt_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_plt_keyword_VECTEUR">VECTEUR</a>=<span class="result">struct</span>, <a href="#_plt_keyword_MAP">MAP</a>=<span class="result">MAP</span>, <a href="#_plt_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_plt_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_plt_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_plt_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_plt_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_plt_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_plt_keyword_DUPLICATE">DUPLICATE</a>=<span class="result">DUPLICATE</span>, <a href="#_plt_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_plt_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_plt_keyword_DECIMATETRI">DECIMATETRI</a>=<span class="result">DECIMATETRI</span>, <a href="#_plt_keyword_LABMAP">LABMAP</a>=<span class="result">LABMAP</span>, <a href="#_plt_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    724724         
    725725          <div class="comments"> 
    … …  
    819819            <div class="comments">  
    820820 Allow to draw continents defined in IDL. REALCONT can have 2 form: 
    821            /REALCONT: we draww continents in place of the mask 
    822            REALCONT=2 we draw cnotinents's contour over the mask (this allows  
     821           /REALCONT: we draw continents in place of the mask 
     822           REALCONT=2 we draw continent's contour over the mask (this allows  
    823823                      to see if the mask correspond at real continents). 
    824824</div> 
    … …  
    837837            <div class="comments">  
    838838 If we want to trace contours of a different field than the one  
    839  whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    840  It must be a field respecting same caracteristics than the argument number one of plt. 
     839 whose we have the colored drawing (by example E-P in color and QSR in contours).  
     840 It must be a field respecting same characteristics than the argument number one of plt. 
    841841</div> 
    842842             
    … …  
    887887            </h4> 
    888888         
    889             <div class="comments"> 'U','T','V','W' or 'F' to specify possibly the grid on wiche the field is joined. 
     889            <div class="comments"> 'U','T','V','W' or 'F' to specify possibly the grid on which the field is joined. 
    890890 Comment: In this case, we should use a structure like field. 
    891891</div> 
    … …  
    897897               
    898898               
    899                
    900                
    901                
    902             </h4> 
    903          
    904             <div class="comments">  
     899              <span class="attr">type:</span> <span class="value">vector</span> 
     900               
     901               
     902            </h4> 
     903         
     904            <div class="comments"> 
    905905 Vector indicating the geographic zone on which we want to cut the map.  
    906906  If BOXZOOM has : 
    … …  
    939939               
    940940               
    941                
    942                
    943                
    944             </h4> 
    945          
    946             <div class="comments">  
     941              <span class="attr">type:</span> <span class="value">integer</span> 
     942               
     943               
     944            </h4> 
     945         
     946            <div class="comments"> 
    947947 It is an integer n. If n different of 0, it choose the label's type  
    948948 corresponding to cases n. cf label.pro 
    949949 Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.  
    950  For tese one traced by a trait, use CONTLABEL. 
     950 For these one traced by a trait, use CONTLABEL. 
    951951        </div> 
    952952             
    … …  
    957957               
    958958               
    959                
    960                
    961                
    962             </h4> 
    963          
    964             <div class="comments">  
    965  It is an integer n. When CONTOUR is actvated, if n 
     959              <span class="attr">type:</span> <span class="value">integer</span> 
     960               
     961               
     962            </h4> 
     963         
     964            <div class="comments"> 
     965 It is an integer n. When CONTOUR is activated, if n 
    966966 is different of 0, choose the label type corresponding to n cases for  
    967967 the traced by a traitisolines. To specify the type of label of the  
    … …  
    976976               
    977977               
    978                
    979                
    980             </h4> 
    981          
    982             <div class="comments">  
    983  Contour's style to adopt to draw isolines(by default, style=0. see style.pro) 
     978              <span class="attr">default:</span> <span class="value">style</span> 
     979               
     980            </h4> 
     981         
     982            <div class="comments"> 
     983 Contour's style to adopt to draw isolines. 
    984984</div> 
    985985             
    … …  
    991991               
    992992               
    993                
    994                
    995             </h4> 
    996          
    997             <div class="comments">  
     993              <span class="attr">default:</span> <span class="value">The max of the array passed in the keyword CONTOUR (on ocean points)</span> 
     994               
     995            </h4> 
     996         
     997            <div class="comments"> 
    998998 When CONTOUR is activated, max value we want to consider in the isoline  
    999  traced by a trait's line. By default, we take the max (on ocean points) of the array  
    1000  passed in the keyword CONTOUR.  
     999 traced by a trait's line 
    10011000</div> 
    10021001             
    … …  
    10081007               
    10091008               
    1010                
    1011                
    1012             </h4> 
    1013          
    1014             <div class="comments">  
     1009              <span class="attr">default:</span> <span class="value">The min of the array passed in the keyword CONTOUR (on ocean points)</span> 
     1010               
     1011            </h4> 
     1012         
     1013            <div class="comments"> 
    10151014 When CONTOUR is activated, min value we want to consider in the isoline  
    1016  traced by a trait's line. By default, we take the min (on ocean points) of the array  
    1017  passed in the keyword CONTOUR.  
     1015 traced by a trait's line. 
    10181016</div> 
    10191017             
    … …  
    10251023               
    10261024               
    1027                
    1028                
    1029             </h4> 
    1030          
    1031             <div class="comments">  
     1025              <span class="attr">default:</span> <span class="value">20</span> 
     1026               
     1027            </h4> 
     1028         
     1029            <div class="comments"> 
    10321030 Number of contour to draw by default =20. active if 
    10331031 LABEL=0 or is not specified. 
    … …  
    10411039               
    10421040               
    1043                
    1044                
    1045             </h4> 
    1046          
    1047             <div class="comments">  
    1048  When  CONTOUR is activated, it is the numbre of contours 
     1041              <span class="attr">default:</span> <span class="value">20</span> 
     1042               
     1043            </h4> 
     1044         
     1045            <div class="comments"> 
     1046 When  CONTOUR is activated, it is the number of contours 
    10491047 traced by a trait for drawing (active if 
    1050  CONTLABEL=0) by default=20. 
     1048 CONTLABEL=0) 
    10511049</div> 
    10521050             
    … …  
    10571055               
    10581056               
    1059                
     1057              <span class="attr">type:</span> <span class="value">struct</span> 
    10601058               
    10611059               
    … …  
    10721070               
    10731071               
    1074                
    1075                
    1076             </h4> 
    1077          
    1078             <div class="comments">  
     1072              <span class="attr">default:</span> <span class="value">Cylindrical projection</span> 
     1073               
     1074            </h4> 
     1075         
     1076            <div class="comments"> 
    10791077 We use it when we want to do a projection. 
    10801078 This keyword can be of two types: 
    1081      MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET). 
    1082      /MAP: In this case, map is automatically caculated have the value:  
     1079     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET). 
     1080     /MAP: In this case, map is automatically calculated have the value:  
    10831081          map = [0, (lon1+lon2)/2., 0] 
    10841082 Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    10851083 IDL> demo 
    10861084 Then choose earth sciences and  mapping. 
    1087  Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map).  
     1085 Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).  
    10881086 If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
    10891087 For example, for a polar projection centered on the south pole: 
    … …  
    11711169 To force not to use the triangulation. Beware, in this case, the  
    11721170 drawing only works if the grid is undeformed (It means that each point of a longitude  
    1173  give one latitude and each point of a latitude give one longitude) exept if we use  
     1171 give one latitude and each point of a latitude give one longitude) except if we use  
    11741172 the keyword CELL_FILL=2.  
    11751173 Comment: if the field contain points !values.f_nan, then we even do a triangulation. 
    … …  
    12591257               
    12601258               
    1261                
    1262                
    1263             </h4> 
    1264          
    1265             <div class="comments">  
    1266  Corresponds to label keywords of map_set. Defaut 
    1267        definition is labmap=1 
    1268  
     1259              <span class="attr">default:</span> <span class="value">labmap</span> 
     1260               
     1261            </h4> 
     1262         
     1263            <div class="comments"> 
     1264 Corresponds to label keywords of map_set. 
    12691265</div> 
    12701266             
    … …  
    12901286           
    12911287          <h4>Version</h4><div class="preformat"> 
    1292  $Id: plt.pro 152 2006-08-10 07:01:35Z smasson $ 
     1288 $Id: plt.pro 157 2006-08-21 09:01:50Z navarro $ 
    12931289 </div> 
    12941290          <h4>History</h4><div class="preformat">  
    … …  
    13181314           
    13191315         
     1316          <h3>Statistics</h3> 
     1317          <table class="statistics"> 
     1318            <tr><td>McCabe cyclic</td><td>          80</td></tr> 
     1319            <tr><td>McCabe essential</td><td>           3</td></tr> 
     1320            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1321          </table> 
    13201322           
    13211323         
Note: See TracChangeset for help on using the changeset viewer.