Ignore:
Timestamp:
07/23/09 11:18:49 (15 years ago)
Author:
smasson
Message:

update documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltz.html

    r363 r402  
    109109         
    110110          <p class="header"> 
    111             pltz<span class="result">, <a href="#_pltz_param_tab">tab</a>, <a href="#_pltz_param_giventype">giventype</a>, <a href="#_pltz_param_givenmin">givenmin</a>, <a href="#_pltz_param_givenmax">givenmax</a></span>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltz_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<span class="result">ZRATIO</span>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltz_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltz_keyword_NOFILL">NOFILL</a>=<span class="result">NOFILL</span>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<span class="result">FILLXDIR</span>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<span class="result">ZOOM</span>, <a href="#_pltz_keyword_XZ">XZ</a>=<span class="result">XZ</span>, <a href="#_pltz_keyword_YZ">YZ</a>=<span class="result">YZ</span>, <a href="#_pltz_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<span class="result">REALSECTION</span>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     111            pltz<span class="result">, <a href="#_pltz_param_tab">tab</a>, <a href="#_pltz_param_giventype">giventype</a>, <a href="#_pltz_param_givenmin">givenmin</a>, <a href="#_pltz_param_givenmax">givenmax</a></span>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<span class="result">CONTOUR</span>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<span class="result">INTERVALLE</span>, <a href="#_pltz_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<span class="result">ZRATIO</span>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<span class="result">CONTINTERVALLE</span>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<span class="result">integer</span>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<span class="result">STYLE</span>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<span class="result">CONTMAX</span>, <a href="#_pltz_keyword_SIN">SIN</a>=<span class="result">SIN</span>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<span class="result">TYPEIN</span>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<span class="result">CONTMIN</span>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<span class="result">NLEVEL</span>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<span class="result">CONTNLEVEL</span>, <a href="#_pltz_keyword_NOFILL">NOFILL</a>=<span class="result">NOFILL</span>, <a href="#_pltz_keyword_NOMASK">NOMASK</a>=<span class="result">NOMASK</span>, <a href="#_pltz_keyword_NO_PARTIALSTEP">NO_PARTIALSTEP</a>=<span class="result">NO_PARTIALSTEP</span>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<span class="result">USETRI</span>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<span class="result">FILLXDIR</span>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<span class="result">ZOOM</span>, <a href="#_pltz_keyword_XZ">XZ</a>=<span class="result">XZ</span>, <a href="#_pltz_keyword_YZ">YZ</a>=<span class="result">YZ</span>, <a href="#_pltz_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<span class="result">STRICTFILL</span>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<span class="result">REALSECTION</span>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<span class="result">MASKFILL</span>, <a href="#_pltz_keyword_MASKDTA">MASKDTA</a>=<span class="result">MASKDTA</span>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    112112         
    113113          <div class="comments"> 
     
    133133          <div class="comments"> 
    134134 The field whose we want to make a vertical cut can be 2 kind of thing: 
    135          1) An 2d or 3d array. 
    136          If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom. 
    137          If the field is 3d, we extract the section on we average possibly before to do the plot. 
    138          2)  a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>. 
    139           See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1) 
    140  
     135 1) An 2d or 3d array. 
     136    If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom. 
     137    If the field is 3d, we extract the section on we average possibly before to do the plot. 
     138 2) a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>. 
     139    The array contained in the structure must be 2 or 3d (See case 1) 
    141140</div> 
    142141             
     
    248247            <div class="comments"> 
    249248 keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
    250  of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
     249 of these ones are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
    251250 coordinates. 
    252251</div> 
     
    299298         
    300299            <div class="comments"> 
    301  When the drawing has a zoomed part, it is the size rapport between the zoomed part, 
    302  hz (zoom height), and the whole drawing, ht (total height). 
     300 When the drawing has a zoomed part, it is the size ratio between the zoomed  
     301 part, hz (zoom height), and the whole drawing, ht (total height). 
    303302</div> 
    304303             
     
    336335 It choose the label's type corresponding to cases in <a href="../../..//ToBeReviewed/PLOTS/LABEL/label.html">label</a> 
    337336 Comment: When CONTOUR is activated, it only specify the label's type for colored isolines. 
    338  For these one traced by a trait, use CONTLABEL. 
     337 For these ones traced by a trait, use CONTLABEL. 
    339338</div> 
    340339             
     
    479478            <div class="comments"> 
    480479 To make just isolines with no filling 
     480</div> 
     481             
     482            <h4 id="_pltz_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     483               
     484               
     485               
     486               
     487               
     488               
     489               
     490               
     491            </h4> 
     492         
     493            <div class="comments"> 
     494 activate to supress the use of the land-sea mask when plotting the field 
     495 </div> 
     496             
     497            <h4 id="_pltz_keyword_NO_PARTIALSTEP">NO_PARTIALSTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     498               
     499               
     500               
     501               
     502               
     503               
     504               
     505               
     506            </h4> 
     507         
     508            <div class="comments"> 
     509 activate to supress the use of partial steps (force key_partialstep = 0 within pltz) 
    481510</div> 
    482511             
     
    641670</div> 
    642671             
    643             <h4 id="_pltz_keyword_MASKFILL">MASKFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    644                
    645                
    646                
    647                
    648                
    649                
    650                
    651                
    652             </h4> 
    653          
    654             <div class="comments"></div> 
    655              
    656672            <h4 id="_pltz_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    657673               
     
    683699            <div class="comments"></div> 
    684700             
     701            <h4 id="_pltz_keyword_MASKFILL">MASKFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     702               
     703               
     704               
     705               
     706               
     707               
     708               
     709               
     710            </h4> 
     711         
     712            <div class="comments"> 
     713 set to 0 to avoid to fill the masked values 
     714</div> 
     715             
     716            <h4 id="_pltz_keyword_MASKDTA">MASKDTA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     717               
     718               
     719               
     720               
     721               
     722               
     723               
     724               
     725            </h4> 
     726         
     727            <div class="comments"> 
     728 2d array defining the mask that must be applied to the data instead 
     729 of the default mask which is defined according to the grid (t/u/v/f mask) 
     730</div> 
     731             
    685732            <h4 id="_pltz_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    686733               
     
    702749           
    703750          <h4>Version</h4><div class="preformat"> 
    704  $Id: pltz.pro 360 2008-06-06 13:43:54Z smasson $ 
     751 $Id: pltz.pro 388 2008-12-09 09:36:41Z smasson $ 
    705752</div> 
    706753          <h4>History</h4><div class="preformat"> 
     
    724771           
    725772          <h4>Uses routines</h4><div class="preformat"> 
    726  common.pro 
     773 <a href="../../..//Obsolete/common.html">common</a> 
    727774</div> 
    728775           
     
    732779          <h3>Statistics</h3> 
    733780          <table class="statistics"> 
    734             <tr><td>McCabe cyclic</td><td>          70</td></tr> 
     781            <tr><td>McCabe cyclic</td><td>          73</td></tr> 
    735782            <tr><td>McCabe essential</td><td>           3</td></tr> 
    736783            <tr><td>McCabe modular design</td><td>           1</td></tr> 
Note: See TracChangeset for help on using the changeset viewer.