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

english and nicer header (2a)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/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           
Note: See TracChangeset for help on using the changeset viewer.