man/fgisRasterColorImage.n

   1 .TH palette n 1.0 Fgis "developer Tcl commands"
   2
   3 .SH NAME
   4 fgisRasterColorImage, fgisRasterBWImage \- render raster object into planchet item
   5
   6 .SH SYNOPSIS
   7 \fBfgisRasterColorImage\fI raster planchet item\fR ?\fIoption\fR?
   8
   9 \fBfgisRasterBWImage\fI raster planchet item\fR ?\fIoption\fR?
  10
  11 .SH DESCRIPTION
  12
  13 These commands perform visualisation of fGIS raster objects in fGIS planchet
  14 (essentially same as Tk canvas). They work on platform independent manner,
  15 creating visible representation of layer in Tk image object, which should
  16 be previously created.
  17
  18 User (and even application writer) seldom accesses this commands directly.
  19 Raser layer objects and planchet subcommands should be used to visualize
  20 raster layers.
  21
  22 These commands controls all attributes of layer appearance, which have no
  23 semantic meaning. I.e. raster file class to palette index correspondence is
  24 part of raster object, becouse it also used for access legend and GIS
  25 operation, while palette itself appear only in call to this command, becouse
  26 it used only to visualisation.
  27
  28 .SH ARGUMENTS
  29
  30 .TP 4
  31 \fIraster\fR -
  32 name of fGIS raster object (see \fBraster\fR(n)).
  33
  34 .TP 4
  35 \fIplanchet\fR -
  36 name of fGIS planchet widget. Planchet should be mapped and have coordinate
  37 system already defined.
  38
  39 .TP 4
  40 \fIitem\fR -
  41 ID of planchet item to render raster in. It should exist, be of type image
  42 and contain valid image (photo for \fBfgisRasterColorImage\fR and bitmap for
  43 \fBfgisRasterBWImage\fR) in its -image atribute.
  44
  45 .SH OPTIONS
  46 .TP 4
  47 \fB-border\fI option\fR -
  48 specifies whether borders between raster object classes or base file classes
  49 (polygon borders) should be drawn. \fIOption\fR can be one of \fBnone\fR,
  50 \fByes\fR, \fBbase\fR. Abbreviations are not allowed (bug?). \fByes\fR means
  51 that borders are drawn only between distinct classes of current raster object,
  52 \fBbase\fR means that borders should be drawn if base file classes are distinct,
  53 even if they are reclassed into same value. Useful for choropleth plots.
  54
  55 For symbol plots option is ignored. Defaults to \fBnone\fR for color images
  56 and \fByes\fR for BW images.
  57 .TP 4
  58 \fB-color\fI color\fR
  59 - specifies color to plot borders in color mode or
  60 for entire image in pattern or symbol mode. \fIcolor\fR can be any form
  61 of color specification, acceptable by Tk. Defaults to "black".
  62 .TP 4
  63 \fB-map\fI option\fR -
  64 specifies how to deal with map classes, which exceed palette or pattern range
  65 (0\-255). Option is one of \fBwrap\fR - use symbol (color) \fIclass%255\fR for
  66 classes which exceeds 255, \fBnone\fR - use symbol (color) 255 for all these
  67 clases and \fInumber\fR - map range 0-\fImax class\fR to range 0-\fInumber\fR.
  68 Defaults to \fBwrap\fR.
  69 .TP 4
  70 \fB-palette \fIpalettename\fR (color only) -
  71 specifies fGIS palette object to use for coloring of map classes. Defaults
  72 to \fBdefaultpalette\fR.
  73 .TP 4
  74 \fB-patterns \fIpatternname\fR (BW only) -
  75 sets plotting mode to pattern and specifies pattern set to plot. In pattern
  76 mode patterns are clipped by polygon boundaries, and thus any border modes
  77 are allowed. Defaults to {} (empty pattern). This mode is default for
  78 \fBfgisRasterBWImage\fR
  79 .TP 4
  80 \fB-symbols \fIpatternname\fR (BW only) -
  81 sets plotting mode to symbol and specifies pattern set to plot. In symbol
  82 mode patterns can be drawn only at whole, so if central point of pattern
  83 belongs to certain class, pattern for this class would be drawn on entire
  84 rectangle. Borders are never plotted in this mode No defaults, becouse this
  85 mode must be turned on explicitely.
  86 .TP 4
  87 \fB-update \fI{x1 y1 x2 y2}\fR
  88 - Specifies, that only part of image should be replotted. Useful for
  89 raster editing application. Rectangle to update is given in map coordinates.
  90 It is clipped by image boundaries.
  91
  92 .SH SEE ALSO
  93 .BR raster (n), planchet (n), palette (n),
  94 .BR patterns (n)