Ignore:
Timestamp:
09/13/06 17:50:54 (18 years ago)
Author:
smasson
Message:

updates of html files...

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Grid
Files:
12 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/changemsk.html

    r168 r177  
    143143     
    144144 
    145     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:16 2006.</font></p> 
     145    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:09 2006.</font></p> 
    146146 
    147147  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/computegrid.html

    r168 r177  
    6161    </dl> 
    6262 
    63      compute the grid parameters from cm_4mesh common: 
    64  
    65        computegrid, startx, starty, stepx, stepy, nx, ny 
    66        computegrid, startx, starty, stepx, stepy 
    67        computegrid, xaxis = xaxis, yaxis = yaxis 
    68        or a suitable mix... 
    69  
    70  glamt 
    71  glamf 
    72  gphit 
    73  gphit 
    74  e1t 
    75  e2t 
    76  horizontal parameters 
    77  
    78  glamu {in} 
    79  glamv {in} 
    80  gphiu {in} 
    81  gphiv {in} 
    82  e1u {in} 
    83  e1v {in} 
    84  e1f {in} 
    85  e2u {in} 
    86  e2v {in} 
    87  e2f {in} 
    88  horizontal parameters if FULLCGRID keyword is defined 
    89  
    90  gdept 
    91  gdepw 
    92  e3t 
    93  e3w 
    94  verticals parameters 
    95  
    96  tmask 
    97  masks 
    98  
    99  umaskred {in} 
    100  vmaskred {in} 
    101  fmaskredx {in} 
    102  fmaskredy {in} 
    103  masks if FULLCGRID keyword is defined 
    104  
    105  triangles_list 
    106  triangulation 
    107  
     63      
     64 
     65 compute the grid parameters (cm_4mesh) common 
     66 
     67 domains sizes: 
    10868 
    10969     
    … …  
    11272      <a name="#_computegrid"></a> 
    11373 
    114       <h2>computegrid  <font size="-1" color="#006633">  
    115  Grid 
    116 </font></h2> 
    117  
    118       <p><font face="Courier">computegrid<i>, <a href="#_computegrid_keyword_startx">startx</a>, <a href="#_computegrid_keyword_starty">starty</a>, <a href="#_computegrid_keyword_stepxin">stepxin</a>, <a href="#_computegrid_keyword_stepyin">stepyin</a>, <a href="#_computegrid_keyword_nxin">nxin</a>, <a href="#_computegrid_keyword_nyin">nyin</a></i>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<i>XAXIS</i>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<i>YAXIS</i>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<i>ZAXIS</i>, <a href="#_computegrid_keyword_MASK">MASK</a>=<i>MASK</i>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>GLAMBOUNDARY</i>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<i>XMINMESH</i>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<i>XMAXMESH</i>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<i>YMINMESH</i>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<i>YMAXMESH</i>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<i>ZMINMESH</i>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<i>ZMAXMESH</i>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<i>ONEARTH</i>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<i>PERIODIC</i>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<i>PLAIN</i>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<i>SHIFT</i>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<i>STRIDE</i>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<i>FULLCGRID</i>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<i>XYINDEX</i>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<i>string</i>, <a href="#_computegrid_keyword__extra">_extra</a>=<i>_extra</i></font></p> 
     74      <h2>computegrid  </h2> 
     75 
     76      <p><font face="Courier">computegrid<i>, <a href="#_computegrid_keyword_startx">startx</a>, <a href="#_computegrid_keyword_starty">starty</a>, <a href="#_computegrid_keyword_stepxin">stepxin</a>, <a href="#_computegrid_keyword_stepyin">stepyin</a>, <a href="#_computegrid_keyword_nxin">nxin</a>, <a href="#_computegrid_keyword_nyin">nyin</a></i>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<i>XAXIS</i>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<i>YAXIS</i>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<i>ZAXIS</i>, <a href="#_computegrid_keyword_MASK">MASK</a>=<i>MASK</i>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>GLAMBOUNDARY</i>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<i>XMINMESH</i>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<i>XMAXMESH</i>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<i>YMINMESH</i>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<i>YMAXMESH</i>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<i>ZMINMESH</i>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<i>ZMAXMESH</i>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<i>ONEARTH</i>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<i>PERIODIC</i>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<i>PLAIN</i>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<i>SHIFT</i>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<i>STRIDE</i>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<i>FULLCGRID</i>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<i>XYINDEX</i>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<i>STRCALLING</i>, <a href="#_computegrid_keyword_ROMSH">ROMSH</a>=<i>ROMSH</i>, <a href="#_computegrid_keyword__extra">_extra</a>=<i>_extra</i></font></p> 
    11977 
    12078     
    … …  
    12987    <a name="#_computegrid_keyword_startx"></a> 
    13088    <h4>startx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    131       <font size="-1" color="#006633">in</font> 
    132        
    133        
    134       <font size="-1" color="#006633">required</font> 
    135        
    136        
    137        
    138        
    139     </h4> 
    140  
    141      scalar, x starting point 
     89       
     90       
     91       
     92       
     93       
     94       
     95       
     96       
     97    </h4> 
     98 
     99     
    142100     
    143101 
    144102    <a name="#_computegrid_keyword_starty"></a> 
    145103    <h4>starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    146       <font size="-1" color="#006633">in</font> 
    147        
    148        
    149       <font size="-1" color="#006633">required</font> 
    150        
    151        
    152        
    153        
    154     </h4> 
    155  
    156      scalar, y starting point 
     104       
     105       
     106       
     107       
     108       
     109       
     110       
     111       
     112    </h4> 
     113 
     114     
    157115     
    158116 
    159117    <a name="#_computegrid_keyword_stepxin"></a> 
    160118    <h4>stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    161       <font size="-1" color="#006633">in</font> 
    162        
    163        
    164       <font size="-1" color="#006633">required</font> 
    165        
    166        
    167        
    168        
    169     </h4> 
    170  
    171      scalar or vector: x direction step, must be > 0 
    172              if vector nx is not used 
     119       
     120       
     121       
     122       
     123       
     124       
     125       
     126       
     127    </h4> 
     128 
     129     
    173130     
    174131 
    175132    <a name="#_computegrid_keyword_stepyin"></a> 
    176133    <h4>stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    177       <font size="-1" color="#006633">in</font> 
    178        
    179        
    180       <font size="-1" color="#006633">required</font> 
    181        
    182        
    183        
    184        
    185     </h4> 
    186  
    187      scalar or vector: y direction step, 
    188              could be > 0 (south to north) or < 0 (north to south) 
    189              if vector ny is not used 
     134       
     135       
     136       
     137       
     138       
     139       
     140       
     141       
     142    </h4> 
     143 
     144     
    190145     
    191146 
    192147    <a name="#_computegrid_keyword_nxin"></a> 
    193148    <h4>nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    194       <font size="-1" color="#006633">in</font> 
    195        
    196        
    197       <font size="-1" color="#006633">required</font> 
    198        
    199        
    200        
    201        
    202     </h4> 
    203  
    204      scalar, number of points in x direction 
     149       
     150       
     151       
     152       
     153       
     154       
     155       
     156       
     157    </h4> 
     158 
     159     
    205160     
    206161 
    207162    <a name="#_computegrid_keyword_nyin"></a> 
    208163    <h4>nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    209       <font size="-1" color="#006633">in</font> 
    210        
    211        
    212       <font size="-1" color="#006633">required</font> 
    213        
    214        
    215        
    216        
    217     </h4> 
    218  
    219      scalar, number of points in y direction 
    220  
     164       
     165       
     166       
     167       
     168       
     169       
     170       
     171       
     172    </h4> 
     173 
     174     
    221175     
    222176     
    … …  
    238192    </h4> 
    239193 
    240      to specify longitude1 with a 1 or 2 dimension array, in 
    241        this case startx, stepx and nx are not used but could be 
    242        necessary if the y axis is not defined with yaxis. It must be 
    243        possible to sort the first line of xaxis in the increasing 
    244        order by shifting its elements. 
    245  
     194     
    246195     
    247196    <a name="#_computegrid_keyword_YAXIS"></a> 
    … …  
    257206    </h4> 
    258207 
    259      to specify latitudes with a 1 or 2 dimension array, in 
    260        this case starty, stepy and ny are not used but starty and 
    261        stepy could be necessary if the x axis is not defined with xaxis. 
    262        It must be sorted in the increasing or deceasing order 
    263        (along each column if 2d array). 
    264  
     208     
    265209     
    266210    <a name="#_computegrid_keyword_ZAXIS"></a> 
    … …  
    276220    </h4> 
    277221 
    278      to specify the vertical axis with a 1 dimension 
    279        array. Must be sorted in the increasing or deceasing order 
    280  
     222     
    281223     
    282224    <a name="#_computegrid_keyword_MASK"></a> 
    … …  
    292234    </h4> 
    293235 
    294      to specify the mask with a 2 or 3 dimension array 
    295  
     236     
    296237     
    297238    <a name="#_computegrid_keyword_GLAMBOUNDARY"></a> 
    … …  
    307248    </h4> 
    308249 
    309      a 2 elements vector, [lon1,lon2], the longitude 
    310        boundaries that should be used to visualize the data. 
    311        we must have lon2 > lon1 and lon2 - lon1 le 360 
    312        key_shift will be defined automaticaly computed according to 
    313        glamboundary by using the FIRST LINE of glamt but 
    314        key_shift will /= 0 only if key_periodic = 1 
    315  
     250     
    316251     
    317252    <a name="#_computegrid_keyword_XMINMESH"></a> 
    … …  
    323258       
    324259       
    325       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     260       
    326261       
    327262    </h4> 
    … …  
    337272       
    338273       
    339       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font> 
     274       
    340275       
    341276    </h4> 
    … …  
    351286       
    352287       
    353       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     288       
    354289       
    355290    </h4> 
    … …  
    365300       
    366301       
    367       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font> 
     302       
    368303       
    369304    </h4> 
    … …  
    379314       
    380315       
    381       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
    382        
    383     </h4> 
    384  
    385      
    386        to define the common variables i[xyz]minmesh 
    387        used to define the grid only in a zoomed part of the original 
    388        grid. max value is [XYZ]MAXMESH 
    389  
     316       
     317       
     318    </h4> 
     319 
     320     
    390321     
    391322    <a name="#_computegrid_keyword_ZMAXMESH"></a> 
    … …  
    397328       
    398329       
    399       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpkglo-1</i></font> 
    400        
    401     </h4> 
    402  
    403      
    404        to define the common variables i[xyz]maxmesh 
    405        used to define the grid only in a zoomed part of the original 
    406        grid. max value is jp[ijk]glo-1. 
    407        if [XYZ]MAXMESH is negative, then we define i[xyz]maxmesh as 
    408        jp[ijk]glo - 1 + [XYZ]MAXMESH instead of [XYZ]MAXMESH     
    409  
     330       
     331       
     332    </h4> 
     333 
     334     
    410335     
    411336    <a name="#_computegrid_keyword_ONEARTH"></a> 
    … …  
    417342       
    418343       
    419       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i> key_onearth</i></font> 
    420        
    421     </h4> 
    422  
    423      
    424        = 0 or 1 to force the manual definition of 
    425        key_onearth (to specify if the data are on earth -> use longitude 
    426        /latitude etc...). 
    427        note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0, 
    428        and is cancelling GLAMBOUNDARY 
    429  
     344       
     345       
     346    </h4> 
     347 
     348     
    430349     
    431350    <a name="#_computegrid_keyword_PERIODIC"></a> 
    … …  
    437356       
    438357       
    439       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_periodic is automatically computed by using the first line of glamt</i></font> 
    440        
    441     </h4> 
    442  
    443      
    444        = 0 or 1 to force the manual definition of key_periodic. 
    445  
     358       
     359       
     360    </h4> 
     361 
     362     
    446363     
    447364    <a name="#_computegrid_keyword_PLAIN"></a> 
    … …  
    457374    </h4> 
    458375 
    459      force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
    460        suppress the automatic redefinition of the domain in case of 
    461        x periodicity overlap, y periodicity overlap (ORCA type only) 
    462        and mask border to 0. 
    463  
     376     
    464377     
    465378    <a name="#_computegrid_keyword_SHIFT"></a> 
    … …  
    475388    </h4> 
    476389 
    477      = scalar to force the manual definition of key_shift. By 
    478        default, key_shift is automatically computed according to 
    479        glamboundary (when defined) by using the FIRST LINE of glamt. if 
    480        key_periodic=0 then in any case key_shift = 0. 
    481  
     390     
    482391     
    483392    <a name="#_computegrid_keyword_STRIDE"></a> 
    … …  
    489398       
    490399       
    491       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font> 
    492        
    493     </h4> 
    494  
    495      a 3 elements vector to specify the stride in x, y, z 
    496        direction. The resulting value 
    497        will be stored in the common (cm_4mesh) variable key_stride 
    498  
     400       
     401       
     402    </h4> 
     403 
     404     
    499405     
    500406    <a name="#_computegrid_keyword_FULLCGRID"></a> 
    … …  
    510416    </h4> 
    511417 
    512      activate to specify that you want to compute 
    513        all the parameters of a C grid. Computation of glam[uv], 
    514        gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 
    515        will be add to the default computations 
    516  
     418     
    517419     
    518420    <a name="#_computegrid_keyword_XYINDEX"></a> 
    … …  
    528430    </h4> 
    529431 
    530      activate to specify that the horizontal grid should 
    531        be simply defined by using the index of the points 
    532           (xaxis = findgen(nx) and yaxis = findgen(ny)) 
    533        using this keyword forces key_onearth=0 
    534  
     432     
    535433     
    536434    <a name="#_computegrid_keyword_FBASE2TBASE"></a> 
    … …  
    547445 
    548446     
    549  
    550447     
    551448    <a name="#_computegrid_keyword_STRCALLING"></a> 
    … …  
    556453       
    557454       
    558       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> 
    559        
    560        
    561     </h4> 
    562  
    563      
    564        a string containing the calling command used to 
    565        call computegrid (this is used by xxx.pro) 
    566  
    567  
    568  
     455       
     456       
     457       
     458    </h4> 
     459 
     460     
     461     
     462    <a name="#_computegrid_keyword_ROMSH"></a> 
     463    <h4>ROMSH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     464       
     465       
     466       
     467       
     468       
     469       
     470       
     471       
     472    </h4> 
     473 
     474     
    569475     
    570476    <a name="#_computegrid_keyword__extra"></a> 
    … …  
    580486    </h4> 
    581487 
    582      used to pass your keywords to the created function. 
    583  
    584      
    585      
    586  
    587      
    588     <h3>Version history</h3> 
    589      
    590     <h4>Version</h4> $Id: computegrid.pro 163 2006-08-29 12:59:46Z navarro $ 
    591  
    592     <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    593                       2000-04-20 
    594   Sept 2004, several bug fixs to suit C grid type... 
    595   Aug 2005, rewritte almost everything... 
    596  
    597      
    598  
    599     <h3>Known issues</h3> 
    600      
    601      
    602      
    603     <h4>Restrictions</h4> if the grid has x/y periodicity orverlap and/or if 
    604     the mask has 0 everywhere at the border (like a close sea) and 
    605     if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
    606     ymaxmesh keywords are defined to their default values), we redefine 
    607     xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the 
    608     overlapping part and/or to open the domain (avoid ti be forced 
    609     to use cell_fill = 1). 
    610  
    611  FUV points definition... 
    612  
    613  
    614     <h3>Other attributes</h3> 
    615      
    616      
    617     <h4>Uses routines</h4> cm_4mesh cm_4data cm_4cal 
    618  
     488     
     489     
     490     
     491 
     492     
     493     
     494     
     495     
     496     
     497     
     498 
     499     
     500     
     501     
     502     
     503     
     504 
     505     
     506     
     507     
     508     
    619509     
    620510     
    … …  
    627517     
    628518 
    629     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:17 2006.</font></p> 
     519    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:10 2006.</font></p> 
    630520 
    631521  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/micromeshmask.html

    r168 r177  
    300300     
    301301 
    302     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:17 2006.</font></p> 
     302    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:10 2006.</font></p> 
    303303 
    304304  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/n128gaussian.html

    r168 r177  
    118118     
    119119 
    120     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:17 2006.</font></p> 
     120    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:10 2006.</font></p> 
    121121 
    122122  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/n160gaussian.html

    r168 r177  
    119119     
    120120 
    121     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:17 2006.</font></p> 
     121    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:10 2006.</font></p> 
    122122 
    123123  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/n256gaussian.html

    r168 r177  
    119119     
    120120 
    121     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:18 2006.</font></p> 
     121    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:10 2006.</font></p> 
    122122 
    123123  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/n48gaussian.html

    r168 r177  
    119119     
    120120 
    121     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:18 2006.</font></p> 
     121    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:10 2006.</font></p> 
    122122 
    123123  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/n80gaussian.html

    r168 r177  
    119119     
    120120 
    121     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:18 2006.</font></p> 
     121    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:11 2006.</font></p> 
    122122 
    123123  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/ncdf_meshread.html

    r168 r177  
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href="restoreboxparam.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
     52<a href="ncdf_meshroms.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 
    … …  
    7373</font></h2> 
    7474 
    75       <p><font face="Courier">ncdf_meshread<i>[, <a href="#_ncdf_meshread_keyword_filename">filename</a>]</i>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>GLAMBOUNDARY</i>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<i>CHECKDAT</i>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<i>ONEARTH</i>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<i>GETDIMENSIONS</i>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<i>PERIODIC</i>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<i>SHIFT</i>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<i>STRIDE</i>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<i>string</i>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
     75      <p><font face="Courier">ncdf_meshread<i>[, <a href="#_ncdf_meshread_keyword_filename">filename</a>]</i>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>2 elements vector</i>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<i>CHECKDAT</i>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<i>scalar</i>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<i>3 elements vector</i>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<i>scalar string</i>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
    7676 
    7777     
    … …  
    9191       
    9292       
    93        
    94       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>meshmask.nc</i></font> 
    95        
    96     </h4> 
    97  
    98       
    99     the name of the meshmask file to read.  
    100     if this name does not contain any "/" and if 
    101     iodirectory keyword is not specify, then the common variable 
     93      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     94      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'meshmask.nc'</i></font> 
     95       
     96    </h4> 
     97 
     98     
     99    Name of the meshmask file to read. If this name does not contain any "/" 
     100    and if iodirectory keyword is not specify, then the common variable 
    102101    iodir will be use to define the mesh file path. 
    103102 
    … …  
    116115       
    117116       
    118        
    119        
    120        
    121     </h4> 
    122  
    123      a 2 elements vector, [lon1,lon2], the longitude 
    124     boundaries that should be used to visualize the data. 
     117      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font> 
     118      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>those defined in the file</i></font> 
     119       
     120    </h4> 
     121 
     122     
     123    Longitude boundaries that should be used to visualize the data. 
    125124      lon2 > lon1 
    126125      lon2 - lon1 le 360 
    127     key_shift will be automatically defined according to GLAMBOUNDARY. 
     126    By default, the common (cm_4mesh) variable key_shift will be automatically 
     127    defined according to GLAMBOUNDARY. 
    128128 
    129129     
    … …  
    151151       
    152152       
    153        
    154       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_onearth</i></font> 
    155        
    156     </h4> 
    157  
    158      
    159     = 0 or 1 to force the manual definition of 
    160     key_onearth (to specify if the data are on earth -> use longitude 
    161     /latitude etc...). 
    162     note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is 
    163     cancelling GLAMBOUNDARY 
     153      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     154      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font> 
     155       
     156    </h4> 
     157 
     158     
     159    Force the manual definition of data localization on the earth or not 
     160       0) if the data are not on the earth 
     161       1) if the data are on earth (in that case we can for example use 
     162          the labels 'longitude', 'latitude' in plots). 
     163    The resulting value will be stored in the common (cm_4mesh) variable key_onearth 
     164    ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY 
    164165 
    165166     
    … …  
    171172       
    172173       
    173        
    174        
     174      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     175      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
    175176       
    176177    </h4> 
    … …  
    189190       
    190191       
    191        
    192       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_periodic is automatically     computed by using the first line of glamt</i></font> 
    193        
    194     </h4> 
    195  
    196      
    197     = 0 or 1 to force the manual definition of 
    198     key_periodic. 
     192      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     193      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed by using the first line of glamt</i></font> 
     194       
     195    </h4> 
     196 
     197     
     198    Force the manual definition of the grid zonal periodicity. 
     199    The resulting value will be stored in the common (cm_4mesh) variable key_periodic 
     200    PERIODIC = 0 forces SHIFT = 0 
    199201 
    200202     
    … …  
    206208       
    207209       
    208        
    209       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i> key_shift is automatically computed according to the glamboundary</i></font> 
    210        
    211     </h4> 
    212  
    213      
    214     to force the manual definition of key_shift. By 
    215     default, key_shift is automatically computed according to the 
    216     glamboundary (when defined) by using the first line of glamt. if 
    217     key_periodic=0 then in any case key_shift = 0. 
     210      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     211      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to glamboundary</i></font> 
     212       
     213    </h4> 
     214 
     215     
     216    Force the manual definition of the zonal shift that must be apply to the data.  
     217    The resulting value will be stored in the common (cm_4mesh) variable key_shift 
     218    Note that if key_periodic=0 then in any case key_shift = 0. 
    218219 
    219220     
    … …  
    225226       
    226227       
    227        
    228       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>key_stride</i></font> 
    229        
    230     </h4> 
    231  
    232       
    233     a 3 elements vector to specify the stride in x, y, z direction.  
    234     The resulting value will be stored in the common (cm_4mesh) variable  
    235     key_stride 
     228      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3 elements vector</i></font> 
     229      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font> 
     230       
     231    </h4> 
     232 
     233     
     234    Specify the stride in x, y and z direction. The resulting 
     235    value will be stored in the common (cm_4mesh) variable key_stride 
    236236 
    237237     
    … …  
    243243       
    244244       
    245       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> 
    246        
    247        
    248     </h4> 
    249  
    250      
    251     a string containing the calling command used to call 
    252     computegrid (this is used by xxx.pro) 
     245      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     246       
     247       
     248    </h4> 
     249 
     250     
     251    the calling command used to call computegrid (this is used by xxx.pro) 
    253252 
    254253     
    … …  
    265264    </h4> 
    266265 
    267      used to pass your keywords to the created function. 
     266     used to pass isafile keywords 
    268267 
    269268     
    … …  
    275274    <h3>Version history</h3> 
    276275     
    277     <h4>Version</h4> $Id: ncdf_meshread.pro 163 2006-08-29 12:59:46Z navarro $ 
     276    <h4>Version</h4> $Id: ncdf_meshread.pro 172 2006-09-11 07:11:26Z smasson $ 
    278277 
    279278    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    291290     
    292291     
    293     <h4>Restrictions</h4> define and/or use common variables from 
    294                cm_4mesh, cm_4data, cm_4cal 
    295  
    296  
     292    <h4>Restrictions</h4> 
    297293 
    298294  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must 
    … …  
    316312     
    317313 
    318     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:18 2006.</font></p> 
     314    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:11 2006.</font></p> 
    319315 
    320316  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/restoreboxparam.html

    r168 r177  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="ncdf_meshread.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="ncdf_meshroms.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
    4949    <td width="80%" align="center" valign="center"> 
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href="saveboxparam.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
     52<a href="romsdepth.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 
    … …  
    138138     
    139139 
    140     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:18 2006.</font></p> 
     140    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:11 2006.</font></p> 
    141141 
    142142  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/saveboxparam.html

    r168 r177  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="restoreboxparam.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="romsdepth.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
    4949    <td width="80%" align="center" valign="center"> 
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    … …  
    138138     
    139139 
    140     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:18 2006.</font></p> 
     140    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:11 2006.</font></p> 
    141141 
    142142  </body> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/smallmeshmask.html

    r168 r177  
    305305     
    306306 
    307     <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:27:19 2006.</font></p> 
     307    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:12 2006.</font></p> 
    308308 
    309309  </body> 
Note: See TracChangeset for help on using the changeset viewer.