.TH palette n 1.0 Fgis "developer Tcl commands"

.SH NAME
fgisRasterColorImage, fgisRasterBWImage \- render raster object into planchet item

.SH SYNOPSIS
\fBfgisRasterColorImage\fI raster planchet item\fR ?\fIoption\fR?

\fBfgisRasterBWImage\fI raster planchet item\fR ?\fIoption\fR?

.SH DESCRIPTION

These commands perform visualisation of fGIS raster objects in fGIS planchet
(essentially same as Tk canvas). They work on platform independent manner,
creating visible representation of layer in Tk image object, which should
be previously created. 

User (and even application writer) seldom accesses this commands directly.
Raser layer objects and planchet subcommands should be used to visualize
raster layers.

These commands controls all attributes of layer appearance, which have no
semantic meaning. I.e. raster file class to palette index correspondence is
part of raster object, becouse it also used for access legend and GIS
operation, while palette itself appear only in call to this command, becouse
it used only to visualisation.

.SH ARGUMENTS

.TP 4
\fIraster\fR -
name of fGIS raster object (see \fBraster\fR(n)).

.TP 4
\fIplanchet\fR -
name of fGIS planchet widget. Planchet should be mapped and have coordinate
system already defined.

.TP 4
\fIitem\fR -
ID of planchet item to render raster in. It should exist, be of type image
and contain valid image (photo for \fBfgisRasterColorImage\fR and bitmap for
\fBfgisRasterBWImage\fR) in its -image atribute.

.SH OPTIONS
.TP 4
\fB-border\fI option\fR -
specifies whether borders between raster object classes or base file classes
(polygon borders) should be drawn. \fIOption\fR can be one of \fBnone\fR,
\fByes\fR, \fBbase\fR. Abbreviations are not allowed (bug?). \fByes\fR means
that borders are drawn only between distinct classes of current raster object,
\fBbase\fR means that borders should be drawn if base file classes are distinct,
even if they are reclassed into same value. Useful for choropleth plots.

For symbol plots option is ignored. Defaults to \fBnone\fR for color images
and \fByes\fR for BW images.
.TP 4
\fB-color\fI color\fR 
- specifies color to plot borders in color mode or
for entire image in pattern or symbol mode. \fIcolor\fR can be any form
of color specification, acceptable by Tk. Defaults to "black".
.TP 4
\fB-map\fI option\fR -
specifies how to deal with map classes, which exceed palette or pattern range
(0\-255). Option is one of \fBwrap\fR - use symbol (color) \fIclass%255\fR for
classes which exceeds 255, \fBnone\fR - use symbol (color) 255 for all these
clases and \fInumber\fR - map range 0-\fImax class\fR to range 0-\fInumber\fR.
Defaults to \fBwrap\fR.
.TP 4
\fB-palette \fIpalettename\fR (color only) -
specifies fGIS palette object to use for coloring of map classes. Defaults
to \fBdefaultpalette\fR.
.TP 4
\fB-patterns \fIpatternname\fR (BW only) -
sets plotting mode to pattern and specifies pattern set to plot. In pattern
mode patterns are clipped by polygon boundaries, and thus any border modes
are allowed. Defaults to {} (empty pattern). This mode is default for 
\fBfgisRasterBWImage\fR
.TP 4
\fB-symbols \fIpatternname\fR (BW only) -
sets plotting mode to symbol and specifies pattern set to plot. In symbol
mode patterns can be drawn only at whole, so if central point of pattern
belongs to certain class, pattern for this class would be drawn on entire
rectangle. Borders are never plotted in this mode No defaults, becouse this
mode must be turned on explicitely.
.TP 4
\fB-update \fI{x1 y1 x2 y2}\fR
- Specifies, that only part of image should be replotted. Useful for
raster editing application. Rectangle to update is given in map coordinates.
It is clipped by image boundaries.

.SH SEE ALSO
.BR raster (n), planchet (n), palette (n), 
.BR patterns (n)