]> Pileus Git - ~andy/rsl/blob - doc/RSL_load_color_table.html
RSL v1.44
[~andy/rsl] / doc / RSL_load_color_table.html
1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
2 <html>
3 <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5    <meta name="GENERATOR" content="Mozilla/4.5 [en] (X11; U; Linux 2.0.32 i686) [Netscape]">
6 </head>
7 <body>
8 <a href="index.html"><img SRC="rsl.gif" ></a>
9 <hr>
10 <h1>
11 RSL color table routines</h1>
12
13 <hr>
14 <h3>
15 Synopsis</h3>
16 <b>#include "rsl.h"</b>
17 <br><b>void RSL_load_color_table(char *infile, char buffer[256], int *ncolors);</b>
18 <br><b>void RSL_load_green_table(char *infile);</b>
19 <br><b>void RSL_load_blue_table(char *infile);</b>
20 <br><b>void RSL_load_red_table(char *infile);</b>
21 <br><b>void RSL_load_refl_color_table();</b>
22 <br><b>void RSL_load_sw_color_table();</b>
23 <br><b>void RSL_load_vel_color_table();</b>
24 <br><b>void RSL_load_zdr_color_table();</b>
25 <br><b>void RSL_load_rainfall_color_table();</b>
26 <br><b>void RSL_load_height_color_table();</b>
27 <h3>
28
29 <hr>Description</h3>
30 These are the color table routines. The color table is use when making
31 images and is merely 256 bytes in size representing red, green and blue
32 color indexes. The routines <b>RSL_load_refl_color_table</b>, <b>RSL_load_sw_color_table,
33 RSL_load_vel_color_table</b>,and <b>RSL_load_zdr_color_table</b> each call
34 the three routines <b>RSL_load_red_table</b>, <b>RSL_load_green_table</b>,
35 and <b>RSL_load_blue_table</b> with a hard coded (defined during software
36 installation) color input file. Under normal usage, you only have to call
37 these routines once prior to any image generation function calls.
38 <p>The routines <b>RSL_load_rainfall_color_table</b> and <b>RSL_load_height_color_table</b>
39 use the default files defined during installation. These routines exist
40 to simplify the interface when generating height or rainfall images.
41 <p>The default input file names are defined in volume.h. When you don't
42 want to use the default color tables for reflectivity, spectrum width,
43 or velocity, and have your own color tables, you can use <b>RSL_load_red_table</b>,
44 <b>RSL_load_green_table</b>,
45 and <b>RSL_load_blue_table</b> directly. Be sure to call all three routines.
46 The most general of the routines, and one you should not normally use,
47 is <b>RSL_load_color_table</b>. It manages a static global color table
48 array and it is how the color table is remembered throughout your application.
49 <p>The organization of the input color table files is binary. They contain,
50 at most, 256 bytes with no delimeters and represent the color ramp from
51 index 0 to 255.&nbsp;
52 <hr>
53 <h3>
54 Return value</h3>
55 None.&nbsp;
56 <hr>
57 <h3>
58 See also</h3>
59 <a href="RSL_sweep_to.html">RSL_sweep_to_gif</a>, <a href="RSL_sweep_to.html">RSL_sweep_to_pict</a>,
60 <a href="RSL_sweep_to.html">RSL_sweep_to_pgm</a>,
61 <a href="RSL_sweep_to.html">RSL_sweep_to_ppm</a>,
62 <br><a href="RSL_bscan.html">RSL_bscan_ray</a>, <a href="RSL_bscan.html">RSL_bscan_sweep</a>,
63 <a href="RSL_bscan.html">RSL_bscan_volume</a>,
64 <br><a href="RSL_volume_to.html">RSL_volume_to_gif</a>, <a href="RSL_volume_to.html">RSL_volume_to_pict</a>,
65 <a href="RSL_volume_to.html">RSL_volume_to_pgm</a>,
66 <a href="RSL_volume_to.html">RSL_volume_to_ppm</a>,
67 <br><a href="RSL_color_table.html">RSL_get_color_table</a>, <a href="RSL_color_table.html">RSL_set_color_table</a>.
68 <br>
69 <hr>
70 <p>Author: <a href="john.merritt.html">John H. Merritt</a>
71 </body>
72 </html>