Ignore:
Timestamp:
08/21/06 11:01:50 (18 years ago)
Author:
navarro
Message:

header improvements + xxx doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/a_correlate2d.html

    r151 r157  
    3333 
    3434/* Main styles --------------------------------------------------------------- */ 
     35p.preformat { 
     36  font-family: Courier; 
     37} 
    3538 
    3639body { 
     
    697700 
    698701      <div id="file_comments"> 
     702  
     703 
     704 
    699705 This function computes the autocorrelation Px(K,L) or 
    700706 autocovariance Rx(K,L) of a sample population X[nx,ny] as a 
     
    715721           
    716722          <dt><p><a href="#_Auto_Cov2d"><span class="result">result = </span>Auto_Cov2d(<span class="result">X, Lag</span>, Double=<span class="result">Double</span>, zero2nan=<span class="result">zero2nan</span>)</a></p><dt> 
    717           <dd></dd>      
     723          <dd> </dd>     
    718724           
    719725          <dt><p><a href="#_A_Correlate2d"><span class="result">result = </span>A_Correlate2d(<span class="result">X, Lag</span>, Covariance=<span class="result">Covariance</span>, Double=<span class="result">Double</span>)</a></p><dt> 
     
    729735        <div class="routine_details" id="_Auto_Cov2d"> 
    730736 
    731           <h2><a class="top" href="#container">top</a>Auto_Cov2d </h2> 
     737          <h2><a class="top" href="#container">top</a>Auto_Cov2d <span class="categories"> 
     738 Statistics 
     739</span></h2> 
    732740         
    733741          <p class="header"> 
    734742            <span class="result">result = </span>Auto_Cov2d(<span class="result"><a href="#_Auto_Cov2d_param_X">X</a>, <a href="#_Auto_Cov2d_param_Lag">Lag</a></span>, <a href="#_Auto_Cov2d_keyword_Double">Double</a>=<span class="result">Double</span>, <a href="#_Auto_Cov2d_keyword_zero2nan">zero2nan</a>=<span class="result">zero2nan</span>)</p> 
    735743         
    736           <div class="comments"></div> 
     744          <div class="comments"> 
     745</div> 
    737746 
    738747           
     
    743752             
    744753            <h4 id="_Auto_Cov2d_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    745                
    746                
    747                
    748                
    749                
    750                
    751                
    752                
    753             </h4> 
    754          
    755           <div class="comments"></div> 
    756              
    757             <h4 id="_Auto_Cov2d_param_Lag">Lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    758                
    759                
    760                
    761                
    762                
    763                
    764                
    765                
    766             </h4> 
    767          
    768           <div class="comments"></div> 
    769              
    770  
    771            
    772  
    773            
    774  
    775             <h3>Keywords</h3> 
    776              
    777             <h4 id="_Auto_Cov2d_keyword_Double">Double&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    778                
    779                
    780                
    781                
    782                
    783                
    784                
    785                
    786             </h4> 
    787          
    788             <div class="comments"></div> 
    789              
    790             <h4 id="_Auto_Cov2d_keyword_zero2nan">zero2nan&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    791                
    792                
    793                
    794                
    795                
    796                
    797                
    798                
    799             </h4> 
    800          
    801             <div class="comments"></div> 
    802              
    803            
    804  
    805            
    806            
    807            
    808            
    809            
    810            
    811            
    812            
    813            
    814            
    815            
    816            
    817          
    818            
    819            
    820            
    821            
    822            
    823            
    824            
    825          
    826            
    827          
    828         </div> 
    829          
    830  
    831         <div class="routine_details" id="_A_Correlate2d"> 
    832  
    833           <h2><a class="top" href="#container">top</a>A_Correlate2d <span class="categories"> 
    834  Statistics. 
    835 </span></h2> 
    836          
    837           <p class="header"> 
    838             <span class="result">result = </span>A_Correlate2d(<span class="result"><a href="#_A_Correlate2d_param_X">X</a>, <a href="#_A_Correlate2d_param_Lag">Lag</a></span>, <a href="#_A_Correlate2d_keyword_Covariance">Covariance</a>=<span class="result">Covariance</span>, <a href="#_A_Correlate2d_keyword_Double">Double</a>=<span class="result">Double</span>)</p> 
    839          
    840           <div class="comments"> 
    841 </div> 
    842  
    843            
    844  
    845            
    846             <h3>Parameters</h3> 
    847          
    848              
    849             <h4 id="_A_Correlate2d_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    850754              <span class="attr">in</span> 
    851755               
     
    862766</div> 
    863767             
    864             <h4 id="_A_Correlate2d_param_Lag">Lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     768            <h4 id="_Auto_Cov2d_param_Lag">Lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    865769              <span class="attr">in</span> 
    866770               
     
    886790            <h3>Keywords</h3> 
    887791             
     792            <h4 id="_Auto_Cov2d_keyword_Double">Double&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     793               
     794               
     795               
     796               
     797               
     798               
     799               
     800               
     801            </h4> 
     802         
     803            <div class="comments"> 
     804 If set to a non-zero value, computations are done in double precision arithmetic. 
     805</div> 
     806             
     807            <h4 id="_Auto_Cov2d_keyword_zero2nan">zero2nan&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     808               
     809               
     810               
     811               
     812               
     813               
     814               
     815               
     816            </h4> 
     817         
     818            <div class="comments"> 
     819</div> 
     820             
     821           
     822 
     823           
     824          <h3>Version history</h3> 
     825           
     826          <h4>Version</h4><div class="preformat"> 
     827 $Id: a_correlate2d.pro 150 2006-08-09 10:12:54Z navarro $ 
     828</div> 
     829          <h4>History</h4><div class="preformat"> 
     830 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     831 Based on the A_CORRELATE procedure of IDL 
     832</div> 
     833           
     834           
     835           
     836           
     837           
     838           
     839           
     840         
     841           
     842           
     843           
     844           
     845           
     846           
     847           
     848         
     849           
     850         
     851        </div> 
     852         
     853 
     854        <div class="routine_details" id="_A_Correlate2d"> 
     855 
     856          <h2><a class="top" href="#container">top</a>A_Correlate2d <span class="categories"> 
     857 Statistics 
     858</span></h2> 
     859         
     860          <p class="header"> 
     861            <span class="result">result = </span>A_Correlate2d(<span class="result"><a href="#_A_Correlate2d_param_X">X</a>, <a href="#_A_Correlate2d_param_Lag">Lag</a></span>, <a href="#_A_Correlate2d_keyword_Covariance">Covariance</a>=<span class="result">Covariance</span>, <a href="#_A_Correlate2d_keyword_Double">Double</a>=<span class="result">Double</span>)</p> 
     862         
     863          <div class="comments"> 
     864</div> 
     865 
     866           
     867 
     868           
     869            <h3>Parameters</h3> 
     870         
     871             
     872            <h4 id="_A_Correlate2d_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     873              <span class="attr">in</span> 
     874               
     875               
     876              <span class="attr">required</span> 
     877               
     878               
     879               
     880               
     881            </h4> 
     882         
     883          <div class="comments"> 
     884 An 2 dimension Array [nx,ny] 
     885</div> 
     886             
     887            <h4 id="_A_Correlate2d_param_Lag">Lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     888              <span class="attr">in</span> 
     889               
     890               
     891              <span class="attr">required</span> 
     892               
     893               
     894               
     895               
     896            </h4> 
     897         
     898          <div class="comments"> 
     899 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], 
     900 of type integer that specifies the absolute distance(s) between  
     901 indexed elements of X. 
     902</div> 
     903             
     904 
     905           
     906 
     907           
     908 
     909            <h3>Keywords</h3> 
     910             
    888911            <h4 id="_A_Correlate2d_keyword_Covariance">Covariance&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    889912               
     
    924947 $Id: a_correlate2d.pro 150 2006-08-09 10:12:54Z navarro $ 
    925948</div> 
    926           <h4>History</h4><div class="preformat"></div> 
     949          <h4>History</h4><div class="preformat"> 
     950 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     951 Based on the A_CORRELATE procedure of IDL 
     952</div> 
    927953           
    928954           
Note: See TracChangeset for help on using the changeset viewer.