File: ossim-equation.1

package info (click to toggle)
ossim 2.6.2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 29,924 kB
  • sloc: cpp: 380,481; ansic: 15,191; sh: 1,953; lex: 183; xml: 141; sql: 78; makefile: 78; csh: 6
file content (175 lines) | stat: -rw-r--r-- 5,182 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
.TH OSSIM-EQUATION "1" "December 2015" "ossim-equation 1.8.20" "User Commands"
.SH NAME
ossim-equation \- ossim-equation
.SH SYNOPSIS
.B ossim-equation
\fI\,"<equation spec>" <input_file1> <input_file2> <input_file\/\fR...\fI\,> <output_file>\/\fR
.SH DESCRIPTION
Description:
ossim\-equation Takes a list of images and performs the specified equation. The inputsmust be in the same projection as the operations are done at the pixellevel with no renderer in th chain. The output file will contain the samegeospatial header info as the first image in the input list.
.SH OPTIONS
.TP
\fB\-\-writer\-prop\fR <string>
Adds a property to send to the writer. format is
name=value
.TP
\fB\-h\fR or \fB\-\-help\fR
Display this information
.TP
\fB\-k\fR <filename>
keyword list to load from
.TP
\fB\-t\fR <filename>
output a keyword list template
.TP
\fB\-w\fR <type>
Writer type (tiff_strip, jpeg, etc... see ossim\-info
\fB\-\-writers\fR) (default=tiff_strip)
.PP
Equation Specification:
.PP
sin(x)                 takes the sine of the input
sind(x)                takes the sin of the input and assumes degree input
cos(x)                 takes cosine of input
cosd(x)                takes the cosine of input and assumes input in degrees
sqrt(x)                takes square root of input
log(x)                 takes the natural log of input
log10(x)               takes the log base 10 of the input
exp(x)                 takes the e raised to the passed in argument
abs(x)                 takes the absolute value of the passed in value
min(x1, x2, ... xn)    takes the min of all values in the list
max(x1, x2, ... xn)    takes the max of all values in the list.
.PP
clamp(image_data, min, max)
.TP
will clamp all data to be between the min max values.
will set anything less than min to min and anythin
larger than max to max
.PP
band(image_data, num)  returns a single band image object
.TP
by selecting band num from input image i1.
Note
.TP
the first argument must be an image
and the second argument must be a number
.PP
shift(index, num_x, num_y)
.TP
currently, the first argument must be an image
variable(i1, i2, ... in) and x, and y must b numbers
indicating the delta in that direction to shift the
input.
.PP
blurr(index, rows, cols)
.TP
Will blurr the input image i with a
rows\-by\-cols kernel.  All values are equal
weight.  Note the fist argument must by an image
variable (ex: i1, i2,....in).
.PP
conv(index, rows, cols, <row ordered list of values> )
.TP
this allows you to define an arbitrary matrix.
The
.TP
<row ordered list of values> is a comma separated
list of constant values.
.PP
assign_band(image_data, num1, data2, num2)
.TP
will take band num2 from image data2 and assign it to
band num1 in data 1.
.PP
assign_band(image_data, num1, data2)
.TP
will take band 1 from image data2 and assign it to
band num1 in data 1.
.PP
assign_band(image_data, num1, num2)
.IP
will assin to band num1 of data 1 the value of num2
.PP
x1 * x2                will multiply x1 and x2
x1 + x2                will add x1 and x2
x1 \- x2                will subtract x1 and x2
x1 / x2                will divide x1 and x2
x1 ^ x2                will do a power, raises x1 to x2
x1 | x2                will do a bitwise or operation
.IP
( will do it in unisgned char precision)
.PP
x1 & x2                will do a bitwise and operation
.IP
( will do it in unsigned char precision)
.PP
~x1                    will do the ones complement of the input
.PP
x1 xor x2              will do an xclusive or operation
.IP
(will do it in unsigned char precision)
.PP
\- x1                   will negative of x1
.PP
Boolean ops: 1=true, 0=false
x1 > x2
x1 >= x2
x1 == x2
x1 <= x2
x1 < x2
x1 <> x2
.PP
Note:
.PP
Currently an image input is reference by the variable in[<I>] where
<I> is the input image index beginning at 0.  So 1 referes to the second image
in the input list.
.PP
(in[0] + in[1])/2
Will take image 1 and add it to image 2 and average them.
.PP
exp(sqrt(in[0])/4)
Will take the root of the image and divide by 4 and then raise e to that
amount.
.PP
128
Will return a constant value of 128 for all input bands.
.PP
min(1,in[2],in[3], max(in[1],in[0]))
.PP
shift(0, 1, 1) \- i1
Will shift input 0 by 1 pixel along the diagonal  and then subtract it
from input 1.
.PP
assign_band(in[0], 1, blurr(in[0], 5, 5), 2)
Will assign to the first band of i1 the 2nd band of the 5x5 blurr of i1.
.PP
conv(0, 3, 3, \fB\-1\fR, \fB\-2\fR, \fB\-1\fR, 0, 0, 0, 1, 2, 1)
Will convolve the first input connection with a 3x3 matrix.
The args are row ordered:
.TP
\fB\-1\fR, \fB\-2\fR, \fB\-1\fR
0,  0,  0
1,  2,  1
.PP
NDVI:
N=(in[0]\-in[1])/(in[0]+in[1])
.PP
For indexed\-type values,like NDVI, (with limited values) it is better
to rescale between 0.0 and 1.0 and use type NormalizedFloat.
.PP
Rescaled NDVI between 0 and 1:
(N+1)/2 = in[0]/(in[0]+in[1])
.SH "SEE ALSO"
The full documentation for
.B ossim-equation
is maintained as a Texinfo manual.  If the
.B info
and
.B ossim-equation
programs are properly installed at your site, the command
.IP
.B info ossim-equation
.PP
should give you access to the complete manual.