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_assistant_output/ToBeReviewed/PLOTS/DESSINE/pltz.html

    r363 r402  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier">pltz<i>, <a href="#_pltz_keyword_tab">tab</a>, <a href="#_pltz_keyword_giventype">giventype</a>, <a href="#_pltz_keyword_givenmin">givenmin</a>, <a href="#_pltz_keyword_givenmax">givenmax</a></i>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_pltz_keyword_INV">INV</a>=<i>INV</i>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<i>ZRATIO</i>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<i>CONTINTERVALLE</i>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<i>integer</i>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<i>integer</i>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<i>STYLE</i>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<i>CONTMAX</i>, <a href="#_pltz_keyword_SIN">SIN</a>=<i>SIN</i>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<i>CONTMIN</i>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<i>NLEVEL</i>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<i>CONTNLEVEL</i>, <a href="#_pltz_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<i>NOTRI</i>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<i>USETRI</i>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<i>FILLXDIR</i>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<i>ZOOM</i>, <a href="#_pltz_keyword_XZ">XZ</a>=<i>XZ</i>, <a href="#_pltz_keyword_YZ">YZ</a>=<i>YZ</i>, <a href="#_pltz_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<i>STRICTFILL</i>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<i>MASKFILL</i>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<i>REALSECTION</i>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
     76      <p><font face="Courier">pltz<i>, <a href="#_pltz_keyword_tab">tab</a>, <a href="#_pltz_keyword_giventype">giventype</a>, <a href="#_pltz_keyword_givenmin">givenmin</a>, <a href="#_pltz_keyword_givenmax">givenmax</a></i>, <a href="#_pltz_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_pltz_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_pltz_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_pltz_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_pltz_keyword_INV">INV</a>=<i>INV</i>, <a href="#_pltz_keyword_ZRATIO">ZRATIO</a>=<i>ZRATIO</i>, <a href="#_pltz_keyword_CONTINTERVALLE">CONTINTERVALLE</a>=<i>CONTINTERVALLE</i>, <a href="#_pltz_keyword_LABEL">LABEL</a>=<i>integer</i>, <a href="#_pltz_keyword_CONTLABEL">CONTLABEL</a>=<i>integer</i>, <a href="#_pltz_keyword_STYLE">STYLE</a>=<i>STYLE</i>, <a href="#_pltz_keyword_CONTMAX">CONTMAX</a>=<i>CONTMAX</i>, <a href="#_pltz_keyword_SIN">SIN</a>=<i>SIN</i>, <a href="#_pltz_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_pltz_keyword_CONTMIN">CONTMIN</a>=<i>CONTMIN</i>, <a href="#_pltz_keyword_NLEVEL">NLEVEL</a>=<i>NLEVEL</i>, <a href="#_pltz_keyword_CONTNLEVEL">CONTNLEVEL</a>=<i>CONTNLEVEL</i>, <a href="#_pltz_keyword_NOFILL">NOFILL</a>=<i>NOFILL</i>, <a href="#_pltz_keyword_NOMASK">NOMASK</a>=<i>NOMASK</i>, <a href="#_pltz_keyword_NO_PARTIALSTEP">NO_PARTIALSTEP</a>=<i>NO_PARTIALSTEP</i>, <a href="#_pltz_keyword_NOTRI">NOTRI</a>=<i>NOTRI</i>, <a href="#_pltz_keyword_USETRI">USETRI</a>=<i>USETRI</i>, <a href="#_pltz_keyword_FILLXDIR">FILLXDIR</a>=<i>FILLXDIR</i>, <a href="#_pltz_keyword_ZOOM">ZOOM</a>=<i>ZOOM</i>, <a href="#_pltz_keyword_XZ">XZ</a>=<i>XZ</i>, <a href="#_pltz_keyword_YZ">YZ</a>=<i>YZ</i>, <a href="#_pltz_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_pltz_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_pltz_keyword_STRICTFILL">STRICTFILL</a>=<i>STRICTFILL</i>, <a href="#_pltz_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_pltz_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_pltz_keyword_REALSECTION">REALSECTION</a>=<i>REALSECTION</i>, <a href="#_pltz_keyword_MASKFILL">MASKFILL</a>=<i>MASKFILL</i>, <a href="#_pltz_keyword_MASKDTA">MASKDTA</a>=<i>MASKDTA</i>, <a href="#_pltz_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
    7777 
    7878     
     
    9999     
    100100 The field whose we want to make a vertical cut can be 2 kind of thing: 
    101          1) An 2d or 3d array. 
    102          If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom. 
    103          If the field is 3d, we extract the section on we average possibly before to do the plot. 
    104          2)  a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>. 
    105           See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1) 
    106  
     101 1) An 2d or 3d array. 
     102    If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom. 
     103    If the field is 3d, we extract the section on we average possibly before to do the plot. 
     104 2) a structure respecting all criterions specified by <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>. 
     105    The array contained in the structure must be 2 or 3d (See case 1) 
    107106 
    108107     
     
    222221     
    223222 keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
    224  of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
     223 of these ones are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
    225224 coordinates. 
    226225 
     
    276275 
    277276     
    278  When the drawing has a zoomed part, it is the size rapport between the zoomed part, 
    279  hz (zoom height), and the whole drawing, ht (total height). 
     277 When the drawing has a zoomed part, it is the size ratio between the zoomed  
     278 part, hz (zoom height), and the whole drawing, ht (total height). 
    280279 
    281280     
     
    315314 It choose the label's type corresponding to cases in <a href="../../..//ToBeReviewed/PLOTS/LABEL/label.html">label</a> 
    316315 Comment: When CONTOUR is activated, it only specify the label's type for colored isolines. 
    317  For these one traced by a trait, use CONTLABEL. 
     316 For these ones traced by a trait, use CONTLABEL. 
    318317 
    319318     
     
    467466     
    468467 To make just isolines with no filling 
     468 
     469     
     470    <a name="#_pltz_keyword_NOMASK"></a> 
     471    <h4>NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     472       
     473       
     474       
     475       
     476       
     477       
     478       
     479       
     480    </h4> 
     481 
     482     
     483 activate to supress the use of the land-sea mask when plotting the field 
     484  
     485     
     486    <a name="#_pltz_keyword_NO_PARTIALSTEP"></a> 
     487    <h4>NO_PARTIALSTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     488       
     489       
     490       
     491       
     492       
     493       
     494       
     495       
     496    </h4> 
     497 
     498     
     499 activate to supress the use of partial steps (force key_partialstep = 0 within pltz) 
    469500 
    470501     
     
    639670 
    640671     
     672    <a name="#_pltz_keyword_WDEPTH"></a> 
     673    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     674       
     675       
     676       
     677       
     678       
     679       
     680       
     681       
     682    </h4> 
     683 
     684     
     685 To specify that the field is at W depth instead of T 
     686 depth (automatically activated if vargrid eq 'W') 
     687 
     688     
     689    <a name="#_pltz_keyword_REALSECTION"></a> 
     690    <h4>REALSECTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     691       
     692       
     693       
     694       
     695       
     696       
     697       
     698       
     699    </h4> 
     700 
     701     
     702     
    641703    <a name="#_pltz_keyword_MASKFILL"></a> 
    642704    <h4>MASKFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    652714 
    653715     
    654      
    655     <a name="#_pltz_keyword_WDEPTH"></a> 
    656     <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    657        
    658        
    659        
    660        
    661        
    662        
    663        
    664        
    665     </h4> 
    666  
    667      
    668  To specify that the field is at W depth instead of T 
    669  depth (automatically activated if vargrid eq 'W') 
    670  
    671      
    672     <a name="#_pltz_keyword_REALSECTION"></a> 
    673     <h4>REALSECTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    674        
    675        
    676        
    677        
    678        
    679        
    680        
    681        
    682     </h4> 
    683  
    684      
     716 set to 0 to avoid to fill the masked values 
     717 
     718     
     719    <a name="#_pltz_keyword_MASKDTA"></a> 
     720    <h4>MASKDTA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     721       
     722       
     723       
     724       
     725       
     726       
     727       
     728       
     729    </h4> 
     730 
     731     
     732 2d array defining the mask that must be applied to the data instead 
     733 of the default mask which is defined according to the grid (t/u/v/f mask) 
     734 
    685735     
    686736    <a name="#_pltz_keyword__EXTRA"></a> 
     
    704754     
    705755    <h4>Version</h4> 
    706  $Id: pltz.pro 360 2008-06-06 13:43:54Z smasson $ 
     756 $Id: pltz.pro 388 2008-12-09 09:36:41Z smasson $ 
    707757 
    708758    <h4>History</h4> 
     
    726776     
    727777    <h4>Uses routines</h4> 
    728  common.pro 
     778 <a href="../../..//Obsolete/common.html">common</a> 
    729779 
    730780     
Note: See TracChangeset for help on using the changeset viewer.