Ignore:
Timestamp:
01/12/07 12:42:03 (18 years ago)
Author:
smasson
Message:

update documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/angle.html

    r200 r203  
    6464 north stereographic polar projection 
    6565 
    66  Compute angles between grid lines and direction of the North 
     66 Compute angles between grid lines and direction of the North pole 
    6767(fom angle.F,v 2.2 in OPA8.2) 
    6868 
    6969 
    7070     
    71     <h2>Routine summary</h2> 
    72  
    73     <dl> 
    74        
    75       <dt><a href="#_fsnspp"><i>result = </i>fsnspp(<i>plam, pphi</i>, DOUBLE=<i>DOUBLE</i>)</a><dt> 
    76       <dd><font size="-1"></font></dd> 
    77        
    78       <dt><a href="#_angle">angle<i>, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</i>, IODIRECTORY=<i>IODIRECTORY</i>, DOUBLE=<i>DOUBLE</i></a><dt> 
    79       <dd><font size="-1"></font></dd> 
    80        
    81     </dl> 
    82  
    83     <p>&nbsp;</p> 
    84      
    85  
    86        
    87       <a name="#_fsnspp"></a> 
    88  
    89       <h2>fsnspp  <font size="-1" color="#006633">  
     71 
     72       
     73      <a name="#_angle"></a> 
     74 
     75      <h2>angle  <font size="-1" color="#006633">  
    9076 Interpolation 
    9177</font></h2> 
    9278 
    93       <p><font face="Courier"><i>result = </i>fsnspp(<i><a href="#_fsnspp_keyword_plam">plam</a>, <a href="#_fsnspp_keyword_pphi">pphi</a></i>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i>)</font></p> 
    94  
    95      
    96  
    97     <h3>Return value</h3> 
    98        gsinu,gcosu : sinus and cosinus of the angle 
    99        gsinv,gcosv   between north-south direction 
    100        gsint,gcost   and the j-direction of the mesh 
    101  
     79      <p><font face="Courier">angle<i>, <a href="#_angle_keyword_fileocemesh">fileocemesh</a>, <a href="#_angle_keyword_gcosu">gcosu</a>, <a href="#_angle_keyword_gsinu">gsinu</a>, <a href="#_angle_keyword_gcosv">gcosv</a>, <a href="#_angle_keyword_gsinv">gsinv</a>, <a href="#_angle_keyword_gcost">gcost</a>, <a href="#_angle_keyword_gsint">gsint</a></i>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<i>scalar string</i>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<i>1 ou 2</i></font></p> 
     80 
     81     
     82 
     83     
    10284 
    10385     
     
    10587     
    10688 
    107     <a name="#_fsnspp_keyword_plam"></a> 
    108     <h4>plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     89    <a name="#_angle_keyword_fileocemesh"></a> 
     90    <h4>fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10991      <font size="-1" color="#006633">in</font> 
    11092       
     
    11294      <font size="-1" color="#006633">required</font> 
    11395       
    114        
    115        
    116        
    117     </h4> 
    118  
    119      
    120  
    121      
    122  
    123     <a name="#_fsnspp_keyword_pphi"></a> 
    124     <h4>pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    125       <font size="-1" color="#006633">in</font> 
    126        
    127        
    128       <font size="-1" color="#006633">required</font> 
    129        
    130        
    131        
    132        
    133     </h4> 
    134  
    135      
     96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     97       
     98       
     99    </h4> 
     100 
     101     
     102 a netcdf file that contains (at least) the following variables: 
     103        glamu, gphiu: longitudes and latitudes at U-points 
     104        glamv, gphiv: longitudes and latitudes at V-points 
     105        glamf, gphif: longitudes and latitudes at F-points 
     106 
     107     
     108 
     109    <a name="#_angle_keyword_gcosu"></a> 
     110    <h4>gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     111       
     112      <font size="-1" color="#006633">out</font> 
     113       
     114       
     115       
     116      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     117       
     118       
     119    </h4> 
     120 
     121     
     122 cosinus of the angle between grid lines at U points and direction of the North pole 
     123 
     124     
     125 
     126    <a name="#_angle_keyword_gsinu"></a> 
     127    <h4>gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     128       
     129      <font size="-1" color="#006633">out</font> 
     130       
     131       
     132       
     133      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     134       
     135       
     136    </h4> 
     137 
     138     
     139 sinus of the angle between grid lines at U points and direction of the North pole 
     140 
     141     
     142 
     143    <a name="#_angle_keyword_gcosv"></a> 
     144    <h4>gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     145       
     146      <font size="-1" color="#006633">out</font> 
     147       
     148       
     149       
     150      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     151       
     152       
     153    </h4> 
     154 
     155     
     156 cosinus of the angle between grid lines at V points and direction of the North pole 
     157 
     158     
     159 
     160    <a name="#_angle_keyword_gsinv"></a> 
     161    <h4>gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     162       
     163      <font size="-1" color="#006633">out</font> 
     164       
     165       
     166       
     167      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     168       
     169       
     170    </h4> 
     171 
     172     
     173 sinus of the angle between grid lines at V points and direction of the North pole 
     174 
     175     
     176 
     177    <a name="#_angle_keyword_gcost"></a> 
     178    <h4>gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     179       
     180      <font size="-1" color="#006633">out</font> 
     181       
     182       
     183       
     184      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     185       
     186       
     187    </h4> 
     188 
     189     
     190 cosinus of the angle between grid lines at T points and direction of the North pole 
     191 
     192     
     193 
     194    <a name="#_angle_keyword_gsint"></a> 
     195    <h4>gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     196       
     197      <font size="-1" color="#006633">out</font> 
     198       
     199       
     200       
     201      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font> 
     202       
     203       
     204    </h4> 
     205 
     206     
     207 sinus of the angle between grid lines at T points and direction of the North pole 
    136208 
    137209     
     
    142214 
    143215     
    144     <a name="#_fsnspp_keyword_DOUBLE"></a> 
     216    <a name="#_angle_keyword_IODIRECTORY"></a> 
     217    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     218       
     219       
     220       
     221       
     222       
     223      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     224      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>''</i></font> 
     225       
     226    </h4> 
     227 
     228     
     229 the directory path where is located fileocemesh 
     230 
     231     
     232    <a name="#_angle_keyword_DOUBLE"></a> 
    145233    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    146234       
     
    149237       
    150238       
    151        
     239      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1 ou 2</i></font> 
    152240      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
    153241       
     
    155243 
    156244     
    157  use double precision (default is float) 
     245 put 1 to use double precision (default is float) 
    158246 
    159247     
     
    163251    <h3>Version history</h3> 
    164252     
    165     <h4>Version</h4> $Id: angle.pro 157 2006-08-21 09:01:50Z navarro $ 
    166  
     253    <h4>Version</h4> $Id: angle.pro 202 2007-01-12 11:00:06Z smasson $ 
    167254    <h4>History</h4> 
    168255       Original :  96-07 (O. Marti) 
     
    187274 
    188275 
    189  
    190276     
    191277     
     
    199285    <hr size="1" color="#CCCCCC"/> 
    200286       
    201       <a name="#_angle"></a> 
    202  
    203       <h2>angle  </h2> 
    204  
    205       <p><font face="Courier">angle<i>, <a href="#_angle_keyword_fileocemesh">fileocemesh</a>, <a href="#_angle_keyword_gcosu">gcosu</a>, <a href="#_angle_keyword_gsinu">gsinu</a>, <a href="#_angle_keyword_gcosv">gcosv</a>, <a href="#_angle_keyword_gsinv">gsinv</a>, <a href="#_angle_keyword_gcost">gcost</a>, <a href="#_angle_keyword_gsint">gsint</a></i>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i></font></p> 
    206  
    207      
    208  
    209      
    210  
    211      
    212     <h3>Parameters</h3> 
    213      
    214  
    215     <a name="#_angle_keyword_fileocemesh"></a> 
    216     <h4>fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    217       <font size="-1" color="#006633">in</font> 
    218        
    219        
    220       <font size="-1" color="#006633">required</font> 
    221        
    222        
    223        
    224        
    225     </h4> 
    226  
    227      a netcdf file that contains (at least): 
    228         glamu, gphiu: longitudes and latitudes at U-points 
    229         glamv, gphiv: longitudes and latitudes at V-points 
    230         glamf, gphif: longitudes and latitudes at F-points 
    231  
    232      
    233  
    234     <a name="#_angle_keyword_gcosu"></a> 
    235     <h4>gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    236       <font size="-1" color="#006633">in</font> 
    237        
    238        
    239       <font size="-1" color="#006633">required</font> 
    240        
    241        
    242        
    243        
    244     </h4> 
    245  
    246      
    247      
    248  
    249     <a name="#_angle_keyword_gsinu"></a> 
    250     <h4>gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    251       <font size="-1" color="#006633">in</font> 
    252        
    253        
    254       <font size="-1" color="#006633">required</font> 
    255        
    256        
    257        
    258        
    259     </h4> 
    260  
    261      
    262      
    263  
    264     <a name="#_angle_keyword_gcosv"></a> 
    265     <h4>gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    266       <font size="-1" color="#006633">in</font> 
    267        
    268        
    269       <font size="-1" color="#006633">required</font> 
    270        
    271        
    272        
    273        
    274     </h4> 
    275  
    276      
    277      
    278  
    279     <a name="#_angle_keyword_gsinv"></a> 
    280     <h4>gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    281       <font size="-1" color="#006633">in</font> 
    282        
    283        
    284       <font size="-1" color="#006633">required</font> 
    285        
    286        
    287        
    288        
    289     </h4> 
    290  
    291      
    292      
    293  
    294     <a name="#_angle_keyword_gcost"></a> 
    295     <h4>gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    296       <font size="-1" color="#006633">in</font> 
    297        
    298        
    299       <font size="-1" color="#006633">required</font> 
    300        
    301        
    302        
    303        
    304     </h4> 
    305  
    306      
    307      
    308  
    309     <a name="#_angle_keyword_gsint"></a> 
    310     <h4>gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    311       <font size="-1" color="#006633">in</font> 
    312        
    313        
    314       <font size="-1" color="#006633">required</font> 
    315        
    316        
    317        
    318        
    319     </h4> 
    320  
    321      
    322      
    323      
    324  
    325      
    326     <h3>Keywords</h3> 
    327  
    328      
    329     <a name="#_angle_keyword_IODIRECTORY"></a> 
    330     <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    331        
    332        
    333        
    334        
    335        
    336        
    337        
    338        
    339     </h4> 
    340  
    341      the directory path where is located fileocemesh 
    342      
    343     <a name="#_angle_keyword_DOUBLE"></a> 
    344     <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    345        
    346        
    347        
    348        
    349        
    350        
    351       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
    352        
    353     </h4> 
    354  
    355      use double precision (default is float) 
    356      
    357      
    358  
    359      
    360      
    361      
    362      
    363      
    364      
    365  
    366      
    367      
    368      
    369      
    370      
    371  
    372      
    373      
    374      
    375      
    376      
    377      
    378      
    379  
    380     <font size="-3"><p>&nbsp;</p></font> 
    381     <hr size="1" color="#CCCCCC"/> 
    382        
    383287 
    384288     
Note: See TracChangeset for help on using the changeset viewer.