Ignore:
Timestamp:
08/09/06 12:21:11 (18 years ago)
Author:
navarro
Message:

english and nicer header (3b)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/xncdf_lec.html

    r138 r151  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Reading of a Net Cdf file with widgets !  
     700 
     701 
     702 Procedure called by xmanager when we press on a button of a second widget created by wid_var. 
     703  
     704 
     705 This procedure manage the second created whiget when we call xncdf_lec.  
     706 This widget concern the reading of the variable. 
     707 
     708 
     709 Procedure called by xmanager when we press a button of the first widget  
     710 created by par xncdf_lec 
     711 </div> 
    699712 
    700713       
    … …  
    710723        <dl> 
    711724           
     725          <dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">[name]</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">COUNT</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">OFFSET</span>, IODIR=<span class="result">IODIR</span>, SHIFT=<span class="result">SHIFT</span>, STRIDE=<span class="result">STRIDE</span>, VAR=<span class="result">VAR</span>)</a></p><dt> 
     726          <dd> </dd>     
     727           
    712728          <dt><p><a href="#_wid_var_event">wid_var_event<span class="result">, event</span></a></p><dt> 
    713729          <dd></dd>      
    … …  
    718734          <dt><p><a href="#_xncdf_lec_event">xncdf_lec_event<span class="result">, event</span></a></p><dt> 
    719735          <dd></dd>      
    720            
    721           <dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">nom</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">COUNT</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">OFFSET</span>, IODIR=<span class="result">IODIR</span>, SHIFT=<span class="result">SHIFT</span>, STRIDE=<span class="result">STRIDE</span>, VAR=<span class="result">VAR</span>)</a></p><dt> 
    722           <dd>  NAME: xncdf_lec   PURPOSE: lecture d''un fichier Net Cdf avec des widgets !    CATEGORY: lecture de fichiers avec widgets   CALLING SEQUENCE: res=xncdf_lec([nom_fichier])    INPUTS:        OPTIONNEL, nom_fichier: c''est un string qui donne le nom du        fichier a ouvrir.</dd>  
    723736                 
    724737        </dl> 
    … …  
    729742         
    730743 
     744        <div class="routine_details" id="_xncdf_lec"> 
     745 
     746          <h2><a class="top" href="#container">top</a>xncdf_lec <span class="categories">  
     747 widget 
     748</span></h2> 
     749         
     750          <p class="header"> 
     751            <span class="result">result = </span>xncdf_lec(<span class="result">[<a href="#_xncdf_lec_param_name">name</a>]</span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">COUNT</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p> 
     752         
     753          <div class="comments"> 
     754</div> 
     755 
     756          <h3>Return value</h3><div class="preformat"> 
     757  2 different cases: 
     758       1) None attribute has been selected. In this case, res is the array we 
     759       wanted to read. 
     760       2) Some attributes has been selected. In this case, res is a structure  
     761       whose the first element having the name of the variable is the values  
     762       array and the other arguments are the select arguments. 
     763</div> 
     764 
     765           
     766            <h3>Parameters</h3> 
     767         
     768             
     769            <h4 id="_xncdf_lec_param_name">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     770              <span class="attr">in</span> 
     771               
     772              <span class="attr">optional</span> 
     773               
     774               
     775               
     776               
     777               
     778            </h4> 
     779         
     780          <div class="comments"> 
     781 It is a string giving the name of the file to be opened. If NAME  
     782 does not contain the separating character of directories ('/' under  
     783 unix for example), the file will be looked for in the current directory. 
     784</div> 
     785             
     786 
     787           
     788 
     789           
     790 
     791            <h3>Keywords</h3> 
     792             
     793            <h4 id="_xncdf_lec_keyword_ATT">ATT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     794               
     795               
     796               
     797               
     798               
     799               
     800               
     801               
     802            </h4> 
     803         
     804            <div class="comments"></div> 
     805             
     806            <h4 id="_xncdf_lec_keyword_COUNT">COUNT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     807               
     808               
     809               
     810               
     811               
     812               
     813               
     814               
     815            </h4> 
     816         
     817            <div class="comments"> 
     818 An optional vector containing the counts to be used in 
     819 reading Value. COUNT is a 1-based vector with an element for 
     820 each dimension of the data to be written.The default matches 
     821 the size of the variable so that all data is written out. 
     822</div> 
     823             
     824            <h4 id="_xncdf_lec_keyword_GROUP">GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     825               
     826               
     827               
     828               
     829               
     830               
     831               
     832               
     833            </h4> 
     834         
     835            <div class="comments"> 
     836 The widget ID of the widget that calls XNCDF_LEC. When 
     837 this ID is specified, a death of the caller results in a death 
     838 of XNCDF_LEC.  
     839</div> 
     840             
     841            <h4 id="_xncdf_lec_keyword_OFFSET">OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     842               
     843               
     844               
     845               
     846               
     847               
     848               
     849               
     850            </h4> 
     851         
     852            <div class="comments"> 
     853 An optional vector containing the starting position 
     854 for the read. The default start position is [0, 0, ...]. 
     855</div> 
     856             
     857            <h4 id="_xncdf_lec_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     858               
     859               
     860               
     861               
     862               
     863               
     864               
     865               
     866            </h4> 
     867         
     868            <div class="comments"> 
     869 It is a string containing the directory where to go look for the file to be read. 
     870 If NAME does not contain the separating character of directories ('/' under  
     871 unix for example), the file will be called iodir+nom_fichier. 
     872</div> 
     873             
     874            <h4 id="_xncdf_lec_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     875               
     876               
     877               
     878               
     879               
     880               
     881               
     882               
     883            </h4> 
     884         
     885            <div class="comments"> 
     886 A vector of integers, specifing for each dimension how much we have to shift it.  
     887 By default, it is [0,0,...]. See the function shift for more explanations. BEWARE,  
     888 the shift is done on the biggest array before a possible reduction determinated  
     889 by OFFSET and COUNT. On the other hand, it is done after the possible extraction  
     890 created by the STRIDE. 
     891</div> 
     892             
     893            <h4 id="_xncdf_lec_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     894               
     895               
     896               
     897               
     898               
     899               
     900               
     901               
     902            </h4> 
     903         
     904            <div class="comments"> 
     905 An optional vector containing the strides, or sampling 
     906 intervals, between accessed values of the netCDF variable. The 
     907 default stride vector is that for a contiguous read, [1, 1,...]. 
     908</div> 
     909             
     910            <h4 id="_xncdf_lec_keyword_VAR">VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     911               
     912               
     913               
     914               
     915               
     916               
     917               
     918               
     919            </h4> 
     920         
     921            <div class="comments"></div> 
     922             
     923           
     924 
     925          <h3>Examples</h3><div class="preformat"> 
     926 help, xncdf_lec() 
     927</div> 
     928          <h3>Version history</h3> 
     929           
     930          <h4>Version</h4><div class="preformat"> 
     931 $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     932          <h4>History</h4><div class="preformat"></div> 
     933           
     934           
     935           
     936           
     937           
     938           
     939           
     940         
     941          <h3>Other attributes</h3> 
     942           
     943           
     944          <h4>Uses routines</h4><div class="preformat"> 
     945 wididbase, infovariable, resultat, motcle 
     946</div> 
     947           
     948           
     949          <h4>Common blocks used</h4><div class="preformat">wididbase 
     950infovariable 
     951resultat 
     952motcle</div> 
     953         
     954           
     955         
     956        </div> 
     957         
     958 
    731959        <div class="routine_details" id="_wid_var_event"> 
    732960 
    … …  
    745973             
    746974            <h4 id="_wid_var_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    747                
    748                
    749                
    750                
     975              <span class="attr">in</span> 
     976               
     977               
     978              <span class="attr">required</span> 
    751979               
    752980               
    … …  
    755983            </h4> 
    756984         
    757           <div class="comments"></div> 
    758              
    759  
    760            
    761  
    762            
    763  
    764            
    765            
    766            
    767            
     985          <div class="comments"> 
     986 A structure caracterizing the type of event which arrive to a widget number1 2 
     987</div> 
     988             
     989 
     990           
     991 
     992           
     993 
     994           
     995          <h3>Version history</h3> 
     996           
     997          <h4>Version</h4><div class="preformat"> 
     998 $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
    768999           
    7691000           
    … …  
    7781009           
    7791010           
    780            
     1011          <h4>Uses routines</h4><div class="preformat"> 
     1012 wididbase,resultat,infovariable,indicewid,motcle 
     1013 </div> 
    7811014           
    7821015           
    … …  
    8081041             
    8091042            <h4 id="_wid_var_param_widid_pere">widid_pere&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    810                
    811                
    812                
    813                
     1043              <span class="attr">in</span> 
     1044               
     1045               
     1046              <span class="attr">required</span> 
    8141047               
    8151048               
    … …  
    8181051            </h4> 
    8191052         
    820           <div class="comments"></div> 
    821              
    822  
    823            
    824  
    825            
    826  
    827            
    828            
    829            
    830            
     1053          <div class="comments"> 
     1054 It is a scalar containing the identity of the father widget which was  
     1055 created by xncdf_lec and which has allowed to select the variable to be read. 
     1056 
     1057 OUTPUTS: indirectement res (le tableau ou la structure resultat) 
     1058</div> 
     1059             
     1060 
     1061           
     1062 
     1063           
     1064 
     1065           
     1066          <h3>Version history</h3> 
     1067           
     1068          <h4>Version</h4><div class="preformat"> 
     1069 $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
    8311070           
    8321071           
    … …  
    8411080           
    8421081           
    843            
     1082          <h4>Uses routines</h4><div class="preformat">  
     1083 resultat,infovariable,indicewid_var,motcle 
     1084</div> 
    8441085           
    8451086           
    … …  
    8801121            </h4> 
    8811122         
    882           <div class="comments"></div> 
    883              
    884  
    885            
    886  
    887            
    888  
    889            
    890            
    891            
    892            
     1123          <div class="comments"> 
     1124 A structure caracterising the event type which arrive at the widget number 1. 
     1125</div> 
     1126             
     1127 
     1128           
     1129 
     1130           
     1131 
     1132           
     1133          <h3>Version history</h3> 
     1134           
     1135          <h4>Version</h4><div class="preformat"> 
     1136 $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
    8931137           
    8941138           
    … …  
    9031147           
    9041148           
    905            
     1149          <h4>Uses routines</h4><div class="preformat"> 
     1150 resultat, infovariable, motcle 
     1151</div> 
    9061152           
    9071153           
    … …  
    9141160        </div> 
    9151161         
    916  
    917         <div class="routine_details" id="_xncdf_lec"> 
    918  
    919           <h2><a class="top" href="#container">top</a>xncdf_lec </h2> 
    920          
    921           <p class="header"> 
    922             <span class="result">result = </span>xncdf_lec(<span class="result"><a href="#_xncdf_lec_param_nom">nom</a></span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">COUNT</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p> 
    923          
    924           <div class="comments"> 
    925  NAME: xncdf_lec 
    926  
    927  PURPOSE: lecture d''un fichier Net Cdf avec des widgets !  
    928  
    929  CATEGORY: lecture de fichiers avec widgets 
    930  
    931  CALLING SEQUENCE: res=xncdf_lec([nom_fichier]) 
    932   
    933  INPUTS:  
    934       OPTIONNEL, nom_fichier: c''est un string qui donne le nom du 
    935        fichier a ouvrir.Si nomfichier ne contient pas le caractere 
    936        separateur de repertoirte ('/' sous unix par ex), Le fichier 
    937        sera cherche ds le repertoire courant 
    938  
    939  KEYWORD PARAMETERS: 
    940  
    941        IODIR: string contenant le repertoire ou aller chercher le 
    942        fichier a lire. Si nomfichier ne contient pas le caractere 
    943        separateur de repertoirte ('/' sous unix par ex), Le fichier 
    944        cherche s''appelera iodir+nom_fichier. 
    945  
    946        COUNT: An optional vector containing the counts to be used in 
    947        reading Value. COUNT is a 1-based vector with an element for 
    948        each dimension of the data to be written.The default matches 
    949        the size of the variable so that all data is written out. 
    950  
    951        GROUP: The widget ID of the widget that calls XNCDF_LEC. When 
    952        this ID is specified, a death of the caller results in a death 
    953        of XNCDF_LEC.  
    954  
    955        OFFSET: An optional vector containing the starting position 
    956        for the read. The default start position is [0, 0, ...]. 
    957  
    958        SHIFT: un vecteur d''entiers, specifiant pour chaque dimension 
    959        de combien il faut la shifter. Par defaut c''est 
    960        [0,0,...]. cf. la fonction shift pour + 
    961        d''explications. ATTENTION, le shift est effectue sur le 
    962        tableau de taille maximum avant la reduction eventuelle 
    963        determinee par OFFSET et COUNT. Par contre il est effectue 
    964        apres l''extraction eventuelle cree par le STRIDE. 
    965  
    966        STRIDE: An optional vector containing the strides, or sampling 
    967        intervals, between accessed values of the netCDF variable. The 
    968        default stride vector is that for a contiguous read, [1, 1, 
    969        ...]. 
    970  
    971  OUTPUTS: 2 cas possibles: 
    972        1) aucun attributs n''a ete selectionne. Dans ce cas res est 
    973        le tableau que l''on voulait lire. 
    974        2) Des attributs ont ete selectionnes. Dans ce cas res est une 
    975        structre dont le premier element portant le nom de la variable 
    976        est le tableau de valeurs et les autre auguments sont les 
    977        arguments selectiones 
    978  
    979  COMMON BLOCKS: wididbase, infovariable, resultat, motcle 
    980  
    981  SIDE EFFECTS: 
    982  
    983  RESTRICTIONS: 
    984  
    985  EXAMPLE: help, xncdf_lec() 
    986 </div> 
    987  
    988            
    989  
    990            
    991             <h3>Parameters</h3> 
    992          
    993              
    994             <h4 id="_xncdf_lec_param_nom">nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    995                
    996                
    997                
    998                
    999                
    1000                
    1001                
    1002                
    1003             </h4> 
    1004          
    1005           <div class="comments"></div> 
    1006              
    1007  
    1008            
    1009  
    1010            
    1011  
    1012             <h3>Keywords</h3> 
    1013              
    1014             <h4 id="_xncdf_lec_keyword_ATT">ATT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1015                
    1016                
    1017                
    1018                
    1019                
    1020                
    1021                
    1022                
    1023             </h4> 
    1024          
    1025             <div class="comments"></div> 
    1026              
    1027             <h4 id="_xncdf_lec_keyword_COUNT">COUNT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1028                
    1029                
    1030                
    1031                
    1032                
    1033                
    1034                
    1035                
    1036             </h4> 
    1037          
    1038             <div class="comments"></div> 
    1039              
    1040             <h4 id="_xncdf_lec_keyword_GROUP">GROUP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1041                
    1042                
    1043                
    1044                
    1045                
    1046                
    1047                
    1048                
    1049             </h4> 
    1050          
    1051             <div class="comments"></div> 
    1052              
    1053             <h4 id="_xncdf_lec_keyword_OFFSET">OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1054                
    1055                
    1056                
    1057                
    1058                
    1059                
    1060                
    1061                
    1062             </h4> 
    1063          
    1064             <div class="comments"></div> 
    1065              
    1066             <h4 id="_xncdf_lec_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1067                
    1068                
    1069                
    1070                
    1071                
    1072                
    1073                
    1074                
    1075             </h4> 
    1076          
    1077             <div class="comments"></div> 
    1078              
    1079             <h4 id="_xncdf_lec_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1080                
    1081                
    1082                
    1083                
    1084                
    1085                
    1086                
    1087                
    1088             </h4> 
    1089          
    1090             <div class="comments"></div> 
    1091              
    1092             <h4 id="_xncdf_lec_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1093                
    1094                
    1095                
    1096                
    1097                
    1098                
    1099                
    1100                
    1101             </h4> 
    1102          
    1103             <div class="comments"></div> 
    1104              
    1105             <h4 id="_xncdf_lec_keyword_VAR">VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1106                
    1107                
    1108                
    1109                
    1110                
    1111                
    1112                
    1113                
    1114             </h4> 
    1115          
    1116             <div class="comments"></div> 
    1117              
    1118            
    1119  
    1120            
    1121            
    1122            
    1123            
    1124            
    1125            
    1126            
    1127            
    1128            
    1129            
    1130            
    1131            
    1132          
    1133           <h3>Other attributes</h3> 
    1134            
    1135            
    1136            
    1137            
    1138            
    1139           <h4>Common blocks used</h4><div class="preformat">wididbase 
    1140 infovariable 
    1141 resultat 
    1142 motcle</div> 
    1143          
    1144            
    1145          
    1146         </div> 
    1147          
    11481162      </div> 
    11491163 
Note: See TracChangeset for help on using the changeset viewer.