--- /dev/null
+<!-- manual page source format generated by PolyglotMan v3.0.4, -->
+<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
+
+<HTML>
+<HEAD>
+<TITLE>raster(n) manual page</TITLE>
+</HEAD>
+<BODY>
+<A HREF="#toc">Table of Contents</A><P>
+<P>
+
+<H2><A NAME="sect0" HREF="#toc0">NAME </A></H2>
+raster - Create and manipulate raster object <P>
+
+<H2><A NAME="sect1" HREF="#toc1">SYNOPSIS </A></H2>
+<B> raster
+<I>filename </I></B> ?<I>options </I>? <P>
+
+<H2><A NAME="sect2" HREF="#toc2">DESCRIPTION </A></H2>
+<P>
+This command allows to create raster
+objects. Raster objects are more low-level concept than fGIS <B>layers </B>. They
+directly correspond to raster files in EPPL7 format. Their values are always
+unsigned short integer. They even make cell size visible to user. This
+command returns name of raster object which is used for manipulating this
+object. By default it requires existing raster file without reclass table.
+ <P>
+ Raster files are objects which holds information of certain integer
+spatial variable in given rectangular area. Value is stored with certain
+granulariry. Minimal square, which can be addressed as separate unit, is
+named cell. Of course, you can specify coordinates with any precision,
+but while they are in same cell, same value would be returned. Moreover,
+when you edit raster, you can change values only on per cell basis. <P>
+ Raster
+file is always rectangular, but spatial variable can be defined on any
+arbitrary area. So, special value is reserved for "undefined" areas of
+raster. It is named <B>offsite </B> value. Typically you can read raster it any
+coordinates, but if no information is provided for this area, offsite
+would be returned. <P>
+ There are certain limitation on raster files - file
+cannot contain more than 32767 cells per row or per column. Possible values
+of raster should be in range 0-65535. Rows and columns of cells can be numbered
+starting from any integer, provided that no row or column in file has
+number out of range -32767- 32767. fGIS, however never relies on column numbers.
+They are supported only for compatibility with EPPL7. <P>
+ Raster objects
+differs from raster files in the way that they include <B>reclass table </B>.
+This allows to store information about several spatial variables in one
+file, provided that total count of value combination doesn't exceed raster
+file limit. Reclass table defines correspondence between file classes (values)
+and values, returned by raster object. It can be defined by two ways - using
+special syntax like in EPPL7 RECLASS command (see RECLASS SYNTAX below)
+or using Tcl list, each element of which is pair of values, first base,
+then reclassed. <P>
+ When raster objects are accessed or created via GIS operations,
+user may not be aware about underlying raster file level. But when objects
+are created by interative editing, certain properties of raster (i.e. cell
+size) should be specified. <P>
+ Raster objects behave like other fGIS objects
+- layers, legends, palettes etc. Once object is created, new Tcl command
+with same name is created. This command is used to access and modify rasters.
+<P>
+
+<H2><A NAME="sect3" HREF="#toc3">OPTIONS </A></H2>
+
+<DL>
+
+<DT><B>-reclass <I>statements </I></B> </DT>
+<DD>-specifies reclass table for created raster
+object. <I>statements </I> is string, containing set of reclass statements. See
+<B>RECLASS SYNTAX </B> below for details </DD>
+
+<DT><B>-table <I>list </I></B> </DT>
+<DD>-specifies reclass table
+in form of Tcl list. Each element of this list should be list of two integers,
+first of them representing value in raster file, and second - representing
+value which would be value of new raster object. </DD>
+
+<DT><B>-new </B> </DT>
+<DD>- specifies that
+new raster file should be created instead of opening old. This option should
+be specified immediately after file name and followed by several other
+options, defining properties of new raster. All subsequent options are
+applicable only if <B>-new </B> is specified. </DD>
+
+<DT><B>-like<I> rasterObject </I></B> </DT>
+<DD>- specifies that
+all important properties should be copied from existing raster object.
+</DD>
+
+<DT><B>-width<I> integer </I></B> </DT>
+<DD>- specifies how many cells should appear in each row. Cannot
+be used together with <B>-like </B> </DD>
+
+<DT><B>-height<I>integer </I></B> </DT>
+<DD>- specifies how many cells
+should be in each column. </DD>
+
+<DT><B>-offsite<I>integer </I></B> </DT>
+<DD> - specifies which value would
+be used as "no data" value. Default is 65535 for 16-bit files and 255 for
+8-bit. Value -1 can be specified for 8-bit files. It means that all classes
+are onsite. For 16-bit files it is equivalent to 65535. </DD>
+
+<DT><B>-8bit </B> - specifies
+that only one byte should be used for storing </DT>
+<DD>values of raster. This limits
+value range to 0-255, slightly decreases file size (usially much less than
+two times) and makes file compatible with EPPL7 ver. 2.1. </DD>
+
+<DT><B>-limits<I>{x1 y1 x2
+y2} </I></B> </DT>
+<DD>- Allows to specify list of four double values, determinig map coordinates
+of file. </DD>
+
+<DT><B>-cell<I> value </I></B> - specifies size of cell. In conjunction with <B>-limits
+</B> </DT>
+<DD>it gives more convinient way to create new raster, becouse limits defines
+ area of interest and cell size - accuracy of map. </DD>
+</DL>
+<P>
+
+<H2><A NAME="sect4" HREF="#toc4">OBJECT COMMAND </A></H2>
+<B>raster
+</B> command creates new Tcl command with same name as raster object, which
+can be used to manipulate this object. <P>
+ <I>rasterName<B> box<I>value x1 y1 x2 y2
+</I></B></I> - fills rectangular region with given value. Raster should be opened in
+read-write mode (either by <B>-new<I> option of object command or by <B>load </B></I></B> object
+command). Returns list of four double values, specifying region actually
+affected by command. (Can be less that specified region, if it exceeds
+raster boundary). Value is class of base raster file, not reclassed value.
+<P>
+
+<DL>
+
+<DT><I>rasterName<B> bpp </B></I> - returns size of data in this raster file </DT>
+<DD>(8 for 8-bit
+and 16 for 16 bit rasters). </DD>
+
+<DT><I>rasterName<B> cache </B></I>?<I>new size </I>? </DT>
+<DD>- controls size
+of cache. If raster file is accessed from disk (default read only mode)
+setting sufficient cache can improve performance of operations, which
+require nonsequentual access, like <B>transect </B>. </DD>
+
+<DT><I>rasterName <B>cell </B></I> ?<B>-area </B>?
+ </DT>
+<DD>- returns parameters of cell. By default, returns cell width in map coordinates,
+which should be meters, and with <B>-area<I> flag returns cell area in current
+units (see <B>unit </B></I></B> object command). </DD>
+
+<DT><I>rasterName <B>celllimit </B></I> </DT>
+<DD>- returns list
+of four intergers, representig start and end numbers of cells in order
+<I>first column </I>, <I>last row </I>, <I>last column<B>, <I>first row </I></B></I>. (Why this order? X direction
+of cell numbers is same as of coordinates (usially), and Y coodinates
+usially go from bottom to top, while cells - from top to bottom. So, order
+of values is same as order of values in <B>limits<I> object command. </DD>
+
+<DT><I>rasterName
+<B>classes <I>value </I></B></I></I></B> </DT>
+<DD>- returns list of base file classes which are mapped to
+specified value of this raster object. </DD>
+
+<DT><I>rasterName <B>circle<I> value x y radius
+ </I></B></I>?<B>-cells </B>? </DT>
+<DD>- fills circulare region in read-write raster with given value.
+If <B>-cells </B>,flag is given, radius is assumed to be in raster cells. Otherwise
+it is assumed to be in coordinate units. Returns list of coordinates, specifying
+actualy affected region. </DD>
+
+<DT><I>rasterName <B>col<I> x </I></B></I> </DT>
+<DD>- returns cell number corresponding
+to given X coordinate. Returns error, if coordinate is out of file boundaries.
+</DD>
+
+<DT><I>rasterName <B>comment </B></I> ?<I>string </I>? </DT>
+<DD>- returns (or modifies) comment, stored
+in file header. Comment length is limited by 32 symbols. </DD>
+
+<DT><I>rasterName <B>count
+</B></I> ?<B>options </B>? </DT>
+<DD>- performs various area-calculating operation General formats
+folows: </DD>
+
+<DT><I>rasterName <B>count </B></I> ?<B>-- </B>? <I> varname </I>?<I>region specification </I>? </DT>
+<DD>fills
+dynamic array <I>varname </I> indexed by raster classes by areas of these classes
+in given region. </DD>
+
+<DT><I>rasterName <B>count -classes <I>list </I></B></I>?<I>region specification
+</I>? </DT>
+<DD>returns area of given classes within given region. </DD>
+</DL>
+<P>
+ Region specification
+defaults to whole file. Other possible formats are:
+<DL>
+
+<DT><B>-box<I> x1 y1 x2 y2 </I></B>
+</DT>
+<DD>- within given rectangular area </DD>
+
+<DT><B>-polygon<I> x y x y ... </I></B> </DT>
+<DD>- within polygon, given
+by set of coordinate pairs </DD>
+
+<DT><B>-radius<I> distance x y ... </I></B> </DT>
+<DD>within given distance
+of any of given points. </DD>
+
+<DT><B>-mask<I> rasterObject list </I></B> </DT>
+<DD>in areas where value of
+another rasterObject is in given list. </DD>
+</DL>
+<P>
+
+<DL>
+
+<DT><I>rasterName <B>delete </B></I> </DT>
+<DD>- destroys raster
+object. If raster was in readwrite mode, all unsaved changes are lost. </DD>
+
+<DT><I>rasterName
+<B>extents<I> value </I></B></I> </DT>
+<DD>- returns list of four coordinates, within those all values
+of given class are contained. </DD>
+
+<DT><I>rasterName <B>filename </B></I> </DT>
+<DD>- returns name of file,
+corresponding to this raster object. </DD>
+
+<DT><I>rasterName <B>fill<I> value x y </I></B></I>?<B>-stop </B>?<I>
+value </I> </DT>
+<DD>- fills area, starting with given coordinates with value. By default,
+stops on encounter of any value other than in given point. If <B>-stop </B> option
+is specified, stops only when encountering given value. Returns list of
+coordinates, specifying actually affected region. </DD>
+
+<DT><I>rasterName <B>frame<I> value
+ x1 y1 x2 y2 </I></B></I> ?<B>-width<I> cells </I></B>? </DT>
+<DD>- a rectangle with given value, not changing
+inside area. By default this rectangle is 1 cell wide. </DD>
+
+<DT><I>rasterName <B>get<I> x
+y </I></B></I>?<B>-base </B>? </DT>
+<DD>Returns value of raster in given point. By default returns
+reclassed value, but if <B>-base </B> is specified, returns class of raster file.
+</DD>
+
+<DT><I>rasterName <B>limits </B></I> </DT>
+<DD>Returns list of four doubles, specifying physical
+limits of raster file, in order <I>XLeft </I>, <I>YBottom </I>, <I>XRight </I>, <I>YTop </I>. </DD>
+
+<DT><I>rasterName
+<B>line<I> value x y x y .... </I></B></I>?<B>-width <I>cells </I></B>? </DT>
+<DD>draws a line with given value. By
+default one-cell wide. Returns boundaries of region affected. </DD>
+
+<DT><I>rasterName
+<B>load </B></I> </DT>
+<DD>Loads raster file into memory, changing it from readonly to readwrite
+mode, and enabling all editing operation. (<B>-new </B> option of <B>raster </B> command
+performs <B>load </B> implicitely). </DD>
+
+<DT><I>rasterName <B>max </B></I> </DT>
+<DD>-returns maximal value of
+raster object. </DD>
+
+<DT><I>rasterName <B>min </B></I> </DT>
+<DD>- returns minimal value of raster object.
+</DD>
+
+<DT><I>rasterName <B>offsite </B></I> ?<I>value </I>? </DT>
+<DD>- returns offsite value for raster object,
+or modifies it. </DD>
+
+<DT><I>rasterName <B>polygon<I> value x y x y ... </I></B></I> </DT>
+<DD>- fills given polygon
+of given value. Returns boundaries of region affected. </DD>
+
+<DT><I>rasterName <B>put<I> value
+x y </I></B></I> </DT>
+<DD>Changes value of individual cell. Returns nothing. </DD>
+
+<DT><I>rasterName <B>reclass
+</B></I> ?<I>option </I>? ?<I>arg </I>? </DT>
+<DD>- manipulates reclass table. Without any options, returns
+reclass table as Tcl list. </DD>
+
+<DT><I>rasterName <B>reclass -statements </B></I> </DT>
+<DD>option returns
+reclass table in form of reclass statements. (see <B> RECLASS SYNTAX </B> below).
+</DD>
+
+<DT><I>rasterName <B>reclass -table<I> list </I></B></I> </DT>
+<DD>modifies current reclass using given Tcl
+list. Values for classes given in this list would be changed as specified,
+all other remains unchanged. </DD>
+
+<DT><I>rasterName <B>reclass <I>statements </I></B></I> </DT>
+<DD>modifies reclass
+using specified reclass statements. As <B>-table </B> options, applies statements
+to base classes and leaves all nonspecified classes as is. </DD>
+
+<DT><I>rasterName <B>reclass
+-clear </B></I> </DT>
+<DD>clears all changes in reclass table and makes reclassed classes
+equial to base classes. </DD>
+
+<DT><I>rasterName <B>row<I> y </I></B></I> </DT>
+<DD>return cell number, correspondign
+to given Y coordinate. Raises error, if coodinnate is outside file limits.
+</DD>
+
+<DT><I>rasterName <B>save </B></I> ?<I>options </I>? </DT>
+<DD>- saves raster file. By default, if raster
+is in readwrite mode, saves changes to current filename. </DD>
+
+<DT><I>rasterName <B>save
+-as<I> filename </I></B></I> </DT>
+<DD>- saves raster, open for editing into other file, and makes
+this file current file of this raster object. </DD>
+
+<DT><B>-backup </B> </DT>
+<DD>option can be specified
+for both <B>save </B> and <B>save -as </B>commands. It makes raster object to keep old
+version of file with suffix <I>.bak </I> appended to name. </DD>
+
+<DT><I>rasterName <B>save -to<I> filename
+</I></B></I> ?<B>-8bit </B>? </DT>
+<DD>allows to write raster object into raster file. Reclass table
+is applied to this operation, so new file would have base classes like
+classes of raster object, rather than classes of its base file. </DD>
+</DL>
+<P>
+ If <B>-8bit
+</B> switch is specified, resulting raster will be forced to 8-bit by discarding
+high-order byte, even if max value or offsite are outside 0-255 range. (in
+latter case offsite would be set to 65535).
+<DL>
+
+<DT><I>rasterName <B>shift <I> dx dy </I></B></I> </DT>
+<DD>changes
+origin of cell (row/column) numbers. This is required for certain command
+of DOS version of EPPL7, although fGIS always uses map (alternative) coordinates)
+</DD>
+
+<DT><I>rasterName <B>transect </B></I> ?<B>-count<I> varname </I></B>? <I>x y x y ... </I> </DT>
+<DD>by default, return list
+consisting of pairs {value width} along the given line. If <B>-count </B> is specified,
+fills dynamic array <I>varname </I>, indexed by classes, by total widthes of
+given value along this line. </DD>
+
+<DT><I>rasterName <B>unused </B></I> </DT>
+<DD>returns value which is
+never encountered in this raster. </DD>
+
+<DT><I>rasterName <B>unit </B></I> ?<I>new-unit </I>? </DT>
+<DD>- returns
+(or changes) area unit of this raster Unit can be one of following: <B>undefined
+</B>,<B>ft </B>.<B>m </B>,<B>km </B>,<B>mile </B>,<B>ha </B>,<B>acre </B>. All subsequent count operations would return
+result in given units. <B>Note: </B> map coordinates are always in meters. </DD>
+
+<DT><I>rasterName
+<B>xleft </B></I> ?<I>new value </I>? </DT>
+<DD>- returns (or modifies) left boundary coordinate.<B>Note:
+</B> it simply modifies value, without appropriate changes in other limits
+or cell area value. </DD>
+
+<DT><I>rasterName <B>xright </B></I> ?<I>new value </I>? </DT>
+<DD>- returns (or modifies)
+right boundary coordinate. </DD>
+
+<DT><I>rasterName <B>ybottom </B></I> ?<I>new value </I>? </DT>
+<DD>- returns
+(or modifies) bottom boundary coordinate. </DD>
+
+<DT><I>rasterName <B>ytop </B></I> ?<I>new value
+</I>? </DT>
+<DD>- returns (or modifies) left boundary coordinate. </DD>
+</DL>
+
+<H2><A NAME="sect5" HREF="#toc5">RECLASS SYNTAX </A></H2>
+<P>
+ Syntax
+of reclass syntax is inherited from EPPL7. General form of reclass statement
+is line, terminated by newline (<B>Note: </B> trailing newline is obligatory),
+which consist of new value and list of old (base) values. New value separated
+from list by equal sign. List of old values can contain individual values
+and ranges, which are two values, separated by colon. <P>
+
+<DL>
+
+<DT>Example </DT>
+<DD>1=1:10
+20 </DD>
+</DL>
+<P>
+means, that all values from one to ten and value 20 should be reclassed
+into 1. <P>
+ Set of statements can contain arbitrary number of lines, same
+value can occur on left side of several lines. If some value occur on right
+side more than once, last occurence have precedence. <P>
+
+<HR><P>
+<A NAME="toc"><B>Table of Contents</B></A><P>
+<UL>
+<LI><A NAME="toc0" HREF="#sect0">NAME</A></LI>
+<LI><A NAME="toc1" HREF="#sect1">SYNOPSIS</A></LI>
+<LI><A NAME="toc2" HREF="#sect2">DESCRIPTION</A></LI>
+<LI><A NAME="toc3" HREF="#sect3">OPTIONS</A></LI>
+<LI><A NAME="toc4" HREF="#sect4">OBJECT COMMAND</A></LI>
+<LI><A NAME="toc5" HREF="#sect5">RECLASS SYNTAX</A></LI>
+</UL>
+</BODY></HTML>
projects / sites / home_page.git / blobdiff