Ignore:
Timestamp:
08/29/06 14:59:46 (18 years ago)
Author:
navarro
Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Picture/imdisp.html

    r157 r163  
    734734         
    735735 
    736         <div class="routine_details" id="_IMDISP"> 
    737  
    738           <h2><a class="top" href="#container">top</a>IMDISP <span class="categories"> 
     736        <div class="routine_details" id="_imdisp"> 
     737 
     738          <h2><a class="top" href="#container">top</a>imdisp <span class="categories"> 
    739739 Picture 
    740740</span></h2> 
    741741         
    742742          <p class="header"> 
    743             IMDISP<span class="result">, <a href="#_IMDISP_param_IMAGE">IMAGE</a></span>, <a href="#_IMDISP_keyword_RANGE">RANGE</a>=<span class="result">RANGE</span>, <a href="#_IMDISP_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_IMDISP_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_IMDISP_keyword_MARGIN">MARGIN</a>=<span class="result">MARGIN</span>, <a href="#_IMDISP_keyword_INTERP">INTERP</a>=<span class="result">INTERP</span>, <a href="#_IMDISP_keyword_DITHER">DITHER</a>=<span class="result">DITHER</span>, <a href="#_IMDISP_keyword_ASPECT">ASPECT</a>=<span class="result">ASPECT</span>, <a href="#_IMDISP_keyword_POSITION">POSITION</a>=<span class="result">POSITION</span>, <a href="#_IMDISP_keyword_OUT_POS">OUT_POS</a>=<span class="result">OUT_POS</span>, <a href="#_IMDISP_keyword_NOSCALE">NOSCALE</a>=<span class="result">NOSCALE</span>, <a href="#_IMDISP_keyword_NORESIZE">NORESIZE</a>=<span class="result">NORESIZE</span>, <a href="#_IMDISP_keyword_ORDER">ORDER</a>=<span class="result">ORDER</span>, <a href="#_IMDISP_keyword_USEPOS">USEPOS</a>=<span class="result">USEPOS</span>, <a href="#_IMDISP_keyword_CHANNEL">CHANNEL</a>=<span class="result">CHANNEL</span>, <a href="#_IMDISP_keyword_BACKGROUND">BACKGROUND</a>=<span class="result">BACKGROUND</span>, <a href="#_IMDISP_keyword_ERASE">ERASE</a>=<span class="result">ERASE</span>, <a href="#_IMDISP_keyword_AXIS">AXIS</a>=<span class="result">AXIS</span>, <a href="#_IMDISP_keyword_NEGATIVE">NEGATIVE</a>=<span class="result">NEGATIVE</span>, <a href="#_IMDISP_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     743            imdisp<span class="result">, <a href="#_imdisp_param_IMAGE">IMAGE</a></span>, <a href="#_imdisp_keyword_RANGE">RANGE</a>=<span class="result">vector</span>, <a href="#_imdisp_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_imdisp_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_imdisp_keyword_MARGIN">MARGIN</a>=<span class="result">MARGIN</span>, <a href="#_imdisp_keyword_INTERP">INTERP</a>=<span class="result">INTERP</span>, <a href="#_imdisp_keyword_DITHER">DITHER</a>=<span class="result">DITHER</span>, <a href="#_imdisp_keyword_ASPECT">ASPECT</a>=<span class="result">ASPECT</span>, <a href="#_imdisp_keyword_POSITION">POSITION</a>=<span class="result">POSITION</span>, <a href="#_imdisp_keyword_OUT_POS">OUT_POS</a>=<span class="result">OUT_POS</span>, <a href="#_imdisp_keyword_NOSCALE">NOSCALE</a>=<span class="result">NOSCALE</span>, <a href="#_imdisp_keyword_NORESIZE">NORESIZE</a>=<span class="result">NORESIZE</span>, <a href="#_imdisp_keyword_ORDER">ORDER</a>=<span class="result">ORDER</span>, <a href="#_imdisp_keyword_USEPOS">USEPOS</a>=<span class="result">USEPOS</span>, <a href="#_imdisp_keyword_CHANNEL">CHANNEL</a>=<span class="result">CHANNEL</span>, <a href="#_imdisp_keyword_BACKGROUND">BACKGROUND</a>=<span class="result">BACKGROUND</span>, <a href="#_imdisp_keyword_ERASE">ERASE</a>=<span class="result">ERASE</span>, <a href="#_imdisp_keyword_AXIS">AXIS</a>=<span class="result">AXIS</span>, <a href="#_imdisp_keyword_NEGATIVE">NEGATIVE</a>=<span class="result">NEGATIVE</span>, <a href="#_imdisp_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    744744         
    745745          <div class="comments"> 
     
    752752         
    753753             
    754             <h4 id="_IMDISP_param_IMAGE">IMAGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     754            <h4 id="_imdisp_param_IMAGE">IMAGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    755755              <span class="attr">in</span> 
    756756               
     
    777777            <h3>Keywords</h3> 
    778778             
    779             <h4 id="_IMDISP_keyword_RANGE">RANGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    780                
    781                
    782                
    783                
    784                
    785                
    786                
     779            <h4 id="_imdisp_keyword_RANGE">RANGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     780               
     781               
     782               
     783               
     784               
     785              <span class="attr">type:</span> <span class="value">vector</span> 
     786              <span class="attr">default:</span> <span class="value">min and max array values</span> 
    787787               
    788788            </h4> 
     
    792792 specifying the minimum and maximum values of the image 
    793793 array to be considered when the image is byte-scaled 
    794  (default is minimum and maximum array values). 
    795794 This keyword is ignored for True Color images, 
    796795 or if the NOSCALE keyword is set. 
    797796</div> 
    798797             
    799             <h4 id="_IMDISP_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    800                
    801                
    802                
    803                
    804                
    805                
    806                
     798            <h4 id="_imdisp_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     799               
     800               
     801               
     802               
     803               
     804               
     805              <span class="attr">default:</span> <span class="value">0</span> 
    807806               
    808807            </h4> 
     
    810809            <div class="comments"> 
    811810 Bottom value in the color table to be used 
    812  for the byte-scaled image 
    813  (default is 0). 
     811 for the byte-scaled image. 
    814812 This keyword is ignored if the NOSCALE keyword is set. 
    815813</div> 
    816814             
    817             <h4 id="_IMDISP_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    818                
    819                
    820                
    821                
    822                
    823                
    824                
     815            <h4 id="_imdisp_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     816               
     817               
     818               
     819               
     820               
     821               
     822              <span class="attr">default:</span> <span class="value">!D.TABLE_SIZE - BOTTOM</span> 
    825823               
    826824            </h4> 
     
    829827 Number of colors in the color table to be used 
    830828 for the byte-scaled image 
    831  (default is !D.TABLE_SIZE - BOTTOM). 
    832829 This keyword is ignored if the NOSCALE keyword is set. 
    833830</div> 
    834831             
    835             <h4 id="_IMDISP_keyword_MARGIN">MARGIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    836                
    837                
    838                
    839                
    840                
    841                
    842                
     832            <h4 id="_imdisp_keyword_MARGIN">MARGIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     833               
     834               
     835               
     836               
     837               
     838               
     839              <span class="attr">default:</span> <span class="value">0.1 or 0.025 if !P.MULTI is set to display multiple images</span> 
    843840               
    844841            </h4> 
     
    847844 A scalar value specifying the margin to be maintained 
    848845 around the image in normal coordinates 
    849  (default is 0.1, or 0.025 if !P.MULTI is set to display 
    850  multiple images). 
    851 </div> 
    852              
    853             <h4 id="_IMDISP_keyword_INTERP">INTERP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    854                
    855                
    856                
    857                
    858                
    859                
    860                
     846</div> 
     847             
     848            <h4 id="_imdisp_keyword_INTERP">INTERP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     849               
     850               
     851               
     852               
     853               
     854               
     855              <span class="attr">default:</span> <span class="value">nearest neighbor sampling</span> 
    861856               
    862857            </h4> 
     
    865860 If set, the resized image will be interpolated using 
    866861 bilinear interpolation 
    867  (default is nearest neighbor sampling). 
    868 </div> 
    869              
    870             <h4 id="_IMDISP_keyword_DITHER">DITHER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    871                
    872                
    873                
    874                
    875                
    876                
    877                
     862</div> 
     863             
     864            <h4 id="_imdisp_keyword_DITHER">DITHER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     865               
     866               
     867               
     868               
     869               
     870               
     871              <span class="attr">default:</span> <span class="value">no dithering</span> 
    878872               
    879873            </h4> 
     
    882876 If set, true color images will be dithered when displayed 
    883877 on an 8-bit graphics device 
    884  (default is no dithering). 
    885 </div> 
    886              
    887             <h4 id="_IMDISP_keyword_ASPECT">ASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    888                
    889                
    890                
    891                
    892                
    893                
    894                
     878</div> 
     879             
     880            <h4 id="_imdisp_keyword_ASPECT">ASPECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     881               
     882               
     883               
     884               
     885               
     886               
     887              <span class="attr">default:</span> <span class="value">maintain native aspect ratio</span> 
    895888               
    896889            </h4> 
     
    899892 A scalar value specifying the aspect ratio (height/width) 
    900893 for the displayed image 
    901  (default is to maintain native aspect ratio). 
    902 </div> 
    903              
    904             <h4 id="_IMDISP_keyword_POSITION">POSITION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     894</div> 
     895             
     896            <h4 id="_imdisp_keyword_POSITION">POSITION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    905897               
    906898               
     
    921913</div> 
    922914             
    923             <h4 id="_IMDISP_keyword_OUT_POS">OUT_POS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     915            <h4 id="_imdisp_keyword_OUT_POS">OUT_POS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    924916               
    925917               
     
    937929</div> 
    938930             
    939             <h4 id="_IMDISP_keyword_NOSCALE">NOSCALE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    940                
    941                
    942                
    943                
    944                
    945                
    946                
    947                
    948             </h4> 
    949          
    950             <div class="comments"> 
    951  If set, the image will not be byte-scaled 
    952  (default is to byte-scale the image). 
    953 </div> 
    954              
    955             <h4 id="_IMDISP_keyword_NORESIZE">NORESIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    956                
    957                
    958                
    959                
    960                
    961                
    962                
     931            <h4 id="_imdisp_keyword_NOSCALE">NOSCALE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     932               
     933               
     934               
     935               
     936               
     937               
     938              <span class="attr">default:</span> <span class="value">to byte-scale the image</span> 
     939               
     940            </h4> 
     941         
     942            <div class="comments"> 
     943 If set, the image will not be byte-scaled. 
     944</div> 
     945             
     946            <h4 id="_imdisp_keyword_NORESIZE">NORESIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     947               
     948               
     949               
     950               
     951               
     952               
     953              <span class="attr">default:</span> <span class="value">To resize the image to fit the display</span> 
    963954               
    964955            </h4> 
     
    966957            <div class="comments"> 
    967958 If set, the image will not be resized. 
    968  (default is to resize the image to fit the display). 
    969 </div> 
    970              
    971             <h4 id="_IMDISP_keyword_ORDER">ORDER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    972                
    973                
    974                
    975                
    976                
    977                
    978                
     959</div> 
     960             
     961            <h4 id="_imdisp_keyword_ORDER">ORDER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     962               
     963               
     964               
     965               
     966               
     967               
     968              <span class="attr">default:</span> <span class="value">To display the image from the bottom up</span> 
    979969               
    980970            </h4> 
     
    982972            <div class="comments"> 
    983973 If set, the image is displayed from the top down 
    984  (default is to display the image from the bottom up). 
    985974 Note that the system variable !ORDER is always ignored. 
    986975</div> 
    987976             
    988             <h4 id="_IMDISP_keyword_USEPOS">USEPOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    989                
    990                
    991                
    992                
    993                
    994                
    995                
     977            <h4 id="_imdisp_keyword_USEPOS">USEPOS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     978               
     979               
     980               
     981               
     982               
     983               
     984              <span class="attr">default:</span> <span class="value">To honor ASPECT and MARGIN when POSITION vector is supplied</span> 
    996985               
    997986            </h4> 
     
    999988            <div class="comments"> 
    1000989 If set, the image will be sized to exactly fit a supplied 
    1001  POSITION vector, over-riding ASPECT and MARGIN 
    1002  (default is to honor ASPECT and MARGIN when a POSITION 
    1003  vector is supplied). 
    1004 </div> 
    1005              
    1006             <h4 id="_IMDISP_keyword_CHANNEL">CHANNEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     990 POSITION vector, over-riding ASPECT and MARGIN. 
     991</div> 
     992             
     993            <h4 id="_imdisp_keyword_CHANNEL">CHANNEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1007994               
    1008995               
     
    10271014</div> 
    10281015             
    1029             <h4 id="_IMDISP_keyword_BACKGROUND">BACKGROUND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1016            <h4 id="_imdisp_keyword_BACKGROUND">BACKGROUND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10301017               
    10311018               
     
    10431030</div> 
    10441031             
    1045             <h4 id="_IMDISP_keyword_ERASE">ERASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1032            <h4 id="_imdisp_keyword_ERASE">ERASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10461033               
    10471034               
     
    10601047</div> 
    10611048             
    1062             <h4 id="_IMDISP_keyword_AXIS">AXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1049            <h4 id="_imdisp_keyword_AXIS">AXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10631050               
    10641051               
     
    10781065</div> 
    10791066             
    1080             <h4 id="_IMDISP_keyword_NEGATIVE">NEGATIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1067            <h4 id="_imdisp_keyword_NEGATIVE">NEGATIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10811068               
    10821069               
     
    10981085</div> 
    10991086             
    1100             <h4 id="_IMDISP_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1087            <h4 id="_imdisp_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    11011088               
    11021089               
     
    12541241          <h3>Version history</h3> 
    12551242           
    1256           <h4>Version</h4><div class="preformat"> $Id: imdisp.pro 136 2006-07-10 15:20:19Z pinsard $ 
     1243          <h4>Version</h4><div class="preformat"> $Id: imdisp.pro 157 2006-08-21 09:01:50Z navarro $ 
    12571244</div> 
    12581245          <h4>History</h4><div class="preformat"> Liam.Gumley@ssec.wisc.edu 
     
    12961283           
    12971284         
     1285          <h3>Statistics</h3> 
     1286          <table class="statistics"> 
     1287            <tr><td>McCabe cyclic</td><td>          76</td></tr> 
     1288            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1289            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1290          </table> 
    12981291           
    12991292         
Note: See TracChangeset for help on using the changeset viewer.