]> www.wagner.pp.ru Git - oss/fgis.git/blob - man/outtable.1
First checked in version
[oss/fgis.git] / man / outtable.1
1 .TH OUTTABLE 1 "Version 1.0" "Environmental planning utilities" "EPU user manual"
2 .SH NAME
3 outtable \- computes table of statistics from several epp files.
4 .SH SYNOPSIS
5 .B outtable 
6 .RI [ options ]
7 .RI [ function "] file [ [" function "] file ...]"
8
9 .SH DESCRIPTION
10 .B outtable 
11 takes several 
12 .IR epp -files
13 counts all possible combinations of classes in them and produces
14 table of them. 
15 .PP
16 Some files  can be preceded by 
17 .I function
18 Such files wouldn't be used to define new combination. Instead, corresponding
19 column of table would contain value of function, computed from this file for
20 area, defined by combination of classes of all "function-less" files.
21 .PP
22 All files, used to define combination, should be specified before first
23 file with function.
24 .PP
25 If no function defined, table would be appended by column, containing area
26 of each combination.
27 .PP
28 If all files have function, table would contain only one row, containing
29 values of the functions for all area.
30 .PP
31 If files have different cell size and limits, limits and coordinate systems
32 of the first file are used, unless overriden by 
33 .B
34 --base
35 option.
36 .PP
37 By default, semantic value of classes are considered equial to values of
38 classes. This can be overridden by specifying parameters of linear mapping
39 function using 
40
41 .BR -z " and " -Z " options."
42 This option can be specified only once per invocation, becouse usially
43 .B outtable
44 is used to calculate statistics for one file in combinations, given by
45 several other files.
46 .PP
47 By default, all area-related values are calculated in alternative coordinate
48 units. It can be overriden using 
49 .B -c
50 option.
51 .SH OPTIONS
52 .TP 8
53 .B --help
54 displays brief usage information.
55 .TP 8
56 .B --version
57 displays version number
58 .TP 8
59 .B --verbose -%
60 Displays percentage of processed lines in file.
61 .TP 8
62 .B -u --union 
63 Take into account all cells, where at least one of output files is not offsite.
64 By default, only cells where all input files are onsite are taken into account.
65 .TP 8
66 .B -c --cells
67 Output areas in cells. By default map units as specified in file header
68 are used to compute areas.
69 .TP 8
70 .BI -d "char " --delimiter= char 
71 sets table column separator to 
72 .I char. Defaults to comma.
73 .TP 8
74 .BI -b " file" --base " file"
75 Specifies epp file, used as reference grid. Cell area and cell size of this
76 file, as well as its coordinate limits would be used for processing. 
77 Defaults to first file in the command line.
78 .TP 8
79 .BI -z " value"
80 Specifies multiplier for calculating semantic value from class value.
81 .TP 8
82 .BI -Z " value"
83 Specifies offset of semantic values, i.e. semantic value of class 0.
84 .SH FUNCTIONS
85 .TP 8
86 .B -sum
87 Sum of classes in given file for combination, multiplied by cell area.
88 .TP 8
89 .B -cnt
90 Count of onsite cells of given file.
91 .TP 8
92 .B -avg
93 Average cell value
94 .TP 8
95 .B -min
96 Minimum cell value
97 .TP 8
98 .B -nmin
99 Area of cells with minimum value
100
101 .TP 8
102 .B -max
103 Maximum cell value
104 .TP 8
105 .B -nmax
106 Area of cells with maximum value
107 .TP 8
108 .B -mode
109 Modal value (value of most cells)
110 .TP 8
111 .B -nmode
112 Area of cells with modal value
113 .TP 8
114 .B -fewest
115 Class with fewest cells
116 .TP 8
117 .B -nfewest
118 Area of cells in fewest class
119 .TP 8
120 .B -range
121 Range of classes (maximum-minimum)
122 .TP 8
123 .B -classes
124 Number of different classes
125 .TP 8
126 .B -or
127 Bitwise or of all cells (values of 
128 .BR -z " and " -Z
129 options are not used)
130 .TP 8
131 .B -and
132 Bitwise and of all cells (values of 
133 .BR -z " and " -Z
134 options are not used)
135 .TP 8
136 .B -std
137 Standard deviation of classes
138 .TP 8
139 .B -var
140 Variance of classes
141 .TP 8
142 .B -corr
143 Correlation coefficient between two files. Requires two arguments.
144 .SH SEE ALSO
145 .BR intable (1), reclass (1), evaluate (1), resample (1), eheader (1)
146
147 .SH AUTHOR
148
149 Victor B. Wagner <vitus@agropc.msk.su>
150
151 .SH BUGS
152
153 ???