Codebase list pktools / 7022328
Add manpage for pkstatprofile. Bas Couwenberg 8 years ago
2 changed file(s) with 256 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
+1
-0
debian/changelog less more
33 * Update libgsl-dev dependency for pktools-dev too.
44 * Drop gdal-2.0.patch, applied upstream.
55 * Update symbols for amd64.
6 * Add manpage for pkstatprofile.
67
78 -- Bas Couwenberg <sebastic@debian.org> Fri, 18 Dec 2015 02:55:14 +0100
89
+255
-0
debian/man/pkstatprofile.1.xml less more
0 <?xml version="1.0" encoding="UTF-8"?>
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
2 <refentry id='pkstatprofile'>
3
4 <refmeta>
5 <refentrytitle>pkstatprofile</refentrytitle>
6 <manvolnum>1</manvolnum>
7 </refmeta>
8
9 <refnamediv>
10 <refname>pkstatprofile</refname>
11 <refpurpose>program to calculate statistics in temporal or spectral profile</refpurpose>
12 </refnamediv>
13
14 <refsynopsisdiv id='synopsis'>
15 <cmdsynopsis>
16 <command>pkstatprofile</command>
17 <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
18 <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
19 <arg choice='opt'><option>-f</option> <replaceable>function</replaceable></arg>
20 <arg choice='opt'><replaceable>options</replaceable></arg>
21 </cmdsynopsis>
22 </refsynopsisdiv>
23
24 <refsect1 id='description'>
25 <title>DESCRIPTION</title>
26 <para>
27 <command>pkstatprofile</command> calculates statistics for a temporal
28 (time series) or spectral profile.
29 </para>
30 <para>
31 <informaltable frame='none'>
32 <tgroup cols='2'>
33 <thead>
34 <row>
35 <entry>Function</entry>
36 <entry>Description</entry>
37 </row>
38 </thead>
39 <tbody>
40 <row>
41 <entry>mean</entry>
42 <entry>calculate mean in window</entry>
43 </row>
44 <row>
45 <entry>median</entry>
46 <entry>perform a median filter in spatial (dx, dy) or spectral/temporal (dz) domain</entry>
47 </row>
48 <row>
49 <entry>var</entry>
50 <entry>calculate variance in window</entry>
51 </row>
52 <row>
53 <entry>stdev</entry>
54 <entry>calculate standard deviation in window</entry>
55 </row>
56 <row>
57 <entry>min</entry>
58 <entry>calculate minimum in window</entry>
59 </row>
60 <row>
61 <entry>max</entry>
62 <entry>calculate maximum in window</entry>
63 </row>
64 <row>
65 <entry>sum</entry>
66 <entry>calculate sum in window</entry>
67 </row>
68 <row>
69 <entry>mode</entry>
70 <entry>calculate mode of all values</entry>
71 </row>
72 <row>
73 <entry>ismin</entry>
74 <entry>1 if value is minimum, else 0</entry>
75 </row>
76 <row>
77 <entry>ismax</entry>
78 <entry>1 if value is maximum, else 0</entry>
79 </row>
80 <row>
81 <entry>per</entry>
82 <entry>calculate percentile in time series (provide percentage value as argument)</entry>
83 </row>
84 <row>
85 <entry>prop</entry>
86 <entry>calculate proportion</entry>
87 </row>
88 <row>
89 <entry>nvalid</entry>
90 <entry>report number of valid observations</entry>
91 </row>
92 </tbody>
93 </tgroup>
94 </informaltable>
95 </para>
96 </refsect1>
97
98 <refsect1 id='options'>
99 <title>OPTIONS</title>
100 <variablelist>
101
102 <varlistentry>
103 <term><option>-i</option> <replaceable>filename</replaceable></term>
104 <term><option>--input</option> <replaceable>filename</replaceable></term>
105 <listitem>
106 <para>
107 Input image file.
108 </para>
109 </listitem>
110 </varlistentry>
111
112 <varlistentry>
113 <term><option>-o</option> <replaceable>filename</replaceable></term>
114 <term><option>--output</option> <replaceable>filename</replaceable></term>
115 <listitem>
116 <para>
117 Output image file
118 </para>
119 </listitem>
120 </varlistentry>
121
122 <varlistentry>
123 <term><option>-f</option> <replaceable>function</replaceable></term>
124 <term><option>--function</option> <replaceable>function</replaceable></term>
125 <listitem>
126 <para>
127 Statistics function (mean, median, var, stdev, min, max, sum,
128 mode (provide classes), ismin, ismax, proportion (provide classes),
129 percentile, nvalid
130 </para>
131 </listitem>
132 </varlistentry>
133
134 <varlistentry>
135 <term><option>-perc</option> <replaceable>percentile</replaceable></term>
136 <term><option>--perc</option> <replaceable>percentile</replaceable></term>
137 <listitem>
138 <para>
139 Percentile value(s) used for rule percentile
140 </para>
141 </listitem>
142 </varlistentry>
143
144 <varlistentry>
145 <term><option>-class</option> <replaceable>class</replaceable></term>
146 <term><option>--class</option> <replaceable>class</replaceable></term>
147 <listitem>
148 <para>
149 class value(s) to use for mode, proportion
150 </para>
151 </listitem>
152 </varlistentry>
153
154 <varlistentry>
155 <term><option>-nodata</option> <replaceable>value</replaceable></term>
156 <term><option>--nodata</option> <replaceable>value</replaceable></term>
157 <listitem>
158 <para>
159 Set nodata value(s)
160 </para>
161 </listitem>
162 </varlistentry>
163
164 <varlistentry>
165 <term><option>-ot</option> <replaceable>type</replaceable></term>
166 <term><option>--otype</option> <replaceable>type</replaceable></term>
167 <listitem>
168 <para>
169 Data type for output image
170 ({Byte / Int16 / UInt16 / UInt32 / Int32 / Float32 / Float64 / CInt16 / CInt32 / CFloat32 / CFloat64}).
171 Empty string: inherit type from input image.
172 </para>
173 </listitem>
174 </varlistentry>
175
176 <varlistentry>
177 <term><option>-of</option> <replaceable>format</replaceable></term>
178 <term><option>--oformat</option> <replaceable>format</replaceable></term>
179 <listitem>
180 <para>
181 Output image format (see also
182 <citerefentry>
183 <refentrytitle>gdal_translate</refentrytitle>
184 <manvolnum>1</manvolnum>
185 </citerefentry>).
186 </para>
187 </listitem>
188 </varlistentry>
189
190 <varlistentry>
191 <term><option>-ct</option> <replaceable>filename</replaceable></term>
192 <term><option>--ct</option> <replaceable>filename</replaceable></term>
193 <listitem>
194 <para>
195 Color table (file with 5 columns:
196 id R G B ALFA (0: transparent, 255: solid).
197 Use none to ommit color table.
198 </para>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry>
203 <term><option>-co</option> <replaceable>NAME=VALUE</replaceable></term>
204 <term><option>--co</option> <replaceable>NAME=VALUE</replaceable></term>
205 <listitem>
206 <para>
207 Creation option for output file.
208 Multiple options can be specified.
209 </para>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry>
214 <term><option>-d</option> <replaceable>value</replaceable></term>
215 <term><option>--down</option> <replaceable>value</replaceable></term>
216 <listitem>
217 <para>
218 Down sampling factor.
219 Use value 1 for no downsampling.
220 Use value n&gt;1 for downsampling (aggregation).
221 </para>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry>
226 <term><option>-v</option> <replaceable>level</replaceable></term>
227 <term><option>--verbose</option> <replaceable>level</replaceable></term>
228 <listitem>
229 <para>
230 Verbose mode if > 0
231 </para>
232 </listitem>
233 </varlistentry>
234
235 </variablelist>
236
237 </refsect1>
238
239 <refsect1 id='example'>
240 <title>EXAMPLE</title>
241
242 <example>
243 <para>
244 Calculate min and max NDVI in time series
245 </para>
246
247 <screen>
248 <command>pkstatprofile</command> <option>-i</option> <replaceable>modis_ndvi_2010.tif</replaceable> <option>-o</option> <replaceable>modis_stats_2010.tif</replaceable> <option>-f</option> <replaceable>min</replaceable> <option>-f</option> <replaceable>max</replaceable>
249 </screen>
250 </example>
251
252 </refsect1>
253
254 </refentry>