Ignore:
Timestamp:
03/21/07 10:14:37 (17 years ago)
Author:
pinsard
Message:

new idldoc html and assistant outputs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/plt1d.html

    r200 r234  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier">plt1d<i>, <a href="#_plt1d_keyword_tab">tab</a>, <a href="#_plt1d_keyword_param2">param2</a>[, <a href="#_plt1d_keyword_param3">param3</a>][, <a href="#_plt1d_keyword_param4">param4</a>]</i>, <a href="#_plt1d_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_plt1d_keyword_SIN">SIN</a>=<i>SIN</i>, <a href="#_plt1d_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_plt1d_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_plt1d_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_plt1d_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_plt1d_keyword_COL1D">COL1D</a>=<i>COL1D</i>, <a href="#_plt1d_keyword_STY1D">STY1D</a>=<i>STY1D</i>, <a href="#_plt1d_keyword_OV1D">OV1D</a>=<i>OV1D</i>, <a href="#_plt1d_keyword_X">X</a>=<i>X</i>, <a href="#_plt1d_keyword_Y">Y</a>=<i>Y</i>, <a href="#_plt1d_keyword_Z">Z</a>=<i>Z</i>, <a href="#_plt1d_keyword_TT">TT</a>=<i>TT</i>, <a href="#_plt1d_keyword_REVERSE_X">REVERSE_X</a>=<i>REVERSE_X</i>, <a href="#_plt1d_keyword_REVERSE_Y">REVERSE_Y</a>=<i>REVERSE_Y</i>, <a href="#_plt1d_keyword_SWITCHXY">SWITCHXY</a>=<i>SWITCHXY</i>, <a href="#_plt1d_keyword__extra">_extra</a>=<i>_extra</i></font></p> 
     76      <p><font face="Courier">plt1d<i>, <a href="#_plt1d_keyword_tab">tab</a>, <a href="#_plt1d_keyword_param2">param2</a>[, <a href="#_plt1d_keyword_param3">param3</a>][, <a href="#_plt1d_keyword_param4">param4</a>]</i>, <a href="#_plt1d_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_plt1d_keyword_SIN">SIN</a>=<i>SIN</i>, <a href="#_plt1d_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_plt1d_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_plt1d_keyword_TYPEIN">TYPEIN</a>=<i>TYPEIN</i>, <a href="#_plt1d_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_plt1d_keyword_COL1D">COL1D</a>=<i>COL1D</i>, <a href="#_plt1d_keyword_STY1D">STY1D</a>=<i>STY1D</i>, <a href="#_plt1d_keyword_OV1D">OV1D</a>=<i>OV1D</i>, <a href="#_plt1d_keyword_X">X</a>=<i>X</i>, <a href="#_plt1d_keyword_Y">Y</a>=<i>Y</i>, <a href="#_plt1d_keyword_Z">Z</a>=<i>Z</i>, <a href="#_plt1d_keyword_TT">TT</a>=<i>TT</i>, <a href="#_plt1d_keyword_REVERSE_X">REVERSE_X</a>=<i>REVERSE_X</i>, <a href="#_plt1d_keyword_REVERSE_Y">REVERSE_Y</a>=<i>REVERSE_Y</i>, <a href="#_plt1d_keyword_SWITCHXY">SWITCHXY</a>=<i>SWITCHXY</i>, <a href="#_plt1d_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
    7777 
    7878     
    … …  
    9797    </h4> 
    9898 
    99       
     99     
    100100 The field whose we want to make the hovmoller map can be 2 kind of thing: 
    101101        1) An array which can be: 
    102           * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array will pass  
    103           in moyenne or grossemoyenne to be averaged and become  an array 1d.  
    104           * 1d:Nevertheless, the type must be specified in order to we know which trace  
     102          * 2d, 3d or 4d:  array xy, xyz. xyt or xyzt. In this case, the array will pass 
     103          in moyenne or grossemoyenne to be averaged and become  an array 1d. 
     104          * 1d:Nevertheless, the type must be specified in order to we know which trace 
    105105          it is about. To have a correct caption, respecify the  extraction zone via BOXZOOM. 
    106        2) a structure respecting all criterions specified by litchamp.pro.  
    107           See IDL> xhelp,'litchamp'. The array contained in the structure  
    108           respecting criterions of case 1)  
     106       2) a structure respecting all criterions specified by <a href=".//../../../../ToBeReviewed/LECTURE/litchamp.html">litchamp</a> 
     107          See IDL> xhelp,'litchamp'. The array contained in the structure 
     108          respecting criterions of case 1) 
    109109 
    110110     
    … …  
    122122    </h4> 
    123123 
    124       
     124     
    125125 Min value we want to consider in the contour's drawing. 
    126126 Note: could also be the type of plot:'x','y','z' 
    127    
     127 
    128128     
    129129 
    … …  
    140140    </h4> 
    141141 
    142       
     142     
    143143 Max value we want to consider in the contour's drawing. 
    144144 Note: if param2 is defined as 'x','y','z' then param3 is used to define the min (see param2) 
    … …  
    158158    </h4> 
    159159 
    160       
     160     
    161161 Type of plot (can be only 'x','y','z' for plt1d). 
    162162 Note: if param2 is defined as 'xy' then param4 is used to define the max (see param3) 
    … …  
    182182 
    183183     
    184  Vector indicating the geographic zone (3d) on which the extraction of the field must  
     184 Vector indicating the geographic zone (3d) on which the extraction of the field must 
    185185 be done to do the hovmoeller. 
    186186  If BOXZOOM has : 
    … …  
    206206    </h4> 
    207207 
    208       
    209  Activate this keyword if we want the x axis to be traced in sinus of the  
     208     
     209 Activate this keyword if we want the x axis to be traced in sinus of the 
    210210 latitude when we make a drawing f(y) 
    211211 
    … …  
    223223    </h4> 
    224224 
    225       
    226  Allows to specify the min value we want to consider in the drawing of contour  
    227  helping by the keyword instead of the argument min. If the argument and the keyword are  
    228  specified in the same time, it is the value specified by the keyword which is retained. 
     225     
     226 Allows to specify the min value we want to consider in the drawing of contour 
     227 helping by the keyword instead of the argument min. 
     228 If the argument and the keyword are specified in the same time, it is the 
     229 value specified by the keyword which is retained. 
    229230 
    230231     
    … …  
    241242    </h4> 
    242243 
    243       
    244  Allows to specify the max value we want to consider in the drawing of contour  
    245  helping by the keyword instead of the argument max. If the argument and the keyword are  
    246  specified in the same time, it is the value specified by the keyword which is retained. 
     244     
     245 Allows to specify the max value we want to consider in the drawing of contour 
     246 helping by the keyword instead of the argument max. 
     247 If the argument and the keyword are specified in the same time, it is the 
     248 value specified by the keyword which is retained. 
    247249 
    248250     
    … …  
    261263     
    262264 allows to specify the type of hovmoller we want to do 
    263              'xt','yt','zt','t'   
    264  with help of a keyword rather than the argument type. If the argument and the  
    265  keyword are specified in the same time, it is the value specified by the  
     265             'xt','yt','zt','t' 
     266 with help of a keyword rather than the argument type. If the argument and the 
     267 keyword are specified in the same time, it is the value specified by the 
    266268 keyword which is retained. 
    267269 
    … …  
    279281    </h4> 
    280282 
    281       
    282  keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
    283  of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    284  coordinates. 
     283     
     284 keyword specifying that we want to make a vertical cut in diagonal. 
     285 Then coordinated of extremities of these one are defined by the 4 elements 
     286 of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates. 
    285287 
    286288     
    … …  
    298300 
    299301     
    300   --OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the  
    301  keyword COLOR used by plot. 
     302  --OBSOLETE--Color number when we make a trace 1d by default, 0. 
     303 It is better to use the keyword COLOR used by plot. 
    302304 
    303305     
    … …  
    314316    </h4> 
    315317 
    316       
     318     
    317319 --OBSOLETE-- 
    318  Number of the style used when we make a 1d drawing. We should better use the  
    319  keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still  
     320 Number of the style used when we make a 1d drawing. We should better use the 
     321 keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still 
    320322 useful if we want to d bars instead of curves, put sty1d='bar' 
    321323 
    … …  
    405407    </h4> 
    406408 
    407       
     409     
    408410 To invert the x axis (so as the drawing) 
    409411 
    … …  
    421423    </h4> 
    422424 
    423       
     425     
    424426 To invert the y axis (so as the drawing) 
    425427 
    … …  
    439441     
    440442     
    441     <a name="#_plt1d_keyword__extra"></a> 
    442     <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    443        
    444        
    445        
    446        
    447        
    448        
    449        
    450        
    451     </h4> 
    452  
    453       
    454  used to pass your keywords 
    455  
    456      
    457      
    458  
    459      
    460     <h3>Version history</h3> 
    461      
    462     <h4>Version</h4>  
    463  $Id: plt1d.pro 172 2006-09-11 07:11:26Z smasson $ 
    464  
    465     <h4>History</h4>  
    466  creation 24/6/99 Eric Guilyardi  
     443    <a name="#_plt1d_keyword__EXTRA"></a> 
     444    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     445       
     446       
     447       
     448       
     449       
     450       
     451       
     452       
     453    </h4> 
     454 
     455     
     456 Used to pass keywords 
     457 
     458     
     459     
     460 
     461     
     462    </pre><h3>Version history</h3> 
     463     
     464    <h4>Version</h4> 
     465 $Id: plt1d.pro 232 2007-03-20 16:59:36Z pinsard $ 
     466 
     467    <h4>History</h4> 
     468 creation 24/6/99 Eric Guilyardi 
    467469 (a partir routine pltt de Sebastien Masson) 
    468  8/7/1999 Sebastien Masson (smasson@lodyc.jussieu.fr)  
     470 8/7/1999 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    469471 inspection des travaux finis 
    470472 8/2/2000 Sebastien Masson: checkfield 
Note: See TracChangeset for help on using the changeset viewer.