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/Grid/computegrid.html

    r157 r163  
    763763         
    764764          <p class="header"> 
    765             computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     765            computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">string</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    766766         
    767767          <div class="comments"> 
     
    10421042               
    10431043               
    1044                
    1045                
    1046             </h4> 
    1047          
    1048             <div class="comments"> = 0 or 1 to force the manual definition of 
     1044              <span class="attr">default:</span> <span class="value"> key_onearth</span> 
     1045               
     1046            </h4> 
     1047         
     1048            <div class="comments"> 
     1049       = 0 or 1 to force the manual definition of 
    10491050       key_onearth (to specify if the data are on earth -> use longitude 
    1050        /latitude etc...). By default, key_onearth = 1. 
     1051       /latitude etc...). 
    10511052       note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0, 
    10521053       and is cancelling GLAMBOUNDARY 
     
    10601061               
    10611062               
    1062                
    1063                
    1064             </h4> 
    1065          
    1066             <div class="comments"> = 0 or 1 to force the manual definition of 
    1067        key_periodic. By default, key_periodic is automaticaly 
    1068        computed by using the first line of glamt. 
     1063              <span class="attr">default:</span> <span class="value">key_periodic is automatically computed by using the first line of glamt</span> 
     1064               
     1065            </h4> 
     1066         
     1067            <div class="comments"> 
     1068       = 0 or 1 to force the manual definition of key_periodic. 
    10691069</div> 
    10701070             
     
    10981098         
    10991099            <div class="comments"> = scalar to force the manual definition of key_shift. By 
    1100        default, key_shift is automaticaly computed according to 
     1100       default, key_shift is automatically computed according to 
    11011101       glamboundary (when defined) by using the FIRST LINE of glamt. if 
    11021102       key_periodic=0 then in any case key_shift = 0. 
     
    11311131         
    11321132            <div class="comments"> activate to specify that you want to compute 
    1133        all the paremeters of a C grid. Computation of glam[uv], 
     1133       all the parameters of a C grid. Computation of glam[uv], 
    11341134       gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 
    11351135       will be add to the default computations 
     
    11731173               
    11741174               
    1175                
    1176                
    1177                
    1178             </h4> 
    1179          
    1180             <div class="comments"> a string containing the calling command used to 
     1175              <span class="attr">type:</span> <span class="value">string</span> 
     1176               
     1177               
     1178            </h4> 
     1179         
     1180            <div class="comments"> 
     1181       a string containing the calling command used to 
    11811182       call computegrid (this is used by xxx.pro) 
    11821183 
     
    12031204          <h3>Version history</h3> 
    12041205           
    1205           <h4>Version</h4><div class="preformat"> $Id: computegrid.pro 134 2006-07-07 10:19:08Z navarro $ 
     1206          <h4>Version</h4><div class="preformat"> $Id: computegrid.pro 157 2006-08-21 09:01:50Z navarro $ 
    12061207</div> 
    12071208          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     
    12361237           
    12371238         
     1239          <h3>Statistics</h3> 
     1240          <table class="statistics"> 
     1241            <tr><td>McCabe cyclic</td><td>         209</td></tr> 
     1242            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1243            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1244          </table> 
    12381245           
    12391246         
Note: See TracChangeset for help on using the changeset viewer.