Ignore:
Timestamp:
07/21/06 14:47:49 (18 years ago)
Author:
navarro
Message:

english and nicer header (2a)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/vecteur.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Trace vectors (even if they are on a deformed grid) on any projection. 
     700 In this way, all vectors have a comparable norme on the drawing (to be 
     701 clear, a vector which measure 1 cm measure it, no matter the projection 
     702 and is position on the sphere). 
     703</div> 
    699704 
    700705       
    … …  
    711716           
    712717          <dt><p><a href="#_cv_cm2normal"><span class="result">result = </span>cv_cm2normal(<span class="result">angle</span>)</a></p><dt> 
    713           <dd>  NAME:vecteur   PURPOSE: trace des vecteurs (meme situees sur une grille tordue) sur  n''importe quelle projection, de telle sorte que tous les vecteurs  aient une norme comparable sur le dessin (en clair, un vecteur qui  doit faire 1cm le fait quelque soit la projection et sa position sur  la sphere)    CATEGORY:trace de vecteur   CALLING SEQUENCE:vecteur, composanteu, composantev, normevecteur, indice2d, reduitindice2d    INPUTS: COMPOSANTEU et COMPOSANTEV: ce sont les composantes des  vecteurs a tracer.</dd>      
     718          <dd></dd>      
    714719           
    715720          <dt><p><a href="#_normalise">normalise<span class="result">, u, v, w</span></a></p><dt> 
    … …  
    717722           
    718723          <dt><p><a href="#_vecteur">vecteur<span class="result">, composanteu, composantev, normevecteur, indice2d, reduitindice2d</span>, CMREF=<span class="result">CMREF</span>, MISSING=<span class="result">MISSING</span>, NORMEREF=<span class="result">NORMEREF</span>, VECTCOLOR=<span class="result">VECTCOLOR</span>, VECTTHICK=<span class="result">VECTTHICK</span>, VECTREFPOS=<span class="result">VECTREFPOS</span>, VECTREFFORMAT=<span class="result">VECTREFFORMAT</span>, NOVECTREF=<span class="result">NOVECTREF</span>, _extra=<span class="result">_extra</span></a></p><dt> 
    719           <dd></dd>      
     724          <dd> </dd>     
    720725                 
    721726        </dl> 
    … …  
    733738            <span class="result">result = </span>cv_cm2normal(<span class="result"><a href="#_cv_cm2normal_param_angle">angle</a></span>)</p> 
    734739         
    735           <div class="comments"> 
    736  NAME:vecteur 
    737  
    738  PURPOSE: trace des vecteurs (meme situees sur une grille tordue) sur 
    739  n''importe quelle projection, de telle sorte que tous les vecteurs 
    740  aient une norme comparable sur le dessin (en clair, un vecteur qui 
    741  doit faire 1cm le fait quelque soit la projection et sa position sur 
    742  la sphere)  
    743  
    744  CATEGORY:trace de vecteur 
    745  
    746  CALLING SEQUENCE:vecteur, composanteu, composantev, normevecteur, indice2d, reduitindice2d 
    747   
    748  INPUTS: COMPOSANTEU et COMPOSANTEV: ce sont les composantes des 
    749  vecteurs a tracer. Ces tableaux 2d ont la meme dimension que 
    750  reduitindice2d (cf apres). 
    751        INDICE2D: indice permettant de passer d''un tableau jpi,jpj au 
    752        zoom surlequel on fait le dessin. 
    753        REDUITINDICE2D: indice permettant de passer d''un tableau 
    754        definit par indice2d au tableau pourlequel on a reelement des 
    755        vecteurs a tracer (en clair: c''est par ex qd on ne trace par exemple 
    756        que un vecteur sur 2) 
    757  
    758  KEYWORD PARAMETERS: 
    759  
    760       CMREF: la longeur en cm sur le papier que diot faire la fleche 
    761       de norme normeref. par defaut ajuste au dessin et compris entre 
    762       .5 et 1.5 cm 
    763  
    764       MISSING: la valeur d''une missing value. ne pas utilisder ce 
    765       mot cle. fixe a 1e5 par ajoutvect.pro 
    766        
    767       NORMEREF: la norme de la fleche de reference. par defaut on 
    768       essaie de faire qqch qui colle pas trop mal! 
    769  
    770       VECTCOLOR: la couleur de la fleche. Par defaut noir (couleur 0) 
    771  
    772       VECTTHICK; l''epaissuer de la fleche. par defaut 1. 
    773  
    774       VECTREFPOS: vecteur de 2 elements specifiant la position en 
    775       coordonnees DATA du debut du vecteur de reference. Par defaut 
    776       en bas a droite du dessin. 
    777  
    778       VECTREFFORMAT: format a utiliser pour specifier la norme du 
    779       vecteur de reference. 
    780  
    781       /NOVECTREF: pour supprimer l'affichage du vecteur de reference. 
    782  
    783  OUTPUTS: 
    784  
    785  COMMON BLOCKS:common.pro 
    786  
    787  SIDE EFFECTS: 
    788  
    789  RESTRICTIONS: 
    790  
    791  EXAMPLE: 
    792  
    793  MODIFICATION HISTORY:</div> 
     740          <div class="comments"></div> 
    794741 
    795742           
    … …  
    930877        <div class="routine_details" id="_vecteur"> 
    931878 
    932           <h2><a class="top" href="#container">top</a>vecteur </h2> 
     879          <h2><a class="top" href="#container">top</a>vecteur <span class="categories">  
     880 graphic 
     881 </span></h2> 
    933882         
    934883          <p class="header"> 
    935884            vecteur<span class="result">, <a href="#_vecteur_param_composanteu">composanteu</a>, <a href="#_vecteur_param_composantev">composantev</a>, <a href="#_vecteur_param_normevecteur">normevecteur</a>, <a href="#_vecteur_param_indice2d">indice2d</a>, <a href="#_vecteur_param_reduitindice2d">reduitindice2d</a></span>, <a href="#_vecteur_keyword_CMREF">CMREF</a>=<span class="result">CMREF</span>, <a href="#_vecteur_keyword_MISSING">MISSING</a>=<span class="result">MISSING</span>, <a href="#_vecteur_keyword_NORMEREF">NORMEREF</a>=<span class="result">NORMEREF</span>, <a href="#_vecteur_keyword_VECTCOLOR">VECTCOLOR</a>=<span class="result">VECTCOLOR</span>, <a href="#_vecteur_keyword_VECTTHICK">VECTTHICK</a>=<span class="result">VECTTHICK</span>, <a href="#_vecteur_keyword_VECTREFPOS">VECTREFPOS</a>=<span class="result">VECTREFPOS</span>, <a href="#_vecteur_keyword_VECTREFFORMAT">VECTREFFORMAT</a>=<span class="result">VECTREFFORMAT</span>, <a href="#_vecteur_keyword_NOVECTREF">NOVECTREF</a>=<span class="result">NOVECTREF</span>, <a href="#_vecteur_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    936885         
     886          <div class="comments"> 
     887</div> 
     888 
     889           
     890 
     891           
     892            <h3>Parameters</h3> 
     893         
     894             
     895            <h4 id="_vecteur_param_composanteu">composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     896              <span class="attr">in</span> 
     897               
     898               
     899              <span class="attr">required</span> 
     900               
     901               
     902               
     903               
     904            </h4> 
     905         
     906          <div class="comments"> 
     907 It is the u component of the vector to be traced. This 2d array has the  
     908 same dimension that reduitindice2d (see further) 
     909 </div> 
     910             
     911            <h4 id="_vecteur_param_composantev">composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     912              <span class="attr">in</span> 
     913               
     914               
     915              <span class="attr">required</span> 
     916               
     917               
     918               
     919               
     920            </h4> 
     921         
     922          <div class="comments"> 
     923 It is the v component of the vector to be traced. This 2d array has the  
     924 same dimension that reduitindice2d (see further) 
     925 </div> 
     926             
     927            <h4 id="_vecteur_param_normevecteur">normevecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     928               
     929               
     930               
     931               
     932               
     933               
     934               
     935               
     936            </h4> 
     937         
    937938          <div class="comments"></div> 
    938  
    939            
    940  
    941            
    942             <h3>Parameters</h3> 
    943          
    944              
    945             <h4 id="_vecteur_param_composanteu">composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    946                
    947                
    948                
    949                
    950                
    951                
    952                
    953                
    954             </h4> 
    955          
    956           <div class="comments"></div> 
    957              
    958             <h4 id="_vecteur_param_composantev">composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    959                
    960                
    961                
    962                
    963                
    964                
    965                
    966                
    967             </h4> 
    968          
    969           <div class="comments"></div> 
    970              
    971             <h4 id="_vecteur_param_normevecteur">normevecteur&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    972                
    973                
    974                
    975                
    976                
    977                
    978                
    979                
    980             </h4> 
    981          
    982           <div class="comments"></div> 
    983939             
    984940            <h4 id="_vecteur_param_indice2d">indice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    985                
    986                
    987                
    988                
    989                
    990                
    991                
    992                
    993             </h4> 
    994          
    995           <div class="comments"></div> 
     941              <span class="attr">in</span> 
     942               
     943               
     944              <span class="attr">required</span> 
     945               
     946               
     947               
     948               
     949            </h4> 
     950         
     951          <div class="comments"> 
     952 It in an index allowing to to pass from an jpi or jpj array to the zoom  
     953 on which we do the drawing 
     954 </div> 
    996955             
    997956            <h4 id="_vecteur_param_reduitindice2d">reduitindice2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    998                
    999                
    1000                
    1001                
    1002                
    1003                
    1004                
    1005                
    1006             </h4> 
    1007          
    1008           <div class="comments"></div> 
     957              <span class="attr">in</span> 
     958               
     959               
     960              <span class="attr">required</span> 
     961               
     962               
     963               
     964               
     965            </h4> 
     966         
     967          <div class="comments"> 
     968 It is an index allowing to pass from an array defined by indice2d to the  
     969 array for which we really have vectors to be traced (to be clear, it is  
     970 for example when we trace only one vector on two). 
     971</div> 
    1009972             
    1010973 
    … …  
    1026989            </h4> 
    1027990         
    1028             <div class="comments"></div> 
     991            <div class="comments"> 
     992 The lenth in cm that must measure the arrow normed normeref. By default,  
     993 it is ajusted t othe drawing and included between .5 and 1.5 cm. 
     994</div> 
    1029995             
    1030996            <h4 id="_vecteur_keyword_MISSING">MISSING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10391005            </h4> 
    10401006         
    1041             <div class="comments"></div> 
     1007            <div class="comments"> 
     1008 The value of a missing value. Do not use this keyword. Fixed at 1e5 by  
     1009 ajoutvect.pro 
     1010      </div> 
    10421011             
    10431012            <h4 id="_vecteur_keyword_NORMEREF">NORMEREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10521021            </h4> 
    10531022         
    1054             <div class="comments"></div> 
     1023            <div class="comments">  
     1024 The norme of the reference arrow. 
     1025</div> 
    10551026             
    10561027            <h4 id="_vecteur_keyword_VECTCOLOR">VECTCOLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10651036            </h4> 
    10661037         
    1067             <div class="comments"></div> 
     1038            <div class="comments"> 
     1039 The color of the arrow. Black by default (color 0) 
     1040 </div> 
    10681041             
    10691042            <h4 id="_vecteur_keyword_VECTTHICK">VECTTHICK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10781051            </h4> 
    10791052         
    1080             <div class="comments"></div> 
     1053            <div class="comments"> 
     1054 The thick of the arrow. 1 by default  
     1055</div> 
    10811056             
    10821057            <h4 id="_vecteur_keyword_VECTREFPOS">VECTREFPOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10911066            </h4> 
    10921067         
    1093             <div class="comments"></div> 
     1068            <div class="comments"> 
     1069 Vector composed of 2 elements specifing the position on DATA coordinates  
     1070 from de begining of the reference vector. By default at the right bottom  
     1071 of the drawing. 
     1072</div> 
    10941073             
    10951074            <h4 id="_vecteur_keyword_VECTREFFORMAT">VECTREFFORMAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11041083            </h4> 
    11051084         
    1106             <div class="comments"></div> 
     1085            <div class="comments"> 
     1086 The format to be used to specify the norme of the reference vector. 
     1087</div> 
    11071088             
    11081089            <h4 id="_vecteur_keyword_NOVECTREF">NOVECTREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11171098            </h4> 
    11181099         
    1119             <div class="comments"></div> 
     1100            <div class="comments"> 
     1101 To delete the display of the reference vector. 
     1102 </div> 
    11201103             
    11211104            <h4 id="_vecteur_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11301113            </h4> 
    11311114         
    1132             <div class="comments"></div> 
    1133              
    1134            
    1135  
    1136            
    1137            
    1138            
    1139            
    1140            
    1141            
    1142            
    1143            
    1144            
    1145            
    1146            
    1147            
    1148          
    1149            
    1150            
    1151            
    1152            
     1115            <div class="comments"> 
     1116 Used to pass your keywords  
     1117</div> 
     1118             
     1119           
     1120 
     1121           
     1122          <h3>Version history</h3> 
     1123           
     1124          <h4>Version</h4><div class="preformat"> 
     1125 $Id$  
     1126</div> 
     1127          <h4>History</h4><div class="preformat"></div> 
     1128           
     1129           
     1130           
     1131           
     1132           
     1133           
     1134           
     1135         
     1136          <h3>Other attributes</h3> 
     1137           
     1138           
     1139          <h4>Uses routines</h4><div class="preformat">  
     1140 common.pro 
     1141</div> 
    11531142           
    11541143           
Note: See TracChangeset for help on using the changeset viewer.