Ignore:
Timestamp:
03/21/07 10:14:37 (17 years ago)
Author:
pinsard
Message:

new idldoc html and assistant outputs

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Colors
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/color24.html

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 The purpose of this function is to convert a RGB color triple 
    65  into the equivalent 24-big long integer.  
     65 into the equivalent 24-big long integer. 
     66 This routine was written to be used with routines like COLORS or 
     67 <a href=".//GETCOLOR.html">GETCOLOR</a>. 
    6668 
    6769 
    … …  
    7173      <a name="#_color24"></a> 
    7274 
    73       <h2>color24  <font size="-1" color="#006633"> Graphics, Color 
     75      <h2>color24  <font size="-1" color="#006633"> 
     76 Graphics, Color 
    7477</font></h2> 
    7578 
    … …  
    7982 
    8083 
    81     <h3>Return value</h3>  
    82  a 24-bit long integer that is equivalent the input color.  
     84    <h3>Return value</h3> 
     85 a 24-bit long integer that is equivalent the input color. 
    8386 The color is described in terms of a hexadecimal number (e.g., FF206A) 
    84  where the left two digits represent the blue color, the  
    85  middle two digits represent the green color, and the right  
     87 where the left two digits represent the blue color, the 
     88 middle two digits represent the green color, and the right 
    8689 two digits represent the red color. 
    8790 
    … …  
    103106    </h4> 
    104107 
    105       
    106  A three-element column or row array representing  
     108     
     109 A three-element column or row array representing 
    107110 a color triple. The values of the elements must be between 0 and 255. 
    108111 
    … …  
    112115     
    113116 
    114     <h3>Examples</h3>  
    115  To convert the color triple for the color YELLOW,  
    116  (255, 255, 0), to the hexadecimal value '00FFFF'x  
     117    <h3>Examples</h3><pre> 
     118 To convert the color triple for the color YELLOW, 
     119 (255, 255, 0), to the hexadecimal value '00FFFF'x 
    117120 or the decimal number 65535, type: 
    118121 
    119122 IDL> color = COLOR24([255, 255, 0]) 
    120         
    121  This routine was written to be used with routines like COLORS or GETCOLOR 
    122123 
    123     <h3>Version history</h3> 
     124 
     125    </pre><h3>Version history</h3> 
    124126     
    125     <h4>Version</h4> $Id: color24.pro 163 2006-08-29 12:59:46Z navarro $ 
     127    <h4>Version</h4> 
     128 $Id: color24.pro 231 2007-03-19 17:15:51Z pinsard $ 
    126129 
    127130    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/colorbar.html

    r200 r234  
    7171      <a name="#_colorbar"></a> 
    7272 
    73       <h2>colorbar  <font size="-1" color="#006633"> Graphics, Widget 
     73      <h2>colorbar  <font size="-1" color="#006633"> 
     74 Graphics, Widget 
    7475</font></h2> 
    7576 
    … …  
    180181    </h4> 
    181182 
    182       
     183     
    183184 Vector which contain color's indexes to trace in a color bar. Therefore 
    184  we obtain a discrete colorbar which contains only the specified colors  
     185 we obtain a discrete colorbar which contains only the specified colors 
    185186 in the order they appear in the vector 
    186187 
    … …  
    430431     
    431432 
    432     <h3>Examples</h3> 
     433    <h3>Examples</h3><pre> 
    433434 To display a horizontal color bar above a contour plot, type: 
    434435 
    … …  
    438439 IDL> COLORBAR, NCOLORS=100 
    439440 
    440     <h3>Version history</h3> 
    441      
    442     <h4>Version</h4> $Id: colorbar.pro 163 2006-08-29 12:59:46Z navarro $ 
    443  
    444     <h4>History</h4>  
     441    </pre><h3>Version history</h3> 
     442     
     443    <h4>Version</h4> 
     444 $Id: colorbar.pro 231 2007-03-19 17:15:51Z pinsard $ 
     445 
     446    <h4>History</h4> 
    445447 Written by: David Fanning, 10 JUNE 96. 
    446448 10/27/96: Added the ability to send output to PostScript. DWF 

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/getcolor.html

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 The original purpose of this function was to enable the 
    6565 user to specify one of the 16 colors supported by the 
    … …  
    8181      <a name="#_getcolor"></a> 
    8282 
    83       <h2>getcolor  <font size="-1" color="#006633"> Graphics, Color 
     83      <h2>getcolor  <font size="-1" color="#006633"> 
     84 Graphics, Color 
    8485</font></h2> 
    8586 
    … …  
    131132    </h4> 
    132133 
    133       
     134     
    134135 A string with the "name" of the color. Valid names are: 
    135136           black 
    … …  
    153154 Case is unimportant. 
    154155 
    155  
    156156     
    157157 
    … …  
    168168    </h4> 
    169169 
    170       
     170     
    171171 The color table index where the specified color should be loaded. 
    172172 
    … …  
    190190    </h4> 
    191191 
    192        
     192     
    193193 If this keyword is set, the specified color triple is returned 
    194194 as a 24-bit integer equivalent. The lowest 8 bits correspond to 
    … …  
    211211    </h4> 
    212212 
    213       
     213     
    214214 If this keyword is set, the return value of the function is 
    215215 a 16-element string array containing the names of the colors. 
    … …  
    233233    </h4> 
    234234 
    235        
     235     
    236236 If this keyword is set, all 16 colors are automatically loaded 
    237237 starting at the color index specified by the START keyword. 
    … …  
    268268     
    269269 
    270     <h3>Examples</h3>  
     270    <h3>Examples</h3><pre> 
    271271 To load a yellow color in color index 100 and plot in yellow, type: 
    272272 
    … …  
    332332      IDL> PLOT, data, Color=colors.yellow 
    333333 
    334     <h3>Version history</h3> 
    335      
    336     <h4>Version</h4> $Id: getcolor.pro 163 2006-08-29 12:59:46Z navarro $ 
    337     <h4>History</h4>  
     334    </pre><h3>Version history</h3> 
     335     
     336    <h4>Version</h4> 
     337 $Id: getcolor.pro 231 2007-03-19 17:15:51Z pinsard $ 
     338    <h4>History</h4> 
    338339 Written by: David Fanning, 10 February 96. 
    339340 Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF 
    … …  
    351352     
    352353     
    353     <h4>Restrictions</h4>  
     354    <h4>Restrictions</h4> 
    354355 The TRUE keyword causes the START keyword to be ignored. 
    355  The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be  
     356 The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be 
    356357 ignored. 
    357358 The COLOR parameter is ignored if the LOAD keyword is used. 

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/lct.html

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 Fastest than type loadct, file = 'palette.tbl' 
    6565 
    … …  
    7070      <a name="#_lct"></a> 
    7171 
    72       <h2>lct  <font size="-1" color="#006633">  
     72      <h2>lct  <font size="-1" color="#006633"> 
    7373 Graphics, Color 
    7474</font></h2> 
    … …  
    152152    </h4> 
    153153 
    154       
     154     
    155155 a scalar used to change the Lightness of the color 
    156156 palette to be able to adjust according to the printer we use, 
    157  the media (paper or slide)...  
     157 the media (paper or slide)... 
    158158               lightness < 1 to get lighter colors 
    159159                         > 1 to get darker colors 
    … …  
    173173 
    174174     
    175  Used to pass loadct keywords 
    176  
    177      
    178      
    179  
    180      
    181     <h3>Version history</h3> 
    182      
    183     <h4>Version</h4> $Id: lct.pro 163 2006-08-29 12:59:46Z navarro $ 
     175 Used to pass keywords to <proidl>loadct</proidl> 
     176 
     177     
     178     
     179 
     180     
     181    </pre><h3>Version history</h3> 
     182     
     183    <h4>Version</h4> 
     184 $Id: lct.pro 232 2007-03-20 16:59:36Z pinsard $ 
    184185 
    185186    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/newpalette.html

    r200 r234  
    6161    </dl> 
    6262 
    63       
     63     
    6464 Allows to save the palette which is on the screen 
    6565 in a same type file than the one given by default in IDL 
    … …  
    7272      <a name="#_newpalette"></a> 
    7373 
    74       <h2>newpalette  <font size="-1" color="#006633">  
     74      <h2>newpalette  <font size="-1" color="#006633"> 
    7575 Color 
    7676</font></h2> 
    … …  
    100100 
    101101     
    102  a string containing the name of the new palette we want to write. 
     102 the name of the new palette we want to write. 
    103103 
    104104     
    … …  
    137137    </h4> 
    138138 
    139       
    140  the number of the palette we want to replace 
     139     
     140 the number of the palette we want to replace. 
    141141 
    142142     
    … …  
    153153    </h4> 
    154154 
    155       
    156  Used to pass modifyct keywords 
     155     
     156 Used to pass keywords to <proidl>modifyct</proidl> 
    157157 
    158158     
    … …  
    160160 
    161161     
    162     <h3>Version history</h3> 
     162    </pre><h3>Version history</h3> 
    163163     
    164     <h4>Version</h4> $Id: newpalette.pro 163 2006-08-29 12:59:46Z navarro $ 
     164    <h4>Version</h4> 
     165 $Id: newpalette.pro 232 2007-03-20 16:59:36Z pinsard $ 
    165166 
    166     <h4>History</h4> Guillaume Roulet (gr@lodyc.jussieu.fr) 
     167    <h4>History</h4>  
     168 Guillaume Roulet (gr@lodyc.jussieu.fr) 
    167169 30/3/1999 s.masson, add _extra, research of the full name, OVER 
    168170                       5/5/1999 s.masson 

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/xlct.html

    r200 r234  
    6161    </dl> 
    6262 
    63       
    64  Like xloadct but fastest to write and call by default the palette  
     63     
     64 Like xloadct but fastest to write and call by default the palette 
    6565 palette.tbl which can be in any directory 
    6666 
    … …  
    7171      <a name="#_xlct"></a> 
    7272 
    73       <h2>xlct  <font size="-1" color="#006633"> Widget, Color 
     73      <h2>xlct  <font size="-1" color="#006633"> 
     74 Widget, Color 
    7475</font></h2> 
    7576 
    … …  
    9899    </h4> 
    99100 
    100       
     101     
    101102 Normally, no informational message is printed when a color map 
    102103 is loaded. If this keyword is present and zero, this message is printed. 
    … …  
    115116    </h4> 
    116117 
    117       
     118     
    118119 The widget ID of the widget that calls Xlct. When  this ID is 
    119120 specified, a death of the caller results in a death of Xlct 
    … …  
    275276 
    276277     
    277     <h3>Version history</h3> 
    278      
    279     <h4>Version</h4> $Id: xlct.pro 163 2006-08-29 12:59:46Z navarro $ 
    280  
    281     <h4>History</h4> 5/5/1999 copy of xloadct par Sebastien Masson (smasson@lodyc.jussieu.fr) 
     278    </pre><h3>Version history</h3> 
     279     
     280    <h4>Version</h4> 
     281 $Id: xlct.pro 231 2007-03-19 17:15:51Z pinsard $ 
     282 
     283    <h4>History</h4> 
     284 5/5/1999 copy of xloadct par Sebastien Masson (smasson@lodyc.jussieu.fr) 
    282285 
    283286     

  • trunk/SRC/Documentation/idldoc_assistant_output/Colors/xpal.html

    r200 r234  
    6262 
    6363     
     64 Choose the best foreground and background colors for 
     65 the current color maps and set !P appropriately. 
     66 
     67 
    6468 like xpalette but shorter to write and, moreover, 
    6569 possess a hotkey save which (thanks to the newpalette routine) 
    … …  
    175179     
    176180 
    177     <h3>Examples</h3> 
     181    <h3>Examples</h3><pre> 
    178182 The XPAL widget has the following controls: 
    179183 
    … …  
    248252                          horizontally. 
    249253 
    250     <h3>Version history</h3> 
    251      
    252      
    253     <h4>History</h4>  
     254    </pre><h3>Version history</h3> 
     255     
     256    <h4>Version</h4> 
     257 $Id: xpal.pro 233 2007-03-20 17:04:40Z pinsard $ 
     258 
     259    <h4>History</h4> 
    254260 Adaptation of xpalette to add a save button by 
    255261          Grima Nicolas (nglod@ipsl.jussieu.fr) and by Masson 
    256262          Sebastien (smlod@ipsl.jussieu.fr) 
    257  
    258  $Id: xpal.pro 163 2006-08-29 12:59:46Z navarro $ 
    259263 
    260264     
Note: See TracChangeset for help on using the changeset viewer.