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

    r338 r402  
    7676</font></h2> 
    7777 
    78       <p><font face="Courier"><i>result = </i>fitintobox(<i><a href="#_fitintobox_keyword_field">field</a>[, <a href="#_fitintobox_keyword_nx">nx</a>][, <a href="#_fitintobox_keyword_ny">ny</a>][, <a href="#_fitintobox_keyword_nz">nz</a>][, <a href="#_fitintobox_keyword_firstx">firstx</a>][, <a href="#_fitintobox_keyword_firsty">firsty</a>][, <a href="#_fitintobox_keyword_firstz">firstz</a>][, <a href="#_fitintobox_keyword_lastx">lastx</a>][, <a href="#_fitintobox_keyword_lasty">lasty</a>][, <a href="#_fitintobox_keyword_lastz">lastz</a>]</i>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>)</font></p> 
     78      <p><font face="Courier"><i>result = </i>fitintobox(<i><a href="#_fitintobox_keyword_field">field</a>[, <a href="#_fitintobox_keyword_nx">nx</a>][, <a href="#_fitintobox_keyword_ny">ny</a>][, <a href="#_fitintobox_keyword_nz">nz</a>][, <a href="#_fitintobox_keyword_firstx">firstx</a>][, <a href="#_fitintobox_keyword_firsty">firsty</a>][, <a href="#_fitintobox_keyword_firstz">firstz</a>][, <a href="#_fitintobox_keyword_lastx">lastx</a>][, <a href="#_fitintobox_keyword_lasty">lasty</a>][, <a href="#_fitintobox_keyword_lastz">lastz</a>]</i>, <a href="#_fitintobox_keyword_GRID">GRID</a>=<i>GRID</i>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>)</font></p> 
    7979 
    8080     
     
    8282 
    8383    <h3>Return value</h3> 
    84  an array with dimensions matching the domain 
    85  or -1 if there is an error... 
     84 an array with dimensions matching the domain or -1 if there is an error. 
    8685 
    8786 
     
    257256 
    258257     
     258    <a name="#_fitintobox_keyword_GRID"></a> 
     259    <h4>GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     260       
     261       
     262       
     263       
     264       
     265       
     266      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>vargrid defined in <a href="..//Commons/cm_4data.html">cm_4data</a></i></font> 
     267       
     268    </h4> 
     269 
     270      
     271 To specify on which grid are located the data, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> 
     272 
     273     
    259274    <a name="#_fitintobox_keyword_WDEPTH"></a> 
    260275    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    265280       
    266281       
    267        
    268        
    269     </h4> 
    270  
    271      
    272  To specify that we are at W level 
     282      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     283       
     284    </h4> 
     285 
     286     
     287 To specify that we are at W level, see <a href="..//ToBeReviewed/GRILLE/grille.html">grille</a> 
    273288 
    274289     
     
    276291 
    277292    <h3>Examples</h3><pre> 
    278  IDL> help, fitintobox(findgen(jpi,jpj)) 
     293 
     294   IDL> help, fitintobox(findgen(jpi,jpj)) 
    279295 <Expression>    FLOAT     = Array[41, 3] 
    280  IDL> help, fitintobox(findgen(jpi,jpj,78)) 
     296   IDL> help, fitintobox(findgen(jpi,jpj,78)) 
    281297 Error: 
    282298 the array dimensions [180,148,78] are incompatible 
     
    288304     
    289305    <h4>Version</h4> 
    290  $Id: fitintobox.pro 327 2007-12-13 16:22:35Z pinsard $ 
     306 $Id: fitintobox.pro 388 2008-12-09 09:36:41Z smasson $ 
    291307 
    292308    <h4>History</h4> 
     
    307323     
    308324    <h4>Uses routines</h4> 
    309  cm_4mesh 
    310  cm_4cal 
     325 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> 
     326 <a href="..//Commons/cm_4cal.html">cm_4cal</a> 
    311327 
    312328     
Note: See TracChangeset for help on using the changeset viewer.