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/Utilities/fitintobox.html

    r338 r402  
    111111         
    112112          <p class="header"> 
    113             <span class="result">result = </span>fitintobox(<span class="result"><a href="#_fitintobox_param_field">field</a>[, <a href="#_fitintobox_param_nx">nx</a>][, <a href="#_fitintobox_param_ny">ny</a>][, <a href="#_fitintobox_param_nz">nz</a>][, <a href="#_fitintobox_param_firstx">firstx</a>][, <a href="#_fitintobox_param_firsty">firsty</a>][, <a href="#_fitintobox_param_firstz">firstz</a>][, <a href="#_fitintobox_param_lastx">lastx</a>][, <a href="#_fitintobox_param_lasty">lasty</a>][, <a href="#_fitintobox_param_lastz">lastz</a>]</span>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>)</p> 
     113            <span class="result">result = </span>fitintobox(<span class="result"><a href="#_fitintobox_param_field">field</a>[, <a href="#_fitintobox_param_nx">nx</a>][, <a href="#_fitintobox_param_ny">ny</a>][, <a href="#_fitintobox_param_nz">nz</a>][, <a href="#_fitintobox_param_firstx">firstx</a>][, <a href="#_fitintobox_param_firsty">firsty</a>][, <a href="#_fitintobox_param_firstz">firstz</a>][, <a href="#_fitintobox_param_lastx">lastx</a>][, <a href="#_fitintobox_param_lasty">lasty</a>][, <a href="#_fitintobox_param_lastz">lastz</a>]</span>, <a href="#_fitintobox_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>)</p> 
    114114         
    115115          <div class="comments"> 
     
    117117 
    118118          <h3>Return value</h3><div class="preformat"> 
    119  an array with dimensions matching the domain 
    120  or -1 if there is an error... 
     119 an array with dimensions matching the domain or -1 if there is an error. 
    121120</div> 
    122121 
     
    274273            <h3>Keywords</h3> 
    275274             
     275            <h4 id="_fitintobox_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     276               
     277               
     278               
     279               
     280               
     281               
     282              <span class="attr">default:</span> <span class="value">vargrid defined in <a href="..//Commons/cm_4data.html">cm_4data</a></span> 
     283               
     284            </h4> 
     285         
     286            <div class="comments">  
     287 To specify on which grid are located the data, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> 
     288</div> 
     289             
    276290            <h4 id="_fitintobox_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    277291               
     
    281295               
    282296               
    283                
     297              <span class="attr">default:</span> <span class="value">0</span> 
    284298               
    285299            </h4> 
    286300         
    287301            <div class="comments"> 
    288  To specify that we are at W level 
     302 To specify that we are at W level, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> 
    289303</div> 
    290304             
     
    292306 
    293307          <h3>Examples</h3><div class="preformat"> 
    294  IDL> help, fitintobox(findgen(jpi,jpj)) 
     308 
     309   IDL> help, fitintobox(findgen(jpi,jpj)) 
    295310 <Expression>    FLOAT     = Array[41, 3] 
    296  IDL> help, fitintobox(findgen(jpi,jpj,78)) 
     311   IDL> help, fitintobox(findgen(jpi,jpj,78)) 
    297312 Error: 
    298313 the array dimensions [180,148,78] are incompatible 
     
    304319           
    305320          <h4>Version</h4><div class="preformat"> 
    306  $Id: fitintobox.pro 327 2007-12-13 16:22:35Z pinsard $ 
     321 $Id: fitintobox.pro 388 2008-12-09 09:36:41Z smasson $ 
    307322</div> 
    308323          <h4>History</h4><div class="preformat"> 
     
    323338           
    324339          <h4>Uses routines</h4><div class="preformat"> 
    325  cm_4mesh 
    326  cm_4cal 
     340 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> 
     341 <a href="..//Commons/cm_4cal.html">cm_4cal</a> 
    327342</div> 
    328343           
Note: See TracChangeset for help on using the changeset viewer.