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

english and nicer header (2a)

Location:
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS
Files:
17 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/addaxe.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Add an axis when we do an oblique section in pltz, pltt 
     700 or plt1d 
     701</div> 
    699702 
    700703       
     
    711714        <div class="routine_details" id="_addaxe"> 
    712715 
    713           <h2><a class="top" href="#container">top</a>addaxe </h2> 
     716          <h2><a class="top" href="#container">top</a>addaxe <span class="categories"> 
     717 graphic 
     718</span></h2> 
    714719         
    715720          <p class="header"> 
     
    717722         
    718723          <div class="comments"> 
    719  NAME:addaxe 
    720  
    721  PURPOSE:ajoute un axe qd on fait une section oblique ds pltz, pltt 
    722  ou plt1d 
    723  
    724  CATEGORY:autour de pltz, pltt et plt1d 
    725  
    726  CALLING SEQUENCE:addaxe, type, posfenetre 
    727   
    728  INPUTS:endpoints:coordonnees des extremites de ;a section 
    729         type: un string de 2 characteres specifiant qule type de plot 
    730  on fait. 
    731         posfenetre: ler vecteur !p.posotion correspondant a ;a 
    732         position du cadre de la partie dessin du plot. 
    733  
    734  KEYWORD PARAMETERS: 
    735  
    736  OUTPUTS: 
    737  
    738  COMMON BLOCKS:common.pro 
    739  
    740  SIDE EFFECTS: 
    741  
    742  RESTRICTIONS: 
    743  
    744  EXAMPLE: 
    745724</div> 
    746725 
     
    752731             
    753732            <h4 id="_addaxe_param_endpoints">endpoints&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    754                
    755                
    756                
    757                
     733              <span class="attr">in</span> 
     734               
     735               
     736              <span class="attr">required</span> 
    758737               
    759738               
     
    762741            </h4> 
    763742         
    764           <div class="comments"></div> 
     743          <div class="comments"> 
     744 Coordonnees of extremities of the section 
     745 </div> 
    765746             
    766747            <h4 id="_addaxe_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    767                
    768                
    769                
    770                
     748              <span class="attr">in</span> 
     749               
     750               
     751              <span class="attr">required</span> 
    771752               
    772753               
     
    775756            </h4> 
    776757         
    777           <div class="comments"></div> 
     758          <div class="comments"> 
     759 A string of two characters specifying the type of plot we do 
     760</div> 
    778761             
    779762            <h4 id="_addaxe_param_posfenetre">posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    780                
    781                
    782                
    783                
     763              <span class="attr">in</span> 
     764               
     765               
     766              <span class="attr">required</span> 
    784767               
    785768               
     
    788771            </h4> 
    789772         
    790           <div class="comments"></div> 
     773          <div class="comments"> 
     774 The vector !p.position corresponding to the frame position of  
     775 the drawing part of the plot. 
     776</div> 
    791777             
    792778 
     
    813799 
    814800           
    815            
    816            
    817            
    818            
    819            
    820            
    821            
    822            
    823            
    824            
    825            
    826          
    827            
    828            
    829            
    830            
     801          <h3>Version history</h3> 
     802           
     803          <h4>Version</h4><div class="preformat"> 
     804 $Id$ 
     805</div> 
     806          <h4>History</h4><div class="preformat"></div> 
     807           
     808           
     809           
     810           
     811           
     812           
     813           
     814         
     815          <h3>Other attributes</h3> 
     816           
     817           
     818          <h4>Uses routines</h4><div class="preformat"> 
     819 common.pro 
     820</div> 
    831821           
    832822           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/autoscale.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments">  
     699 We give a min and a max, and the procedure send back  
     700 the good contour interval and labels's value. 
     701</div> 
    699702 
    700703       
     
    711714        <div class="routine_details" id="_autoscale"> 
    712715 
    713           <h2><a class="top" href="#container">top</a>autoscale </h2> 
     716          <h2><a class="top" href="#container">top</a>autoscale <span class="categories">  
     717 graphic 
     718</span></h2> 
    714719         
    715720          <p class="header"> 
     
    717722         
    718723          <div class="comments"> 
    719  NAME: autoscale 
    720  
    721  PURPOSE: on donne un min et un max et la procedure renvoie le 
    722  contour intevalle qui va bien et la valeur des labels. 
    723  
    724  CATEGORY: autour de CONTOUR 
    725  
    726  CALLING SEQUENCE: autoscale, min, max, ci 
    727   
    728  INPUTS: min et max: 2 reels specifiants entre quel min et quel max 
    729  on veut tracer un contour 
    730  
    731  KEYWORD PARAMETERS: none 
    732  
    733  OUTPUTS: ci et evenuellement levels. ci est un reel qui donne le 
    734  contour intevalle. A utiliser ds CONTOUR avlec le mot clef LEVEL. 
    735  
    736  COMMON BLOCKS: 
    737  
    738  SIDE EFFECTS: 
    739  
    740   CI est un multiple de l'unite en unite log de 10. 
    741   force le nombre de contour a etre pair. 
    742  
    743  RESTRICTIONS: 
    744  
    745  EXAMPLE: 
    746724</div> 
    747725 
     
    753731             
    754732            <h4 id="_autoscale_param_min">min&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    755                
    756                
    757                
    758                
     733              <span class="attr">in</span> 
     734               
     735               
     736              <span class="attr">required</span> 
    759737               
    760738               
     
    763741            </h4> 
    764742         
    765           <div class="comments"></div> 
     743          <div class="comments"> 
     744 A reel number specifying above what value we want to trace a contour 
     745</div> 
    766746             
    767747            <h4 id="_autoscale_param_max">max&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    768                
    769                
    770                
    771                
     748              <span class="attr">in</span> 
     749               
     750               
     751              <span class="attr">required</span> 
    772752               
    773753               
     
    776756            </h4> 
    777757         
    778           <div class="comments"></div> 
     758          <div class="comments"> 
     759 A reel number specifying below what value we want to trace a contour 
     760</div> 
    779761             
    780762            <h4 id="_autoscale_param_ci">ci&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    781763               
    782                
     764              <span class="attr">out</span> 
    783765               
    784766               
     
    789771            </h4> 
    790772         
    791           <div class="comments"></div> 
     773          <div class="comments"> 
     774 It is a reel number giving the contour interval. Use it in CONTOUR with the keyword LEVEL. 
     775</div> 
    792776             
    793777 
     
    797781 
    798782           
    799            
    800            
    801            
    802            
    803            
    804            
    805            
    806            
    807            
    808            
    809            
     783          <h3>Version history</h3> 
     784           
     785          <h4>Version</h4><div class="preformat"> 
     786 $Id$ 
     787</div> 
     788          <h4>History</h4><div class="preformat"></div> 
     789           
     790           
     791          <h3>Known issues</h3> 
     792           
     793           
     794           
     795          <h4>Restrictions</h4><div class="preformat"> 
     796 CI is a multiple of the unity in unity log of 10. 
     797 It force the number of contour to be even. 
     798</div> 
    810799         
    811800           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/axis4pltz.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 compute the mask and the axis for a vertical section 
     700</div> 
    699701 
    700702       
     
    717719         
    718720          <div class="comments"> 
    719  NAME:axis4pltz 
    720  
    721  PURPOSE:compute the mask and the axis for a vertical section 
    722  
    723  CATEGORY: 
    724  
    725  CALLING SEQUENCE: 
     721</div> 
     722 
     723           
     724 
     725           
     726            <h3>Parameters</h3> 
     727         
     728             
     729            <h4 id="_axis4pltz_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     730               
     731               
     732               
     733               
     734               
     735               
     736               
     737               
     738            </h4> 
     739         
     740          <div class="comments"></div> 
     741             
     742            <h4 id="_axis4pltz_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     743              <span class="attr">in</span> 
     744               
     745               
     746              <span class="attr">required</span> 
     747               
     748               
     749               
     750               
     751            </h4> 
     752         
     753          <div class="comments"> 
     754  3d mask 
     755        </div> 
     756             
     757            <h4 id="_axis4pltz_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     758              <span class="attr">in</span> 
     759               
     760               
     761              <span class="attr">required</span> 
     762               
     763               
     764               
     765               
     766            </h4> 
     767         
     768          <div class="comments"> 
     769 2d longitude  
     770 </div> 
     771             
     772            <h4 id="_axis4pltz_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     773              <span class="attr">in</span> 
     774               
     775               
     776              <span class="attr">required</span> 
     777               
     778               
     779               
     780               
     781            </h4> 
     782         
     783          <div class="comments"> 
     784 2d latitude 
     785</div> 
     786             
     787            <h4 id="_axis4pltz_param_z">z&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     788              <span class="attr">in</span> 
     789               
     790               
     791              <span class="attr">required</span> 
     792               
     793               
     794               
     795               
     796            </h4> 
     797         
     798          <div class="comments"> 
     799 1d depth 
     800</div> 
     801             
     802 
     803           
     804 
     805           
     806 
     807            <h3>Keywords</h3> 
     808             
     809            <h4 id="_axis4pltz_keyword_XXAXIS">XXAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     810               
     811               
     812               
     813               
     814               
     815               
     816               
     817               
     818            </h4> 
     819         
     820            <div class="comments">  
     821 to get the xaxis we need to use in pltbase 
     822      </div> 
     823             
     824            <h4 id="_axis4pltz_keyword_ZZAXIS">ZZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     825               
     826               
     827               
     828               
     829               
     830               
     831               
     832               
     833            </h4> 
     834         
     835            <div class="comments">  
     836 to get the yaxis we need to use in pltbase 
     837</div> 
     838             
     839            <h4 id="_axis4pltz_keyword_SIN">SIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     840               
     841               
     842               
     843               
     844               
     845               
     846               
     847               
     848            </h4> 
     849         
     850            <div class="comments">  
     851 Activate this keyword if we want the x axis to be traced in sinus of the  
     852 latitude when we make a drawing f(y) 
     853</div> 
     854             
     855            <h4 id="_axis4pltz_keyword_ZRATIO">ZRATIO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     856               
     857               
     858               
     859               
     860               
     861               
     862               
     863               
     864            </h4> 
     865         
     866            <div class="comments"> 
     867 When the drawing has a zoomed part, it is the size rapport between the zoomed part,  
     868 hz (zoom height), and the whole drawing, ht (total height). By default =2./3 
     869</div> 
     870             
     871            <h4 id="_axis4pltz_keyword_ZOOM">ZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     872               
     873               
     874               
     875               
     876               
     877               
     878               
     879               
     880            </h4> 
     881         
     882            <div class="comments"></div> 
     883             
     884            <h4 id="_axis4pltz_keyword_PROFMAX">PROFMAX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     885               
     886               
     887               
     888               
     889               
     890               
     891               
     892               
     893            </h4> 
     894         
     895            <div class="comments"></div> 
     896             
     897            <h4 id="_axis4pltz_keyword_PROFMIN">PROFMIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     898               
     899               
     900               
     901               
     902               
     903               
     904               
     905               
     906            </h4> 
     907         
     908            <div class="comments"></div> 
     909             
     910            <h4 id="_axis4pltz_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     911               
     912               
     913               
     914               
     915               
     916               
     917               
     918               
     919            </h4> 
     920         
     921            <div class="comments"> 
     922 used to pass your keywords 
    726923  
    727  INPUTS:mask: 3d mask 
    728         glam, gphi: 2d longitudes and latitudes 
    729         z:1d depth 
    730  
    731  KEYWORD PARAMETERS: 
    732         XXAXIS to get the xaxis we need to use in pltbase 
    733         ZZAXIS to get the yaxis we need to use in pltbase 
    734  
    735         Others: see pltz  
    736  
    737  OUTPUTS: 
    738  
    739  COMMON BLOCKS: 
    740  
    741  SIDE EFFECTS: 
    742  
    743  RESTRICTIONS: 
    744  
    745  EXAMPLE: 
    746 </div> 
    747  
    748            
    749  
    750            
    751             <h3>Parameters</h3> 
    752          
    753              
    754             <h4 id="_axis4pltz_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    755                
    756                
    757                
    758                
    759                
    760                
    761                
    762                
    763             </h4> 
    764          
    765           <div class="comments"></div> 
    766              
    767             <h4 id="_axis4pltz_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    768                
    769                
    770                
    771                
    772                
    773                
    774                
    775                
    776             </h4> 
    777          
    778           <div class="comments"></div> 
    779              
    780             <h4 id="_axis4pltz_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    781                
    782                
    783                
    784                
    785                
    786                
    787                
    788                
    789             </h4> 
    790          
    791           <div class="comments"></div> 
    792              
    793             <h4 id="_axis4pltz_param_gphi">gphi&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="_axis4pltz_param_z">z&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    807                
    808                
    809                
    810                
    811                
    812                
    813                
    814                
    815             </h4> 
    816          
    817           <div class="comments"></div> 
    818              
    819  
    820            
    821  
    822            
    823  
    824             <h3>Keywords</h3> 
    825              
    826             <h4 id="_axis4pltz_keyword_XXAXIS">XXAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    827                
    828                
    829                
    830                
    831                
    832                
    833                
    834                
    835             </h4> 
    836          
    837             <div class="comments"></div> 
    838              
    839             <h4 id="_axis4pltz_keyword_ZZAXIS">ZZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    840                
    841                
    842                
    843                
    844                
    845                
    846                
    847                
    848             </h4> 
    849          
    850             <div class="comments"></div> 
    851              
    852             <h4 id="_axis4pltz_keyword_SIN">SIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    853                
    854                
    855                
    856                
    857                
    858                
    859                
    860                
    861             </h4> 
    862          
    863             <div class="comments"></div> 
    864              
    865             <h4 id="_axis4pltz_keyword_ZRATIO">ZRATIO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    866                
    867                
    868                
    869                
    870                
    871                
    872                
    873                
    874             </h4> 
    875          
    876             <div class="comments"></div> 
    877              
    878             <h4 id="_axis4pltz_keyword_ZOOM">ZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    879                
    880                
    881                
    882                
    883                
    884                
    885                
    886                
    887             </h4> 
    888          
    889             <div class="comments"></div> 
    890              
    891             <h4 id="_axis4pltz_keyword_PROFMAX">PROFMAX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    892                
    893                
    894                
    895                
    896                
    897                
    898                
    899                
    900             </h4> 
    901          
    902             <div class="comments"></div> 
    903              
    904             <h4 id="_axis4pltz_keyword_PROFMIN">PROFMIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    905                
    906                
    907                
    908                
    909                
    910                
    911                
    912                
    913             </h4> 
    914          
    915             <div class="comments"></div> 
    916              
    917             <h4 id="_axis4pltz_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    918                
    919                
    920                
    921                
    922                
    923                
    924                
    925                
    926             </h4> 
    927          
    928             <div class="comments"></div> 
    929              
    930            
    931  
    932            
    933            
    934            
    935            
    936            
     924  Others: see pltz  
     925 
     926</div> 
     927             
     928           
     929 
     930           
     931          <h3>Version history</h3> 
     932           
     933          <h4>Version</h4><div class="preformat"> 
     934 $Id$ 
     935</div> 
     936          <h4>History</h4><div class="preformat"></div> 
    937937           
    938938           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/barrecouleur.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Overlayeur of colorbar 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_barrecouleur"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>barrecouleur </h2> 
     715          <h2><a class="top" href="#container">top</a>barrecouleur <span class="categories"> 
     716 utilities 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:barrecouleur 
    720  
    721  PURPOSE:surcouche de colorbar 
    722  
    723  CATEGORY:delestage de l''ecriture de plt, pltz, pltt 
    724  
    725  CALLING SEQUENCE:barrecouleur 
    726  
    727  SIDE EFFECTS: passer tous les arguments que l''on veut grace a _extra 
    728723</div> 
    729724 
     
    926921 
    927922           
    928            
    929            
    930            
    931            
    932            
    933            
    934            
    935            
    936            
    937            
    938            
     923          <h3>Version history</h3> 
     924           
     925          <h4>Version</h4><div class="preformat"> 
     926 $Id$ 
     927</div> 
     928          <h4>History</h4><div class="preformat"></div> 
     929           
     930           
     931          <h3>Known issues</h3> 
     932           
     933           
     934          <h4>Todo items</h4><div class="preformat"> seb: mettre les keyword et les param</div> 
     935          <h4>Restrictions</h4><div class="preformat"> pass all argument we want thanks to _extra 
     936</div> 
    939937         
    940938           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/checkfield.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 In input of plt, pltz, pltt and plt1d, it check that the field give  
     700 a size compatible with the domain and, if needed, average to give us  
     701 a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt' 
     702 , 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'. 
     703</div> 
    699704 
    700705       
     
    711716           
    712717          <dt><p><a href="#_err_1d"><span class="result">result = </span>err_1d(<span class="result">type, n1, name, n2</span>)</a></p><dt> 
    713           <dd>  NAME:checkfield   PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le  champ donne a bien une taille compatible avec le domaine et fait au  besoin les moyennes pour ressortir en fin de fonction un tableau 2d  si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un  tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'.</dd>  
     718          <dd></dd>      
    714719           
    715720          <dt><p><a href="#_err_2d"><span class="result">result = </span>err_2d(<span class="result">type, sz, nx, ny, nz</span>)</a></p><dt> 
     
    720725           
    721726          <dt><p><a href="#_checkfield"><span class="result">result = </span>checkfield(<span class="result">field, procedure</span>, TYPE=<span class="result">TYPE</span>, BOXZOOM=<span class="result">BOXZOOM</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">VECTEUR</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt> 
    722           <dd></dd>      
     727          <dd> </dd>     
    723728                 
    724729        </dl> 
     
    736741            <span class="result">result = </span>err_1d(<span class="result"><a href="#_err_1d_param_type">type</a>, <a href="#_err_1d_param_n1">n1</a>, <a href="#_err_1d_param_name">name</a>, <a href="#_err_1d_param_n2">n2</a></span>)</p> 
    737742         
    738           <div class="comments"> 
    739  NAME:checkfield 
    740  
    741  PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le 
    742  champ donne a bien une taille compatible avec le domaine et fait au 
    743  besoin les moyennes pour ressortir en fin de fonction un tableau 2d 
    744  si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un 
    745  tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'. 
    746  
    747  CATEGORY:en entree de plt, pltz, pltt et plt1d 
    748  
    749  CALLING SEQUENCE:res=checkfield(field, procedure) 
    750   
    751  INPUTS: 
    752         filed: un champ recomdant aux criteres de litchamp.pro, cf. 
    753         IDL>xhelp,'litchamp' 
    754  
    755  KEYWORD PARAMETERS: 
    756   
    757          /WDEPTH: to specify that the field is at W depth instad of T  
    758          depth (automatically activated if vargrid eq 'W') 
    759  
    760  OUTPUTS: 
    761  
    762  COMMON BLOCKS:common.pro 
    763  
    764  SIDE EFFECTS: 
    765  
    766  RESTRICTIONS: 
    767  
    768  EXAMPLE: 
    769 </div> 
     743          <div class="comments"></div> 
    770744 
    771745           
     
    10821056        <div class="routine_details" id="_checkfield"> 
    10831057 
    1084           <h2><a class="top" href="#container">top</a>checkfield </h2> 
     1058          <h2><a class="top" href="#container">top</a>checkfield <span class="categories"> 
     1059 graphic 
     1060 </span></h2> 
    10851061         
    10861062          <p class="header"> 
    10871063            <span class="result">result = </span>checkfield(<span class="result"><a href="#_checkfield_param_field">field</a>, <a href="#_checkfield_param_procedure">procedure</a></span>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<span class="result">NOQUESTION</span>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    10881064         
    1089           <div class="comments"></div> 
     1065          <div class="comments"> 
     1066</div> 
    10901067 
    10911068           
     
    10961073             
    10971074            <h4 id="_checkfield_param_field">field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1098                
    1099                
    1100                
    1101                
    1102                
    1103                
    1104                
    1105                
    1106             </h4> 
    1107          
    1108           <div class="comments"></div> 
     1075              <span class="attr">in</span> 
     1076               
     1077               
     1078              <span class="attr">required</span> 
     1079               
     1080               
     1081               
     1082               
     1083            </h4> 
     1084         
     1085          <div class="comments"> 
     1086 A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp' 
     1087</div> 
    11091088             
    11101089            <h4 id="_checkfield_param_procedure">procedure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    11521131            </h4> 
    11531132         
     1133            <div class="comments">  
     1134 Vector indicating the geographic zone on which we want to cut the map.  
     1135  If BOXZOOM has : 
     1136 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 
     1137 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] 
     1138 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])] 
     1139 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
     1140 6 elements: The extraction is made on Boxzoom 
     1141 
     1142 Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     1143</div> 
     1144             
     1145            <h4 id="_checkfield_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1146               
     1147               
     1148               
     1149               
     1150               
     1151               
     1152               
     1153               
     1154            </h4> 
     1155         
     1156            <div class="comments">    
     1157</div> 
     1158             
     1159            <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1160               
     1161               
     1162               
     1163               
     1164               
     1165               
     1166               
     1167               
     1168            </h4> 
     1169         
    11541170            <div class="comments"></div> 
    11551171             
    1156             <h4 id="_checkfield_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1172            <h4 id="_checkfield_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    11571173               
    11581174               
     
    11651181            </h4> 
    11661182         
    1167             <div class="comments"></div> 
    1168              
    1169             <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1183            <div class="comments"> is also appropriated. 
     1184</div> 
     1185             
     1186            <h4 id="_checkfield_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    11701187               
    11711188               
     
    11781195            </h4> 
    11791196         
    1180             <div class="comments"></div> 
    1181              
    1182             <h4 id="_checkfield_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1197            <div class="comments"> 
     1198 to specify that the field is at W depth instad of T  
     1199 depth (automatically activated if vargrid eq 'W') 
     1200 </div> 
     1201             
     1202            <h4 id="_checkfield_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    11831203               
    11841204               
     
    11911211            </h4> 
    11921212         
    1193             <div class="comments"></div> 
    1194              
    1195             <h4 id="_checkfield_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1196                
    1197                
    1198                
    1199                
    1200                
    1201                
    1202                
    1203                
    1204             </h4> 
    1205          
    1206             <div class="comments"></div> 
    1207              
    1208             <h4 id="_checkfield_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1209                
    1210                
    1211                
    1212                
    1213                
    1214                
    1215                
    1216                
    1217             </h4> 
    1218          
    1219             <div class="comments"></div> 
    1220              
    1221            
    1222  
    1223            
    1224            
    1225            
    1226            
    1227            
    1228            
    1229            
    1230            
    1231            
    1232            
    1233            
    1234            
    1235          
    1236            
    1237            
    1238            
    1239            
     1213            <div class="comments"> 
     1214 used to pass your keywords 
     1215</div> 
     1216             
     1217           
     1218 
     1219           
     1220          <h3>Version history</h3> 
     1221           
     1222          <h4>Version</h4><div class="preformat"> 
     1223 $Id$ 
     1224</div> 
     1225          <h4>History</h4><div class="preformat"></div> 
     1226           
     1227           
     1228          <h3>Known issues</h3> 
     1229           
     1230           
     1231          <h4>Todo items</h4><div class="preformat"> seb: mettre les param  
     1232</div> 
     1233           
     1234         
     1235          <h3>Other attributes</h3> 
     1236           
     1237           
     1238          <h4>Uses routines</h4><div class="preformat">  
     1239 common.pro 
     1240</div> 
    12401241           
    12411242           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/checktypeminmax.html

    r138 r142  
    996996           
    997997           
    998            
    999            
    1000            
    1001            
     998          <h3>Known issues</h3> 
     999           
     1000           
     1001          <h4>Todo items</h4><div class="preformat"> seb</div> 
    10021002           
    10031003         
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/determineminmax.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Determine the min and the max of a mask array 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_determineminmax"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>determineminmax </h2> 
     715          <h2><a class="top" href="#container">top</a>determineminmax <span class="categories">  
     716 Lightening of the writting of plt, pltz and pltt 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:determineminmax 
    720  
    721  PURPOSE:determiner le min et le max d''un tableau masque 
    722  
    723  CATEGORY: delestage de l''ecriture de plt, pltz, pltt 
    724  
    725  CALLING SEQUENCE:determineminmax, tab, mask, vraimin, vraimax 
    726  
    727  INPUTS: 
    728  
    729        tab: le tableau dont il faut determiner le min et le max 
    730        mask: le tableau de masque  
    731  
    732  KEYWORD PARAMETERS: 
    733  
    734        minin et maxin deux scalaire qui s''il ne sont pas definits 
    735        prennent la valeur de vraimin et vraimax 
    736  
    737        /ZEROMIDDLE: fo force the middle of the colorbar to be equal 
    738        to 0 (force max=max(abs([min,max])) and min=-max) 
    739  
    740  OUTPUTS: 
    741  
    742        vraimin et vraimax: le min et le max du tableau 
    743  
    744  COMMON BLOCKS: 
    745         common.pro 
    746  
    747  SIDE EFFECTS:degarde si le champ est constant sur la mer 
    748  
    749  RESTRICTIONS: 
    750  
    751  EXAMPLE: 
    752723</div> 
    753724 
     
    759730             
    760731            <h4 id="_determineminmax_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     732              <span class="attr">in</span> 
     733               
     734               
     735              <span class="attr">required</span> 
     736               
     737               
     738               
     739               
     740            </h4> 
     741         
     742          <div class="comments"> 
     743 The array whose we determine the min and the max 
     744</div> 
     745             
     746            <h4 id="_determineminmax_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     747              <span class="attr">in</span> 
     748               
     749               
     750              <span class="attr">required</span> 
     751               
     752               
     753               
     754               
     755            </h4> 
     756         
     757          <div class="comments"> 
     758 The mask array  
     759</div> 
     760             
     761            <h4 id="_determineminmax_param_vraimin">vraimin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     762               
     763              <span class="attr">out</span> 
     764               
     765               
     766               
     767               
     768               
     769               
     770            </h4> 
     771         
     772          <div class="comments"> 
     773 The min of the array 
     774</div> 
     775             
     776            <h4 id="_determineminmax_param_vraimax">vraimax&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     777               
     778              <span class="attr">out</span> 
     779               
     780               
     781               
     782               
     783               
     784               
     785            </h4> 
     786         
     787          <div class="comments"> 
     788 The max of the array 
     789</div> 
     790             
     791            <h4 id="_determineminmax_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    761792               
    762793               
     
    771802          <div class="comments"></div> 
    772803             
    773             <h4 id="_determineminmax_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     804            <h4 id="_determineminmax_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    774805               
    775806               
     
    784815          <div class="comments"></div> 
    785816             
    786             <h4 id="_determineminmax_param_vraimin">vraimin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    787                
    788                
    789                
    790                
    791                
    792                
    793                
    794                
    795             </h4> 
    796          
    797           <div class="comments"></div> 
    798              
    799             <h4 id="_determineminmax_param_vraimax">vraimax&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    800                
    801                
    802                
    803                
    804                
    805                
    806                
    807                
    808             </h4> 
    809          
    810           <div class="comments"></div> 
    811              
    812             <h4 id="_determineminmax_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    813                
    814                
    815                
    816                
    817                
    818                
    819                
    820                
    821             </h4> 
    822          
    823           <div class="comments"></div> 
    824              
    825             <h4 id="_determineminmax_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    826                
    827                
    828                
    829                
    830                
    831                
    832                
    833                
    834             </h4> 
    835          
    836           <div class="comments"></div> 
    837              
    838817 
    839818           
     
    854833            </h4> 
    855834         
     835            <div class="comments">  
     836 It is a scalar which, if it is not defined, take the value of VRAIMAX 
     837</div> 
     838             
     839            <h4 id="_determineminmax_keyword_MININ">MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     840               
     841               
     842               
     843               
     844               
     845               
     846               
     847               
     848            </h4> 
     849         
     850            <div class="comments">  
     851 It is a scalar which, if it is not defined, take the value of VRAIMIN 
     852</div> 
     853             
     854            <h4 id="_determineminmax_keyword_INTERVALLE">INTERVALLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     855               
     856               
     857               
     858               
     859               
     860               
     861               
     862               
     863            </h4> 
     864         
    856865            <div class="comments"></div> 
    857866             
    858             <h4 id="_determineminmax_keyword_MININ">MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     867            <h4 id="_determineminmax_keyword_usetri">usetri&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    859868               
    860869               
     
    867876            </h4> 
    868877         
    869             <div class="comments"></div> 
    870              
    871             <h4 id="_determineminmax_keyword_INTERVALLE">INTERVALLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     878            <div class="comments"> 
     879 To force using triangulation. 
     880 </div> 
     881             
     882            <h4 id="_determineminmax_keyword_ZEROMIDDLE">ZEROMIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    872883               
    873884               
     
    880891            </h4> 
    881892         
    882             <div class="comments"></div> 
    883              
    884             <h4 id="_determineminmax_keyword_usetri">usetri&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     893            <div class="comments">  
     894 Force the middle of the colorbar to be equal 
     895 to 0 (force max=max(abs([min,max])) and min=-max) 
     896 </div> 
     897             
     898            <h4 id="_determineminmax_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    885899               
    886900               
     
    893907            </h4> 
    894908         
    895             <div class="comments"></div> 
    896              
    897             <h4 id="_determineminmax_keyword_ZEROMIDDLE">ZEROMIDDLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    898                
    899                
    900                
    901                
    902                
    903                
    904                
    905                
    906             </h4> 
    907          
    908             <div class="comments"></div> 
    909              
    910             <h4 id="_determineminmax_keyword__extra">_extra&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            
    926            
    927            
    928            
    929            
    930            
    931            
    932            
    933            
    934            
    935            
    936            
    937          
    938            
    939            
    940            
    941            
     909            <div class="comments"> 
     910 used to pass your keywords 
     911</div> 
     912             
     913           
     914 
     915           
     916          <h3>Version history</h3> 
     917           
     918          <h4>Version</h4><div class="preformat"> 
     919 $Id$ 
     920</div> 
     921          <h4>History</h4><div class="preformat"></div> 
     922           
     923           
     924          <h3>Known issues</h3> 
     925           
     926           
     927          <h4>Todo items</h4><div class="preformat"> seb: manque les param glam et gphi 
     928</div> 
     929          <h4>Restrictions</h4><div class="preformat"> 
     930 Look if the field is constant on the sea 
     931</div> 
     932         
     933          <h3>Other attributes</h3> 
     934           
     935           
     936          <h4>Uses routines</h4><div class="preformat"> 
     937 Common.pro 
     938</div> 
    942939           
    943940           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/directory-overview.html

    r138 r142  
    699699       
    700700        <dt><a href="addaxe.html?format=raw">addaxe.pro</a></dt> 
    701         <dd></dd> 
     701        <dd>  Add an axis when we do an oblique section in pltz, pltt  or plt1d </dd> 
    702702       
    703703        <dt><a href="autoscale.html?format=raw">autoscale.pro</a></dt> 
    704         <dd></dd> 
     704        <dd>   We give a min and a max, and the procedure send back   the good contour interval and labels's value.</dd> 
    705705       
    706706        <dt><a href="axis4pltz.html?format=raw">axis4pltz.pro</a></dt> 
    707         <dd></dd> 
     707        <dd>  compute the mask and the axis for a vertical section </dd> 
    708708       
    709709        <dt><a href="barrecouleur.html?format=raw">barrecouleur.pro</a></dt> 
    710         <dd></dd> 
     710        <dd>  Overlayeur of colorbar </dd> 
    711711       
    712712        <dt><a href="checkfield.html?format=raw">checkfield.pro</a></dt> 
    713         <dd></dd> 
     713        <dd>  In input of plt, pltz, pltt and plt1d, it check that the field give   a size compatible with the domain and, if needed, average to give us   a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt'  , 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'.</dd> 
    714714       
    715715        <dt><a href="checktypeminmax.html?format=raw">checktypeminmax.pro</a></dt> 
     
    717717       
    718718        <dt><a href="determineminmax.html?format=raw">determineminmax.pro</a></dt> 
    719         <dd></dd> 
     719        <dd>  Determine the min and the max of a mask array </dd> 
    720720       
    721721        <dt><a href="givewindowsize.html?format=raw">givewindowsize.pro</a></dt> 
     
    723723       
    724724        <dt><a href="meridienparallele.html?format=raw">meridienparallele.pro</a></dt> 
    725         <dd></dd> 
     725        <dd>  Trace some meridians or parallel </dd> 
    726726       
    727727        <dt><a href="placecolor.html?format=raw">placecolor.pro</a></dt> 
    728         <dd></dd> 
     728        <dd>  allows to trace the independently from a graph  By default, trace a color bar of the same type tahn the one present in plt  and pltz.</dd> 
    729729       
    730730        <dt><a href="placedessin.html?format=raw">placedessin.pro</a></dt> 
    731         <dd></dd> 
     731        <dd>   Putting into place of the drawing/ opening of the window or of the PS </dd> 
    732732       
    733733        <dt><a href="projsegment.html?format=raw">projsegment.pro</a></dt> 
    734         <dd></dd> 
     734        <dd>  project linearly a segment, a vector whose boundaries are [a,b] on   a vector whose boundaries are [c,d] </dd> 
    735735       
    736736        <dt><a href="restoreatt.html?format=raw">restoreatt.pro</a></dt> 
    737         <dd></dd> 
     737        <dd>  Allows to reattribuate global variables associated with a field   when we give a stucture created by saveatt.</dd> 
    738738       
    739739        <dt><a href="rotation.html?format=raw">rotation.pro</a></dt> 
    740         <dd></dd> 
     740        <dd>  Rotate two vectors by a specified amount.</dd> 
    741741       
    742742        <dt><a href="saveatt.html?format=raw">saveatt.pro</a></dt> 
    743         <dd></dd> 
     743        <dd>  Allows to put in a structure attributes which can be associated with a variable.</dd> 
    744744       
    745745        <dt><a href="terminedessin.html?format=raw">terminedessin.pro</a></dt> 
    746         <dd></dd> 
     746        <dd>  End the drawing if needed when it is a postscript.</dd> 
    747747       
    748748      </dl> 
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/givewindowsize.html

    r138 r142  
    709709         
    710710 
    711         <div class="routine_details" id="_givewindowsize"> 
    712  
    713           <h2><a class="top" href="#container">top</a>givewindowsize </h2> 
     711        <div class="routine_details" id="_          -1"> 
     712 
     713          <h2><a class="top" href="#container">top</a>          -1 <span class="warning">obsolete</span> <span class="warning">abstract</span> <span class="warning">private</span> <span class="categories">          -1</span></h2> 
    714714         
    715715          <p class="header"> 
    716             <span class="result">result = </span>givewindowsize()</p> 
     716            <span class="result">result = </span>          -1()</p> 
    717717         
    718           <div class="comments"></div> 
     718          <div class="comments preformat">          -1</div> 
     719 
     720          <h3>Return value</h3><div class="preformat">          -1</div> 
    719721 
    720722           
     
    722724           
    723725 
    724            
    725  
    726            
    727            
    728            
    729            
    730            
    731            
    732            
    733            
    734            
    735            
    736            
    737            
     726          <h3>Examples</h3><div class="preformat">          -1</div> 
     727          <h3>Version history</h3> 
     728          <h4>Author</h4><div class="preformat">          -1</div> 
     729          <h4>Version</h4><div class="preformat">2.0</div> 
     730          <h4>History</h4><div class="preformat">          -1</div> 
     731          <h4>Copyright</h4><div class="preformat">          -1</div> 
     732          <h4>Customer ID</h4><div class="preformat">          -1</div> 
     733          <h3>Known issues</h3> 
     734          <h4>Obsolete</h4><div class="preformat">          -1</div> 
     735          <h4>Known bugs</h4><div class="preformat">          -1</div> 
     736          <h4>Todo items</h4><div class="preformat">          -1</div> 
     737          <h4>Restrictions</h4><div class="preformat">          -1</div> 
    738738         
    739            
    740            
    741            
    742            
    743            
    744            
    745            
     739          <h3>Other attributes</h3> 
     740          <h4>Inherits classes</h4><div class="preformat">          -1</div> 
     741          <h4>Requires IDL version</h4><div class="preformat">          -1</div> 
     742          <h4>Uses routines</h4><div class="preformat">          -1</div> 
     743          <h4>Pre-condition</h4><div class="preformat">          -1</div> 
     744          <h4>Post-condition</h4><div class="preformat">          -1</div> 
     745          <h4>Common blocks used</h4><div class="preformat">          -1</div> 
    746746         
     747          <h3>Statistics</h3> 
     748          <table class="statistics"> 
     749            <tr><td>McCabe cyclic</td><td>          -1</td></tr> 
     750            <tr><td>McCabe essential</td><td>          -1</td></tr> 
     751            <tr><td>McCabe modular design</td><td>          -1</td></tr> 
     752          </table> 
    747753           
    748754         
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/meridienparallele.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Trace some meridians or parallel 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_meridienparallele"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>meridienparallele </h2> 
     715          <h2><a class="top" href="#container">top</a>meridienparallele <span class="categories"> 
     716 graphic 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:meridienparallele 
    720  
    721  PURPOSE:trace certains medidiens ou paralles 
    722  
    723  CATEGORY: 
    724  
    725  CALLING SEQUENCE:meridienparallele, coupe 
    726  
    727  INPUTS:coupe: le type de dessin que l''on traite 
    728  
    729  COMMON BLOCKS: 
    730         common.pro 
    731723</div> 
    732724 
     
    748740            </h4> 
    749741         
    750           <div class="comments"></div> 
     742          <div class="comments"> The type of drawing we treat 
     743</div> 
    751744             
    752745 
     
    756749 
    757750           
    758            
    759            
    760            
    761            
    762            
    763            
    764            
    765            
    766            
    767            
    768            
    769          
    770            
    771            
    772            
    773            
     751          <h3>Version history</h3> 
     752           
     753          <h4>Version</h4><div class="preformat"> 
     754 $Id$ 
     755</div> 
     756          <h4>History</h4><div class="preformat"></div> 
     757           
     758           
     759           
     760           
     761           
     762           
     763           
     764         
     765          <h3>Other attributes</h3> 
     766           
     767           
     768          <h4>Uses routines</h4><div class="preformat"> 
     769 common.pro 
     770</div> 
    774771           
    775772           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/placecolor.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 allows to trace the independently from a graph 
     700 By default, trace a color bar of the same type tahn the one present in plt 
     701 and pltz. If max, min and divisions are not stipulated, then max=sup,min=inf 
     702 and divisions=div. 
     703</div> 
    699704 
    700705       
     
    711716        <div class="routine_details" id="_placecolor"> 
    712717 
    713           <h2><a class="top" href="#container">top</a>placecolor </h2> 
     718          <h2><a class="top" href="#container">top</a>placecolor <span class="categories"> 
     719 graphic 
     720</span></h2> 
    714721         
    715722          <p class="header"> 
     
    717724         
    718725          <div class="comments"> 
    719  NAME:PLACECOLOR 
    720  
    721  PURPOSE:permet de tracer la colorbar independammment d'un graphe 
    722  
    723  CATEGORY:graph 
    724  
    725  CALLING SEQUENCE:placecolor,pos 
    726  
    727  INPUTS: 
    728         pos:vecteur de 4 elements donnant les coordonnees du coin en bas 
    729  a gauche et de celui en haut a droite -en cm- ds lequel on veut faire la 
    730  barre de couleur 
    731  
    732  KEYWORD PARAMETERS: tous ceux de colorbar.pro. 
    733  
    734  par defaut trace une barre de couleur du meme type que celle presente ds plt 
    735  et pltz. si max, min et divisions ne sont pas stipulees alors max=sup,min=inf 
    736  et divisions=div 
    737  
    738  OUTPUTS: 
    739  
    740  COMMON BLOCKS: 
    741         common.pro 
    742  
    743  SIDE EFFECTS: 
    744  
    745  RESTRICTIONS:utilisable que pour les POSTCRIPT effectues avec plein2dessin 
    746  
    747  EXAMPLE: 
    748726</div> 
    749727 
     
    765743            </h4> 
    766744         
    767           <div class="comments"></div> 
     745          <div class="comments"> 
     746 Vecteur composed by 4 elements giving coordinates of the left bottom  
     747 corner and of the right up one -in cm- in which we want to do the color bar 
     748</div> 
    768749             
    769750 
     
    785766            </h4> 
    786767         
    787             <div class="comments"></div> 
     768            <div class="comments"> 
     769 used to pass your keywords 
     770</div> 
    788771             
    789772           
    790773 
    791774           
    792            
    793            
    794            
    795            
    796            
    797            
    798            
    799            
    800            
    801            
    802            
    803          
    804            
    805            
    806            
    807            
     775          <h3>Version history</h3> 
     776           
     777          <h4>Version</h4><div class="preformat"> 
     778 $Id$ 
     779</div> 
     780          <h4>History</h4><div class="preformat"></div> 
     781           
     782           
     783          <h3>Known issues</h3> 
     784           
     785           
     786           
     787          <h4>Restrictions</h4><div class="preformat"> 
     788 Only usable for POSTCRIPTs effectuated with plein2dessin 
     789</div> 
     790         
     791          <h3>Other attributes</h3> 
     792           
     793           
     794          <h4>Uses routines</h4><div class="preformat"> 
     795 common.pro 
     796</div> 
    808797           
    809798           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/placedessin.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments">  
     699 Putting into place of the drawing/ opening of the window or of the PS 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_placedessin"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>placedessin </h2> 
     715          <h2><a class="top" href="#container">top</a>placedessin <span class="categories">  
     716 Utilities 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:placedessin 
    720  
    721  PURPOSE: mise en place du dessin / ouverture de la fenetre ou du PS 
    722  
    723  CATEGORY: pour alleger les programmes plt, pltz, pltt. 
    724  
    725  CALLING SEQUENCE: placedessin, typedessin,posfenetre, posbar 
    726  
    727  INPUTS: 
    728    typedessin: une chaine de charactere specifiant quelle procedure 
    729    appelle placedessin: 'plt', 'pltz', 'pltt' 
    730  
    731  KEYWORD PARAMETERS: pleins (ce de CALIBRE de WINDOW ...) 
    732  
    733        LCT: intier designant le numero de la palette de couleur que 
    734        l''on veut utiliser pour les plot.  
    735          
    736  OUTPUTS: 
    737  
    738        posfenetre: un vecteur de 4 elements contenant la position de 
    739        cadre contenant les legendes + le graphe en coordonnes 
    740        normalises. Rq: pour positionner le dessin il faut apres 
    741        l''appelle de calibre faire !p.position=posfenetre 
    742  
    743        posbar: cf posfentre mais pour la barre de couleur. meme 
    744        remarque pour positionner la barre de couleur, !p.position=posbar 
    745  
    746  
    747  COMMON BLOCKS: 
    748         common.pro 
    749  
    750  SIDE EFFECTS: 
    751  
    752  RESTRICTIONS: 
    753  
    754  EXAMPLE: 
    755723</div> 
    756724 
     
    772740            </h4> 
    773741         
    774           <div class="comments"></div> 
     742          <div class="comments"> 
     743 It is a chain or characteres specifying what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
     744</div> 
    775745             
    776746            <h4 id="_placedessin_param_posfenetre">posfenetre&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    777747               
    778                
    779                
    780                
    781                
    782                
    783                
    784                
    785             </h4> 
    786          
    787           <div class="comments"></div> 
     748              <span class="attr">out</span> 
     749               
     750               
     751               
     752               
     753               
     754               
     755            </h4> 
     756         
     757          <div class="comments"> 
     758 It is a vector composed by 4 elements containing the position of the frame  
     759 containing captions and the graph in normalized coorinates.  
     760 Comment: To position the drawing; we have to do !p.position=posfenetre  
     761 after the call of the caliber 
     762</div> 
    788763             
    789764            <h4 id="_placedessin_param_posbar">posbar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    790765               
    791                
    792                
    793                
    794                
    795                
    796                
    797                
    798             </h4> 
    799          
    800           <div class="comments"></div> 
     766              <span class="attr">out</span> 
     767               
     768               
     769               
     770               
     771               
     772               
     773            </h4> 
     774         
     775          <div class="comments"> 
     776 Like POSFENETRE but for the color bar.  
     777 Same comment to position the color bar, !p.position=posbar 
     778</div> 
    801779             
    802780 
     
    831809            </h4> 
    832810         
     811            <div class="comments">  
     812 We active it if we do not want the colorbar. 
     813</div> 
     814             
     815            <h4 id="_placedessin_keyword_NOFILL">NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     816               
     817               
     818               
     819               
     820               
     821               
     822               
     823               
     824            </h4> 
     825         
     826            <div class="comments">  
     827 We active it if we only want contours in black and white with a white background. 
     828</div> 
     829             
     830            <h4 id="_placedessin_keyword_COLOR_c">COLOR_c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     831               
     832               
     833               
     834               
     835               
     836               
     837               
     838               
     839            </h4> 
     840         
     841            <div class="comments">  
     842 To draw the contour in color instead of in black 
     843 with filling in color  
     844</div> 
     845             
     846            <h4 id="_placedessin_keyword_CONTOUR">CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     847               
     848               
     849               
     850               
     851               
     852               
     853               
     854               
     855            </h4> 
     856         
     857            <div class="comments">  
     858 If we want to trace contours of a different field than the one  
     859 whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
     860 It must be a field respecting same caracteristics than the argument number one of plt. 
     861</div> 
     862             
     863            <h4 id="_placedessin_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     864               
     865               
     866               
     867               
     868               
     869               
     870               
     871               
     872            </h4> 
     873         
     874            <div class="comments"> is also appropriated. 
     875</div> 
     876             
     877            <h4 id="_placedessin_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     878               
     879               
     880               
     881               
     882               
     883               
     884               
     885               
     886            </h4> 
     887         
     888            <div class="comments">  
     889 Force the page or the window to be in standing position. 
     890</div> 
     891             
     892            <h4 id="_placedessin_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     893               
     894               
     895               
     896               
     897               
     898               
     899               
     900               
     901            </h4> 
     902         
     903            <div class="comments">  
     904 Force the page or the window on the screen to be in lenthened position. 
     905</div> 
     906             
     907            <h4 id="_placedessin_keyword_SMALL">SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     908               
     909               
     910               
     911               
     912               
     913               
     914               
     915               
     916            </h4> 
     917         
     918            <div class="comments">  
     919 Vector composed of 3 or 4 elements, applyed to make a drawing on a  
     920 small portion of a page or screen. It delimit the zone where the drawing will be done. 
     921     If there is 4 elements: 
     922 then is constituated of coordinates (expressed in cm located from the up and  
     923 left corner of the page or the window (in portrait like in lanscape)) of the bottom  
     924 and left corner and of the up and right corner of the drawing zone. 
     925     If there is 3 elements: 
     926 in this case, we divide the page or the screen in small[0] columns and in small[1] lines  
     927 the drawing made in the box numbered small[2]. The numerotation starting up and left by  
     928 the number 1 and then, following the writing direction. 
     929 By default, we make the largest drawing we can do, conserving the aspect rapport  
     930 (exept when REMPLI is activated). 
     931 </div> 
     932             
     933            <h4 id="_placedessin_keyword_MARGES">MARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     934               
     935               
     936               
     937               
     938               
     939               
     940               
     941               
     942            </h4> 
     943         
    833944            <div class="comments"></div> 
    834945             
    835             <h4 id="_placedessin_keyword_NOFILL">NOFILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     946            <h4 id="_placedessin_keyword_MAP">MAP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     947               
     948               
     949               
     950               
     951               
     952               
     953               
     954               
     955            </h4> 
     956         
     957            <div class="comments">  
     958 We use it when we want to do a projection. 
     959 This keyword can be of two types: 
     960     MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET). 
     961     /MAP: In this case, map is automatically caculated have the value:  
     962          map = [0, (lon1+lon2)/2., 0] 
     963 Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
     964 IDL> demo 
     965 Then choose earth sciences and  mapping. 
     966 Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map).  
     967 If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
     968 For example, for a polar projection centered on the south pole: 
     969 IDL> domdef,-180,180,-90,-45 
     970 IDL> plt, tab, /stereo,map=[-90,0,0] 
     971        </div> 
     972             
     973            <h4 id="_placedessin_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     974               
     975               
     976               
     977               
     978               
     979               
     980               
     981               
     982            </h4> 
     983         
     984            <div class="comments">  
     985 Force the drawing to occupy the whole space defined by small. 
     986</div> 
     987             
     988            <h4 id="_placedessin_keyword_POST">POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     989               
     990               
     991               
     992               
     993               
     994               
     995               
     996               
     997            </h4> 
     998         
     999            <div class="comments">  
     1000 Make a postscript. Only works if we made one drawing on the page. 
     1001 If we make several drawing, use @ps. 
     1002</div> 
     1003             
     1004            <h4 id="_placedessin_keyword_WINDOW">WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1005               
     1006               
     1007               
     1008               
     1009               
     1010               
     1011               
     1012               
     1013            </h4> 
     1014         
     1015            <div class="comments"> 
     1016 Number of the window on which we want to do the graph (Allow to open several windows).  
     1017 By default, we open 'IDL0' 
     1018</div> 
     1019             
     1020            <h4 id="_placedessin_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1021               
     1022               
     1023               
     1024               
     1025               
     1026               
     1027               
     1028               
     1029            </h4> 
     1030         
     1031            <div class="comments">  
     1032 keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
     1033 of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     1034 coordinates.  
     1035</div> 
     1036             
     1037            <h4 id="_placedessin_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    8361038               
    8371039               
     
    8461048            <div class="comments"></div> 
    8471049             
    848             <h4 id="_placedessin_keyword_COLOR_c">COLOR_c&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1050            <h4 id="_placedessin_keyword_BASICMARGES">BASICMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    8491051               
    8501052               
     
    8591061            <div class="comments"></div> 
    8601062             
    861             <h4 id="_placedessin_keyword_CONTOUR">CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    862                
    863                
    864                
    865                
    866                
    867                
    868                
    869                
    870             </h4> 
    871          
    872             <div class="comments"></div> 
    873              
    874             <h4 id="_placedessin_keyword_VECTEUR">VECTEUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    875                
    876                
    877                
    878                
    879                
    880                
    881                
    882                
    883             </h4> 
    884          
    885             <div class="comments"></div> 
    886              
    887             <h4 id="_placedessin_keyword_PORTRAIT">PORTRAIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    888                
    889                
    890                
    891                
    892                
    893                
    894                
    895                
    896             </h4> 
    897          
    898             <div class="comments"></div> 
    899              
    900             <h4 id="_placedessin_keyword_LANDSCAPE">LANDSCAPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    901                
    902                
    903                
    904                
    905                
    906                
    907                
    908                
    909             </h4> 
    910          
    911             <div class="comments"></div> 
    912              
    913             <h4 id="_placedessin_keyword_SMALL">SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    914                
    915                
    916                
    917                
    918                
    919                
    920                
    921                
    922             </h4> 
    923          
    924             <div class="comments"></div> 
    925              
    926             <h4 id="_placedessin_keyword_MARGES">MARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    927                
    928                
    929                
    930                
    931                
    932                
    933                
    934                
    935             </h4> 
    936          
    937             <div class="comments"></div> 
    938              
    939             <h4 id="_placedessin_keyword_MAP">MAP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    940                
    941                
    942                
    943                
    944                
    945                
    946                
    947                
    948             </h4> 
    949          
    950             <div class="comments"></div> 
    951              
    952             <h4 id="_placedessin_keyword_REMPLI">REMPLI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    953                
    954                
    955                
    956                
    957                
    958                
    959                
    960                
    961             </h4> 
    962          
    963             <div class="comments"></div> 
    964              
    965             <h4 id="_placedessin_keyword_POST">POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    966                
    967                
    968                
    969                
    970                
    971                
    972                
    973                
    974             </h4> 
    975          
    976             <div class="comments"></div> 
    977              
    978             <h4 id="_placedessin_keyword_WINDOW">WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    979                
    980                
    981                
    982                
    983                
    984                
    985                
    986                
    987             </h4> 
    988          
    989             <div class="comments"></div> 
    990              
    991             <h4 id="_placedessin_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    992                
    993                
    994                
    995                
    996                
    997                
    998                
    999                
    1000             </h4> 
    1001          
    1002             <div class="comments"></div> 
    1003              
    1004             <h4 id="_placedessin_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1005                
    1006                
    1007                
    1008                
    1009                
    1010                
    1011                
    1012                
    1013             </h4> 
    1014          
    1015             <div class="comments"></div> 
    1016              
    1017             <h4 id="_placedessin_keyword_BASICMARGES">BASICMARGES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1018                
    1019                
    1020                
    1021                
    1022                
    1023                
    1024                
    1025                
    1026             </h4> 
    1027          
    1028             <div class="comments"></div> 
    1029              
    10301063            <h4 id="_placedessin_keyword_NOERASE">NOERASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10311064               
     
    10391072            </h4> 
    10401073         
    1041             <div class="comments"></div> 
     1074            <div class="comments">  
     1075 We active it to make a drawing without creating a new frame. 
     1076</div> 
    10421077             
    10431078            <h4 id="_placedessin_keyword_LCT">LCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10521087            </h4> 
    10531088         
    1054             <div class="comments"></div> 
     1089            <div class="comments">  
     1090 Is an integer designating the number of the palette of color we want to use for the plot.  
     1091        </div> 
    10551092             
    10561093            <h4 id="_placedessin_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10651102            </h4> 
    10661103         
    1067             <div class="comments"></div> 
     1104            <div class="comments"> 
     1105 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 
     1106       'xzt' 'yzt' 'xyzt' Direction on which do averages  
     1107</div> 
    10681108             
    10691109            <h4 id="_placedessin_keyword_CB_TITLE">CB_TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10781118            </h4> 
    10791119         
    1080             <div class="comments"></div> 
     1120            <div class="comments">  
     1121 The colorbar's title 
     1122</div> 
    10811123             
    10821124            <h4 id="_placedessin_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10911133            </h4> 
    10921134         
    1093             <div class="comments"></div> 
    1094              
    1095            
    1096  
    1097            
    1098            
    1099            
    1100            
    1101            
    1102            
    1103            
    1104            
    1105            
    1106            
    1107            
    1108            
    1109          
    1110            
    1111            
    1112            
    1113            
     1135            <div class="comments"> 
     1136 Used to pass your keywords. 
     1137</div> 
     1138             
     1139           
     1140 
     1141           
     1142          <h3>Version history</h3> 
     1143           
     1144          <h4>Version</h4><div class="preformat"> 
     1145 $Id$ 
     1146</div> 
     1147          <h4>History</h4><div class="preformat"></div> 
     1148           
     1149           
     1150           
     1151           
     1152           
     1153           
     1154           
     1155         
     1156          <h3>Other attributes</h3> 
     1157           
     1158           
     1159          <h4>Uses routines</h4><div class="preformat"> 
     1160 common.pro 
     1161</div> 
    11141162           
    11151163           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/projsegment.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 project linearly a segment, a vector whose boundaries are [a,b] on  
     700 a vector whose boundaries are [c,d] 
     701</div> 
    699702 
    700703       
     
    711714        <div class="routine_details" id="_projsegment"> 
    712715 
    713           <h2><a class="top" href="#container">top</a>projsegment </h2> 
     716          <h2><a class="top" href="#container">top</a>projsegment <span class="categories"> 
     717 calculation 
     718</span></h2> 
    714719         
    715720          <p class="header"> 
    716721            <span class="result">result = </span>projsegment(<span class="result"><a href="#_projsegment_param_vecteur">vecteur</a>, <a href="#_projsegment_param_bornes">bornes</a></span>, <a href="#_projsegment_keyword_MP">MP</a>=<span class="result">MP</span>)</p> 
    717722         
    718           <div class="comments"></div> 
    719  
    720            
     723          <div class="comments"> 
     724</div> 
     725 
     726          <h3>Return value</h3><div class="preformat">  
     727 A vector whose new boudaries are specified by BORNES. 
     728</div> 
    721729 
    722730           
     
    735743            </h4> 
    736744         
    737           <div class="comments"></div> 
     745          <div class="comments"> 
     746 A vector whose the first element must be the smallest one and the last must be the biggest one. 
     747</div> 
    738748             
    739749            <h4 id="_projsegment_param_bornes">bornes&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    748758            </h4> 
    749759         
    750           <div class="comments"></div> 
     760          <div class="comments">  
     761 New boundaries of the vector. 
     762</div> 
    751763             
    752764 
     
    768780            </h4> 
    769781         
    770             <div class="comments"></div> 
     782            <div class="comments"> 
     783 Activate this keyword to the function send back this a vector of 2  
     784 elements which are the m and p of the linear projection y=mx+p used  
     785 to pass from the [a,b] segment to the [c,d] segment. 
     786</div> 
    771787             
    772788           
    773789 
    774            
    775            
    776            
    777            
    778            
     790          <h3>Examples</h3><div class="preformat"> 
     791    
     792   IDL> a=indgen(9)  
     793   IDL> print, a  
     794          0       1       2       3       4       5       6       7       8 
     795   IDL> print, projsegment(a,[0,80])  
     796          0      10      20      30      40      50      60      70      80 
     797   IDL> print, projsegment(a,[0,-80])   
     798          0     -10     -20     -30     -40     -50     -60     -70     -80 
     799   IDL> print, projsegment(a,[-80,0])    
     800        -80     -70     -60     -50     -40     -30     -20     -10      0 
     801</div> 
     802          <h3>Version history</h3> 
     803           
     804          <h4>Version</h4><div class="preformat"> 
     805 $Id$ 
     806</div> 
     807          <h4>History</h4><div class="preformat"></div> 
    779808           
    780809           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/restoreatt.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Allows to reattribuate global variables associated with a field  
     700 when we give a stucture created by saveatt.pro by example. 
     701</div> 
    699702 
    700703       
     
    711714        <div class="routine_details" id="_restoreatt"> 
    712715 
    713           <h2><a class="top" href="#container">top</a>restoreatt </h2> 
     716          <h2><a class="top" href="#container">top</a>restoreatt <span class="categories">  
     717 Utilities 
     718</span></h2> 
    714719         
    715720          <p class="header"> 
     
    717722         
    718723          <div class="comments"> 
    719  NAME:restoreatt 
    720  
    721  PURPOSE:permet de reattribuer les variables globales associees a un 
    722  champ qd on donne une stucture cree par ex par saveatt.pro. 
    723  
    724  CATEGORY:allegement d''ecriture 
    725  
    726  CALLING SEQUENCE:restoreatt, structure 
    727  
    728  INPUTS:une structure comme celle que lit litchamp.  
    729         cf. IDL> xhelp,'litchamp' 
    730  
    731  COMMON BLOCKS: 
    732         common.pro 
    733  
    734  SIDE EFFECTS: change la valeur des variables globales attributs 
    735  d''un champ: vargrid, varname, varunit, vardate, varexp , valmask, 
    736  et time 
    737724</div> 
    738725 
     
    744731             
    745732            <h4 id="_restoreatt_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     733              <span class="attr">in</span> 
    746734               
    747735               
    748                
    749                
     736              <span class="attr">required</span> 
    750737               
    751738               
     
    754741            </h4> 
    755742         
    756           <div class="comments"></div> 
     743          <div class="comments"> 
     744 a structure like the one who read litchamp.  
     745        See IDL> xhelp,'litchamp' 
     746</div> 
    757747             
    758748 
     
    762752 
    763753           
    764            
    765            
    766            
    767            
    768            
    769            
    770            
    771            
    772            
    773            
    774            
    775          
    776            
    777            
    778            
    779            
     754          <h3>Version history</h3> 
     755           
     756          <h4>Version</h4><div class="preformat"> 
     757 $Id$ 
     758</div> 
     759          <h4>History</h4><div class="preformat"></div> 
     760           
     761           
     762          <h3>Known issues</h3> 
     763           
     764           
     765           
     766          <h4>Restrictions</h4><div class="preformat"> 
     767 Change the value if global variables attribute of a field: vargrid,  
     768 varname, varunit, vardate, varexp , valmask and time. 
     769</div> 
     770         
     771          <h3>Other attributes</h3> 
     772           
     773           
     774          <h4>Uses routines</h4><div class="preformat"> 
     775 common.pro 
     776</div> 
    780777           
    781778           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/rotation.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Rotate two vectors by a specified amount. 
     700            </div> 
    699701 
    700702       
     
    717719         
    718720          <div class="comments"> 
    719  NAME: 
    720  
    721            ROTATION 
    722   
    723  PURPOSE: 
    724   
    725             Rotate two vectors by a specified amount. 
    726              
    727  CALLING SEQUENCE: 
    728   
    729             ROTATION,X,Y,DEG,NX,NY 
    730              
    731  INPUTS: 
    732  
    733            X,Y   :orignal data point pairs 
    734             
    735             DEG   :degrees to rotate. 
    736              
    737  OUTPUTS: 
    738   
    739             Nx, Ny = rotated point pairs. 
    740              
    741  MODIFICATION HISTORY: 
    742   
    743             Jeff Bennett, U of Colorado</div> 
     721</div> 
    744722 
    745723           
     
    750728             
    751729            <h4 id="_ROTATION_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    752                
    753                
    754                
    755                
     730              <span class="attr">in</span> 
     731               
     732               
     733              <span class="attr">required</span> 
    756734               
    757735               
     
    760738            </h4> 
    761739         
    762           <div class="comments"></div> 
     740          <div class="comments"> 
     741 orignal data point pairs 
     742</div> 
    763743             
    764744            <h4 id="_ROTATION_param_Y">Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    765                
    766                
    767                
    768                
     745              <span class="attr">in</span> 
     746               
     747               
     748              <span class="attr">required</span> 
    769749               
    770750               
     
    773753            </h4> 
    774754         
    775           <div class="comments"></div> 
     755          <div class="comments"> 
     756 orignal data point pairs 
     757           </div> 
    776758             
    777759            <h4 id="_ROTATION_param_DEG">DEG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    778                
    779                
    780                
    781                
     760              <span class="attr">in</span> 
     761               
     762               
     763              <span class="attr">required</span> 
    782764               
    783765               
     
    786768            </h4> 
    787769         
    788           <div class="comments"></div> 
     770          <div class="comments"> 
     771 degrees to rotate. 
     772            </div> 
    789773             
    790774            <h4 id="_ROTATION_param_NX">NX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    791775               
    792                
     776              <span class="attr">out</span> 
    793777               
    794778               
     
    799783            </h4> 
    800784         
    801           <div class="comments"></div> 
     785          <div class="comments"> 
     786 rotated point pairs. 
     787 </div> 
    802788             
    803789            <h4 id="_ROTATION_param_NY">NY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    804790               
    805                
     791              <span class="attr">out</span> 
    806792               
    807793               
     
    812798            </h4> 
    813799         
    814           <div class="comments"></div> 
     800          <div class="comments"> 
     801 rotated point pairs. 
     802            </div> 
    815803             
    816804 
     
    820808 
    821809           
    822            
    823            
    824            
    825            
     810          <h3>Version history</h3> 
     811           
     812          <h4>Version</h4><div class="preformat"> 
     813 $Id$ 
     814</div> 
     815          <h4>History</h4><div class="preformat"> 
     816 Jeff Bennett, U of Colorado 
     817</div> 
    826818           
    827819           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/saveatt.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Allows to put in a structure attributes which can be associated with a variable. 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_saveatt"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>saveatt </h2> 
     715          <h2><a class="top" href="#container">top</a>saveatt <span class="categories"> 
     716 utilities 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:saveatt 
    720  
    721  PURPOSE:permet de mettre dans une structure les attributs qui peuvent 
    722  etre associes a une variable. 
    723  
    724  CATEGORY:allegement d''ecriture 
    725  
    726  CALLING SEQUENCE:res=saveatt() 
    727  
    728  OUTPUTS: 
    729     une stucture de la forme: 
     723</div> 
     724 
     725          <h3>Return value</h3><div class="preformat">  
     726 A structure of the form: 
    730727         {n:varname,g:vargrid,d:vardate,e:varexp,u:varunit,m:valmask,l:niveau} 
    731  
    732  COMMON BLOCKS: 
    733         common.pro 
    734728</div> 
    735729 
     
    739733 
    740734           
    741  
    742            
    743            
    744            
    745            
    746            
     735          <h3>Version history</h3> 
     736           
     737          <h4>Version</h4><div class="preformat"> 
     738 $Id$ 
     739</div> 
     740          <h4>History</h4><div class="preformat"></div> 
    747741           
    748742           
     
    753747           
    754748         
    755            
    756            
    757            
    758            
     749          <h3>Other attributes</h3> 
     750           
     751           
     752          <h4>Uses routines</h4><div class="preformat"> 
     753 common.pro 
     754</div> 
    759755           
    760756           
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DIVERS/terminedessin.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 End the drawing if needed when it is a postscript. 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_terminedessin"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>terminedessin </h2> 
     715          <h2><a class="top" href="#container">top</a>terminedessin <span class="categories"> 
     716 utilities, graphic 
     717</span></h2> 
    714718         
    715719          <p class="header"> 
     
    717721         
    718722          <div class="comments"> 
    719  NAME:terminedessin 
    720  
    721  PURPOSE:termnine le dessin si besion est qd c''est un postcsript. 
    722  
    723  CATEGORY:mise en forme et allegement de l''ecrityre de plt, pltz et pltt 
    724  
    725  CALLING SEQUENCE:terminedessin 
    726  
    727  INPUTS: 
    728  
    729  KEYWORD PARAMETERS:POST et SMALL cf l''aide de plt 
    730  
    731  OUTPUTS: 
    732  
    733  COMMON BLOCKS: 
    734         common.pro 
    735  
    736  SIDE EFFECTS: 
    737  
    738  RESTRICTIONS: 
    739  
    740  EXAMPLE: 
    741723</div> 
    742724 
     
    760742            </h4> 
    761743         
    762             <div class="comments"></div> 
     744            <div class="comments">  
     745 Make a postscript. Only works if we made one drawing on the page. 
     746 If we make several drawing, use @ps. 
     747</div> 
    763748             
    764749            <h4 id="_terminedessin_keyword_SMALL">SMALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    773758            </h4> 
    774759         
    775             <div class="comments"></div> 
     760            <div class="comments">  
     761 Vector composed of 3 or 4 elements, applyed to make a drawing on a  
     762 small portion of a page or screen. It delimit the zone where the drawing will be done. 
     763     If there is 4 elements: 
     764 then is constituated of coordinates (expressed in cm located from the up and  
     765 left corner of the page or the window (in portrait like in lanscape)) of the bottom  
     766 and left corner and of the up and right corner of the drawing zone. 
     767     If there is 3 elements: 
     768 in this case, we divide the page or the screen in small[0] columns and in small[1] lines  
     769 the drawing made in the box numbered small[2]. The numerotation starting up and left by  
     770 the number 1 and then, following the writing direction. 
     771 By default, we make the largest drawing we can do, conserving the aspect rapport  
     772 (exept when REMPLI is activated). 
     773</div> 
    776774             
    777775            <h4 id="_terminedessin_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    786784            </h4> 
    787785         
    788             <div class="comments"></div> 
     786            <div class="comments">  
     787 Used to pass your keywords 
     788</div> 
    789789             
    790790           
    791791 
    792792           
    793            
    794            
    795            
    796            
    797            
    798            
    799            
    800            
    801            
    802            
    803            
    804          
    805            
    806            
    807            
    808            
     793          <h3>Version history</h3> 
     794           
     795          <h4>Version</h4><div class="preformat"> 
     796 $Id$ 
     797</div> 
     798          <h4>History</h4><div class="preformat"></div> 
     799           
     800           
     801           
     802           
     803           
     804           
     805           
     806         
     807          <h3>Other attributes</h3> 
     808           
     809           
     810          <h4>Uses routines</h4><div class="preformat"> 
     811 common.pro 
     812</div> 
    809813           
    810814           
Note: See TracChangeset for help on using the changeset viewer.