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/DESSINE/tvplus.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Enhanced version of tvscl 
     700</div> 
    699701 
    700702       
     
    711713        <div class="routine_details" id="_tvplus"> 
    712714 
    713           <h2><a class="top" href="#container">top</a>tvplus </h2> 
     715          <h2><a class="top" href="#container">top</a>tvplus <span class="categories"> quick exploration of 2D arrays  
     716 
     717 INPUTS:  
     718</span></h2> 
    714719         
    715720          <p class="header"> 
     
    717722         
    718723          <div class="comments"> 
    719  NAME: tvplus 
    720  
    721  PURPOSE: enhanced version of tvscl 
    722  
    723  CATEGORY: quick exploration of 2D arrays  
    724  
    725  CALLING SEQUENCE: tvplus,z2d [,cellsize] 
    726  
    727  INPUTS:  
    728  
    729     z2d: 2D array to visualize 
    730  
    731     cellsize: (optional) this is the size (in pixel) of the square 
    732     representing 1 array element. By default, this size is computed 
    733     automatically in order that the size of the plotting window do 
    734     not exceed the screen size. If the user specify a large value 
    735     of cellsize that forces tvplus to create a window larger than 
    736     the screen, a "scrolling window" will be displayed instead of a 
    737     regular window. Unfortunately the nice fonctionnalities of tvplus 
    738     are not coded for "scrolling window" case... 
    739  
    740  KEYWORD PARAMETERS: 
    741  
    742        BOTTOM: The lowest color index of the colors to be loaded in 
    743        the bar. default is 0. 
    744  
    745        C_NAN: The color number that should be used for the NaN values. 
    746        default value is !d.n_colors < 255 
    747  
    748        C_MASK: The color number that should be used for the mask values. 
    749        default value is 0 
    750  
    751        OFFSET: 2 elements vector used by tvplus itself when shoing zoom. 
    752        It is used to shift the ranges of xaxis and yaxis. 
    753        For example: tvplus,sst[x1:x2,y1:y2],offest=[x1,y1] 
    754  
    755        MASK: The mask value. Note that if abs(mask) < 1.e6, then the 
    756        exact value of the mask is used to find the maskwd point. 
    757        if abs(mask) > 1.e6, the test to find the masked value is ge 
    758        abs(mask)/10. This is necessary to avoid the rounding errors 
    759  
    760        MIN and MAX: scalars used to specify the min and max values 
    761        of the color bar. default is from 0 to !d.n_colors < 255 
    762  
    763        NCOLORS:  This is the number of colors in the color 
    764        bar. default is !d.n_colors<255 -1 
    765  
    766        NOINTERP: used this keyword if you don't whant that the values 
    767        are interpolated between 0 (or min) and !d.n_colors < 255 (or max). 
    768        This can be for example usefull when working on byte type arrays. 
    769  
    770        NOUSEINFOS: activite to supress the printed message explaining 
    771        how to use tvplus 
    772  
    773         WINDOW: Number of the window used to display the array values. 
    774        default is window number 0. 
    775  
    776  OUTPUTS: no (except the printed finformations, see below) 
    777  
    778  COMMON BLOCKS: no 
    779  
    780  SIDE EFFECTS: 
    781  
     724</div> 
     725 
     726           
     727 
     728           
     729            <h3>Parameters</h3> 
     730         
     731             
     732            <h4 id="_tvplus_param_z2d">z2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     733              <span class="attr">in</span> 
     734               
     735               
     736              <span class="attr">required</span> 
     737               
     738               
     739               
     740               
     741            </h4> 
     742         
     743          <div class="comments"> 
     744 2D array to visualize 
     745</div> 
     746             
     747            <h4 id="_tvplus_param_cellsize">cellsize&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     748              <span class="attr">in</span> 
     749               
     750               
     751               
     752               
     753               
     754               
     755               
     756            </h4> 
     757         
     758          <div class="comments"> 
     759 This is the size (in pixel) of the square 
     760 representing 1 array element. By default, this size is computed 
     761 automatically in order that the size of the plotting window do 
     762 not exceed the screen size. If the user specify a large value 
     763 of cellsize that forces tvplus to create a window larger than 
     764 the screen, a "scrolling window" will be displayed instead of a 
     765 regular window. Unfortunately the nice fonctionnalities of tvplus 
     766 are not coded for "scrolling window" case... 
     767</div> 
     768             
     769 
     770           
     771 
     772           
     773 
     774            <h3>Keywords</h3> 
     775             
     776            <h4 id="_tvplus_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     777               
     778               
     779               
     780               
     781               
     782               
     783               
     784               
     785            </h4> 
     786         
     787            <div class="comments"> 
     788 The lowest color index of the colors to be loaded in 
     789 the bar. default is 0. 
     790</div> 
     791             
     792            <h4 id="_tvplus_keyword_C_MASK">C_MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     793               
     794               
     795               
     796               
     797               
     798               
     799               
     800               
     801            </h4> 
     802         
     803            <div class="comments"> 
     804 The color number that should be used for the mask values. 
     805 default value is 0 
     806</div> 
     807             
     808            <h4 id="_tvplus_keyword_C_NAN">C_NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     809               
     810               
     811               
     812               
     813               
     814               
     815               
     816               
     817            </h4> 
     818         
     819            <div class="comments"> 
     820 The color number that should be used for the NaN values. 
     821 default value is !d.n_colors < 255 
     822</div> 
     823             
     824            <h4 id="_tvplus_keyword_WINDOW">WINDOW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     825               
     826               
     827               
     828               
     829               
     830               
     831               
     832               
     833            </h4> 
     834         
     835            <div class="comments"> 
     836 Number of the window used to display the array values. 
     837 default is window number 0. 
     838</div> 
     839             
     840            <h4 id="_tvplus_keyword_MIN">MIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     841               
     842               
     843               
     844               
     845               
     846               
     847               
     848               
     849            </h4> 
     850         
     851            <div class="comments">  
     852 Scalar used to specify the min value of the color bar. default is 0 
     853</div> 
     854             
     855            <h4 id="_tvplus_keyword_MAX">MAX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     856               
     857               
     858               
     859               
     860               
     861               
     862               
     863               
     864            </h4> 
     865         
     866            <div class="comments"> 
     867 Scalar used to specify the max value of the color bar. default is !d.n_colors < 255 
     868</div> 
     869             
     870            <h4 id="_tvplus_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     871               
     872               
     873               
     874               
     875               
     876               
     877               
     878               
     879            </h4> 
     880         
     881            <div class="comments">  
     882 The mask value. Note that if abs(mask) < 1.e6, then the 
     883 exact value of the mask is used to find the maskwd point. 
     884 if abs(mask) > 1.e6, the test to find the masked value is ge 
     885 abs(mask)/10. This is necessary to avoid the rounding errors 
     886</div> 
     887             
     888            <h4 id="_tvplus_keyword_OFFSET">OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     889               
     890               
     891               
     892               
     893               
     894               
     895               
     896               
     897            </h4> 
     898         
     899            <div class="comments">  
     900 2 elements vector used by tvplus itself when shoing zoom. 
     901 It is used to shift the ranges of xaxis and yaxis. 
     902 For example: tvplus,sst[x1:x2,y1:y2],offest=[x1,y1] 
     903</div> 
     904             
     905            <h4 id="_tvplus_keyword_NOUSEINFOS">NOUSEINFOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     906               
     907               
     908               
     909               
     910               
     911               
     912               
     913               
     914            </h4> 
     915         
     916            <div class="comments"> 
     917 Activite to supress the printed message explaining how to use tvplus 
     918</div> 
     919             
     920            <h4 id="_tvplus_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     921               
     922               
     923               
     924               
     925               
     926               
     927               
     928               
     929            </h4> 
     930         
     931            <div class="comments"> 
     932 This is the number of colors in the color bar. default is !d.n_colors<255 -1 
     933</div> 
     934             
     935            <h4 id="_tvplus_keyword_NOINTERP">NOINTERP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     936               
     937               
     938               
     939               
     940               
     941               
     942               
     943               
     944            </h4> 
     945         
     946            <div class="comments"> 
     947 Used this keyword if you don't whant that the values 
     948 are interpolated between 0 (or min) and !d.n_colors < 255 (or max). 
     949 This can be for example usefull when working on byte type arrays. 
     950</div> 
     951             
     952            <h4 id="_tvplus_keyword__EXTRA">_EXTRA&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           
     966 
     967          <h3>Examples</h3><div class="preformat"> 
     968 IDL> tvplus, dist(100) 
     969</div> 
     970          <h3>Version history</h3> 
     971           
     972          <h4>Version</h4><div class="preformat"> 
     973 $Id$ 
     974</div> 
     975          <h4>History</h4><div class="preformat"></div> 
     976           
     977           
     978          <h3>Known issues</h3> 
     979           
     980           
     981           
     982          <h4>Restrictions</h4><div class="preformat">  
    782983 use your mouse to scan the array values... 
    783984     left button  : mouse position and associated array value 
     
    785986     right button : quit 
    786987 
    787  RESTRICTIONS: the nice fonctionnalities of tvplus are not coded 
    788                for "scrolling window" case... 
    789  
    790  EXAMPLE:  IDL> tvplus, dist(100) 
    791 </div> 
    792  
    793            
    794  
    795            
    796             <h3>Parameters</h3> 
    797          
    798              
    799             <h4 id="_tvplus_param_z2d">z2d&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="_tvplus_param_cellsize">cellsize&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  
    826            
    827  
    828            
    829  
    830             <h3>Keywords</h3> 
    831              
    832             <h4 id="_tvplus_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    833                
    834                
    835                
    836                
    837                
    838                
    839                
    840                
    841             </h4> 
    842          
    843             <div class="comments"></div> 
    844              
    845             <h4 id="_tvplus_keyword_C_MASK">C_MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    846                
    847                
    848                
    849                
    850                
    851                
    852                
    853                
    854             </h4> 
    855          
    856             <div class="comments"></div> 
    857              
    858             <h4 id="_tvplus_keyword_C_NAN">C_NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    859                
    860                
    861                
    862                
    863                
    864                
    865                
    866                
    867             </h4> 
    868          
    869             <div class="comments"></div> 
    870              
    871             <h4 id="_tvplus_keyword_WINDOW">WINDOW&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="_tvplus_keyword_MIN">MIN&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="_tvplus_keyword_MAX">MAX&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="_tvplus_keyword_MASK">MASK&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             <h4 id="_tvplus_keyword_OFFSET">OFFSET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    924                
    925                
    926                
    927                
    928                
    929                
    930                
    931                
    932             </h4> 
    933          
    934             <div class="comments"></div> 
    935              
    936             <h4 id="_tvplus_keyword_NOUSEINFOS">NOUSEINFOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    937                
    938                
    939                
    940                
    941                
    942                
    943                
    944                
    945             </h4> 
    946          
    947             <div class="comments"></div> 
    948              
    949             <h4 id="_tvplus_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    950                
    951                
    952                
    953                
    954                
    955                
    956                
    957                
    958             </h4> 
    959          
    960             <div class="comments"></div> 
    961              
    962             <h4 id="_tvplus_keyword_NOINTERP">NOINTERP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    963                
    964                
    965                
    966                
    967                
    968                
    969                
    970                
    971             </h4> 
    972          
    973             <div class="comments"></div> 
    974              
    975             <h4 id="_tvplus_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    976                
    977                
    978                
    979                
    980                
    981                
    982                
    983                
    984             </h4> 
    985          
    986             <div class="comments"></div> 
    987              
    988            
    989  
    990            
    991            
    992            
    993            
    994            
    995            
    996            
    997            
    998            
    999            
    1000            
    1001            
     988 the nice fonctionnalities of tvplus are not coded 
     989 for "scrolling window" case... 
     990</div> 
    1002991         
    1003992           
Note: See TracChangeset for help on using the changeset viewer.