Ignore:
Timestamp:
06/09/06 17:18:59 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Obsolete *.pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Obsolete/lec.html

    r89 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90       lit les fichiers Vairmer en sort: 
     91un tableau 2d ou 3d en fonction de nomchamp qui est le nom 
     92du champ a extaire (2d s'il commence par SO et 3d s'il commence par VO) 
     93cette fonction modifie aussi les variables globales: 
     94varname: trois lettres: nom de l'experience 
     95vargrid: nom de la grille 
     96vardate: date (yy)yymmdd 
     97varexp: nom Vairmer du champ a tarcer 
     98</div> 
    9099 
    91100       
     
    102111        <div class="routine_details" id="_lec"> 
    103112 
    104           <h2><a class="top" href="#container">top</a>lec </h2> 
     113          <h2><a class="top" href="#container">top</a>lec <span class="warning">obsolete</span> <span class="categories"> Graphics, lecture de fichier Vaimer 
     114</span></h2> 
    105115         
    106116          <p class="header"> 
    107             <span class="result">result = </span>lec(<span class="result"><a href="#_lec_param_nomchamp">nomchamp</a>, <a href="#_lec_param_date">date</a>, <a href="#_lec_param_nomexp">nomexp</a></span>, <a href="#_lec_keyword_ECRIT">ECRIT</a>=<span class="result">ECRIT</span>, <a href="#_lec_keyword_ANOM">ANOM</a>=<span class="result">ANOM</span>, <a href="#_lec_keyword_BOITE">BOITE</a>=<span class="result">BOITE</span>, <a href="#_lec_keyword_EXPANOM">EXPANOM</a>=<span class="result">EXPANOM</span>, <a href="#_lec_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_lec_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_lec_keyword_NAME">NAME</a>=<span class="result">NAME</span>, <a href="#_lec_keyword_filename">filename</a>=<span class="result">filename</span>)</p> 
    108          
    109           <div class="comments"> 
    110  NAME:lec 
    111     
    112  
    113  PURPOSE: 
    114        lit les fichiers Vairmer en sort: 
    115                 un tableau 2d ou 3d en fonction de nomchamp qui est le nom 
    116  du champ a extaire (2d s'il commence par SO et 3d s'il commence par VO) 
    117         cette fonction modifie aussi les variables globales: 
    118                 varname: trois lettres: nom de l'experience 
    119                 vargrid: nom de la grille 
    120                 vardate: date (yy)yymmdd 
    121                 varexp: nom Vairmer du champ a tarcer 
    122  
    123  CATEGORY: 
    124        Graphics, lecture de fichier Vaimer 
    125  
    126  CALLING SEQUENCE: 
    127         resultat=lec('nom_Vairmer'[,date[,'nom_experience']]) 
    128  
    129  INPUTS: 
    130         nom_Vairmer: 2 choix possibles: 
     117            <span class="result">result = </span>lec(<span class="result"><a href="#_lec_param_nomchamp">nomchamp</a>[, <a href="#_lec_param_date">date</a>][, <a href="#_lec_param_nomexp">nomexp</a>]</span>, <a href="#_lec_keyword_ECRIT">ECRIT</a>=<span class="result">ECRIT</span>, <a href="#_lec_keyword_ANOM">ANOM</a>=<span class="result">ANOM</span>, <a href="#_lec_keyword_BOITE">BOITE</a>=<span class="result">BOITE</span>, <a href="#_lec_keyword_EXPANOM">EXPANOM</a>=<span class="result">EXPANOM</span>, <a href="#_lec_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_lec_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_lec_keyword_NAME">NAME</a>=<span class="result">NAME</span>, <a href="#_lec_keyword_filename">filename</a>=<span class="result">filename</span>)</p> 
     118         
     119          <div class="comments"></div> 
     120 
     121          <h3>Return value</h3><div class="value"> un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est 
     122 celle du sous domaine definit par domdef (nx,ny,nz). avec /TOUT le 
     123 champ a la taille du  domaine qui a etait selectionne pour la 
     124 cession en cours (jpi,jpj,jpk).  
     125 pour les sous domaines cf:   
     126        http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html 
     127 Retourne -1 en cas d'erreur. 
     128</div> 
     129 
     130           
     131            <h3>Parameters</h3> 
     132         
     133             
     134            <h4 id="_lec_param_nomchamp">nomchamp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     135              <span class="attr">in</span> 
     136               
     137               
     138              <span class="attr">required</span> 
     139               
     140               
     141               
     142               
     143            </h4> 
     144         
     145          <div class="comments"> 2 choix possibles: 
    131146             1) nom de champ Vairmer (chaine de 8 caracteres en majuscule ou  
    132147 minuscule commencant par vo ou so). Dans cette methode on saute directement 
     
    135150 numero de champ a aller chercher (par ex 'vo5'). Cette methode est un peu 
    136151 plus rapide car elle va directement chercher le fichier qui nous interesse. 
    137  
    138         arguments optionnels: 
    139          
    140         date:nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507) 
    141         nom_experience:trois lettres designant le nom de l'experience 
    142  
    143  KEYWORD PARAMETERS: 
    144  
    145        /ANOM:type du fichier vairmer par rapport auquel on doit calculer  
    146              l'anomalie ('EX','AN','SE','MO','') 
    147  
    148         /ECRIT:permet d'imprimer tous les noms vairmer que contient le fichier. 
     152</div> 
     153             
     154            <h4 id="_lec_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     155              <span class="attr">in</span> 
     156               
     157              <span class="attr">optional</span> 
     158               
     159               
     160               
     161               
     162               
     163            </h4> 
     164         
     165          <div class="comments"> nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)</div> 
     166             
     167            <h4 id="_lec_param_nomexp">nomexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     168              <span class="attr">in</span> 
     169               
     170              <span class="attr">optional</span> 
     171               
     172               
     173               
     174               
     175               
     176            </h4> 
     177         
     178          <div class="comments"> trois lettres designant le nom de l'experience 
     179 
     180</div> 
     181             
     182 
     183           
     184 
     185           
     186 
     187            <h3>Keywords</h3> 
     188             
     189            <h4 id="_lec_keyword_ECRIT">ECRIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     190              <span class="attr">in</span> 
     191               
     192               
     193               
     194               
     195               
     196               
     197               
     198            </h4> 
     199         
     200            <div class="comments"> permet d'imprimer tous les noms vairmer que contient le fichier. 
    149201 ds ce cas en input on met seulement 'vo' ou 'so' la fonction retourne le 
    150202 nombre de fichiers lus. 
    151  
    152        /EXPANOM: si on calcule l'anom par rapport a une exper 
     203</div> 
     204             
     205            <h4 id="_lec_keyword_ANOM">ANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     206              <span class="attr">in</span> 
     207               
     208               
     209               
     210               
     211               
     212               
     213               
     214            </h4> 
     215         
     216            <div class="comments"> type du fichier vairmer par rapport auquel on doit calculer  
     217             l'anomalie ('EX','AN','SE','MO','') 
     218</div> 
     219             
     220            <h4 id="_lec_keyword_BOITE">BOITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     221               
     222               
     223               
     224               
     225               
     226               
     227               
     228               
     229            </h4> 
     230         
     231            <div class="comments"></div> 
     232             
     233            <h4 id="_lec_keyword_EXPANOM">EXPANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     234              <span class="attr">in</span> 
     235               
     236               
     237               
     238               
     239               
     240               
     241               
     242            </h4> 
     243         
     244            <div class="comments"> si on calcule l'anom par rapport a une exper 
    153245       differente 
    154  
    155        FILENAME: string pour passer directement le nom du champ sans 
     246</div> 
     247             
     248            <h4 id="_lec_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     249               
     250               
     251               
     252               
     253               
     254               
     255               
     256               
     257            </h4> 
     258         
     259            <div class="comments">  oblige lec a lire le champ sur tout le domaine qui a 
     260       etait selectionne pour la cession en cours (jpi,jpj,jpk) 
     261</div> 
     262             
     263            <h4 id="_lec_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     264               
     265               
     266               
     267               
     268               
     269               
     270               
     271               
     272            </h4> 
     273         
     274            <div class="comments"> lorsque ce mot clef est active, lec retourne la liste 
     275       des types de grilles (T, U...) auxquelles se rapportent les 
     276       variables. ds ce cas en input on met seulement 'vo' ou 'so'. 
     277</div> 
     278             
     279            <h4 id="_lec_keyword_NAME">NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     280               
     281               
     282               
     283               
     284               
     285               
     286               
     287               
     288            </h4> 
     289         
     290            <div class="comments"> lorsque ce mot clef est active, lec retourne la liste 
     291       des noms des variables. ds ce cas en input on met seulement 
     292       'vo' ou 'so'. 
     293</div> 
     294             
     295            <h4 id="_lec_keyword_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     296               
     297               
     298               
     299               
     300               
     301               
     302               
     303               
     304            </h4> 
     305         
     306            <div class="comments"> string pour passer directement le nom du champ sans 
    156307       utiliser les inputs: nom_Vairmer',date,'nom_experience'. Rq si 
    157308       ces inputs sont qd meme donnes ils ne sont pas modifies par 
    158309       filename. 
    159  
    160        /GRID:lorsque ce mot clef est active, lec retourne la liste 
    161        des types de grilles (T, U...) auxquelles se rapportent les 
    162        variables. ds ce cas en input on met seulement 'vo' ou 'so'. 
    163  
    164        /NAME:lorsque ce mot clef est active, lec retourne la liste 
    165        des noms des variables. ds ce cas en input on met seulement 
    166        'vo' ou 'so'. 
    167  
    168        /TOUT: oblige lec a lire le champ sur tout le domaine qui a 
    169        etait selectionne pour la cession en cours (jpi,jpj,jpk) 
    170  
    171  OUTPUTS: un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est 
    172  celle du sous domaine definit par domdef (nx,ny,nz). avec /TOUT le 
    173  champ a la taille du  domaine qui a etait selectionne pour la 
    174  cession en cours (jpi,jpj,jpk).  
    175  pour les sous domaines cf:   
    176         http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html 
    177  
    178  COMMON BLOCKS: 
    179        common.pro          isnumber.pro         fivardate.pro   
    180  
    181  SIDE EFFECTS:Retourne -1 en cas d'erreur. 
    182  
    183  RESTRICTIONS: 
    184  
    185  EXAMPLE: 
    186 </div> 
    187  
    188            
    189  
    190            
    191             <h3>Parameters</h3> 
    192          
    193              
    194             <h4 id="_lec_param_nomchamp">nomchamp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    195                
    196                
    197                
    198                
    199                
    200                
    201                
    202                
    203             </h4> 
    204          
    205           <div class="comments"></div> 
    206              
    207             <h4 id="_lec_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    208                
    209                
    210                
    211                
    212                
    213                
    214                
    215                
    216             </h4> 
    217          
    218           <div class="comments"></div> 
    219              
    220             <h4 id="_lec_param_nomexp">nomexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    221                
    222                
    223                
    224                
    225                
    226                
    227                
    228                
    229             </h4> 
    230          
    231           <div class="comments"></div> 
    232              
    233  
    234            
    235  
    236            
    237  
    238             <h3>Keywords</h3> 
    239              
    240             <h4 id="_lec_keyword_ECRIT">ECRIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248                
    249             </h4> 
    250          
    251             <div class="comments"></div> 
    252              
    253             <h4 id="_lec_keyword_ANOM">ANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    254                
    255                
    256                
    257                
    258                
    259                
    260                
    261                
    262             </h4> 
    263          
    264             <div class="comments"></div> 
    265              
    266             <h4 id="_lec_keyword_BOITE">BOITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    267                
    268                
    269                
    270                
    271                
    272                
    273                
    274                
    275             </h4> 
    276          
    277             <div class="comments"></div> 
    278              
    279             <h4 id="_lec_keyword_EXPANOM">EXPANOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    280                
    281                
    282                
    283                
    284                
    285                
    286                
    287                
    288             </h4> 
    289          
    290             <div class="comments"></div> 
    291              
    292             <h4 id="_lec_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    293                
    294                
    295                
    296                
    297                
    298                
    299                
    300                
    301             </h4> 
    302          
    303             <div class="comments"></div> 
    304              
    305             <h4 id="_lec_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    306                
    307                
    308                
    309                
    310                
    311                
    312                
    313                
    314             </h4> 
    315          
    316             <div class="comments"></div> 
    317              
    318             <h4 id="_lec_keyword_NAME">NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    319                
    320                
    321                
    322                
    323                
    324                
    325                
    326                
    327             </h4> 
    328          
    329             <div class="comments"></div> 
    330              
    331             <h4 id="_lec_keyword_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    332                
    333                
    334                
    335                
    336                
    337                
    338                
    339                
    340             </h4> 
    341          
    342             <div class="comments"></div> 
    343              
    344            
    345  
    346            
    347            
    348            
    349            
    350            
    351            
    352            
    353            
    354            
    355            
    356            
    357            
    358          
    359            
    360            
    361            
    362            
     310</div> 
     311             
     312           
     313 
     314          <h3>Examples</h3><div class="value"> 
     315 IDL>resultat=lec('nom_Vairmer'[,date[,'nom_experience']]) 
     316</div> 
     317          <h3>Version history</h3> 
     318           
     319           
     320          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     321                        26/5/98 
     322                       Jerome Vialard : adaptation au format vairmer 
     323                                        keyword anom et expanom 
     324                        1/7/98 
     325                       Sebastien Masson (masque des terres) 
     326                        14/8/98 
     327                       Sebastien Masson (decoupe pour les sous domaines...) 
     328                        2/99 
     329;-</div> 
     330           
     331           
     332          <h3>Known issues</h3> 
     333          <h4>Obsolete</h4><div class="value"></div> 
     334           
     335           
     336           
     337         
     338          <h3>Other attributes</h3> 
     339           
     340           
     341          <h4>Uses routines</h4><div class="value"> common.pro isnumber.pro fivardate.pro   
     342</div> 
    363343           
    364344           
Note: See TracChangeset for help on using the changeset viewer.