This file is indexed.

/usr/share/doc/gmt/html/man/sphinterpolate.html is in gmt-doc 4.5.11-1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<!-- Creator     : groff version 1.19.2 -->
<!-- CreationDate: Tue Nov  5 09:45:50 2013 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p     { margin-top: 0; margin-bottom: 0; }
       pre   { margin-top: 0; margin-bottom: 0; }
       table { margin-top: 0; margin-bottom: 0; }
</style>
<title>SPHINTERPOLATE</title>

</head>
<body bgcolor="#ffffff">

<h1 align=center>SPHINTERPOLATE</h1>

<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#ASCII FORMAT PRECISION">ASCII FORMAT PRECISION</a><br>
<a href="#GRID VALUES PRECISION">GRID VALUES PRECISION</a><br>
<a href="#EXAMPLES">EXAMPLES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#REFERENCES">REFERENCES</a><br>

<hr>


<a name="NAME"></a>
<h2>NAME</h2>


<p style="margin-left:11%; margin-top: 1em">sphinterpolate
&minus; Gridding in tension of spherical data</p>

<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>



<p style="margin-left:11%; margin-top: 1em"><b>sphinterpolate</b>
<i>infiles</i> <b>&minus;G</b><i>grdfile</i> [
<b>&minus;F</b> ] [ <b>&minus;H</b>[<b>i</b>][<i>nrec</i>] ]
[
<b>&minus;I</b><i>xinc</i>[<i>unit</i>][<b>=</b>|<b>+</b>][/<i>yinc</i>[<i>unit</i>][<b>=</b>|<b>+</b>]]
] [ <b>&minus;Q</b><i>mode</i>[/<i>options</i>] ] [
<b>&minus;R</b><i>west</i>/<i>east</i>/<i>south</i>/<i>north</i>[<b>r</b>]
] [ <b>&minus;V</b> ] [ <b>&minus;Z</b> ] [
<b>&minus;:</b>[<b>i</b>|<b>o</b>] ] [
<b>&minus;b</b>[<b>i</b>|<b>o</b>][<b>s</b>|<b>S</b>|<b>d</b>|<b>D</b>[<i>ncol</i>]|<b>c</b>[<i>var1</i><b>/</b><i>...</i>]]
][ <b>&minus;m</b>[<b>i</b>|<b>o</b>][<i>flag</i>] ]</p>

<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>



<p style="margin-left:11%; margin-top: 1em"><b>sphinterpolate</b>
reads one or more ASCII [or binary] files (or standard
input) containing lon, lat, f and performs a Delaunay
triangulation to set up a spherical interpolation in
tension. The final grid is saved to the specified file.
Several options may be used to affect the outcome, such as
choosing local versus global gradient estimation or optimize
the tension selection to satisfy one of four criteria.
<i><br>
infiles</i></p>

<p style="margin-left:22%;">Data files with the (lon, lat,
f) coordinates in ASCII (or binary; see <b>&minus;b</b>). If
no files are given the standard input is read.</p>

<table width="100%" border=0 rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">



<p style="margin-top: 1em" valign="top"><b>&minus;G</b></p> </td>
<td width="8%"></td>
<td width="76%">


<p style="margin-top: 1em" valign="top">Name of the output
grid to hold the interpolation.</p></td>
<td width="2%">
</td>
</table>

<a name="OPTIONS"></a>
<h2>OPTIONS</h2>


<table width="100%" border=0 rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;F</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Force pixel node
registration [Default is gridline registration]. (Node
registrations are defined in <b><A HREF="GMT.html">GMT</A></b> Cookbook Appendix B
on grid file formats.)</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;H</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Input file(s) has
header record(s). If used, the default number of header
records is <b><A HREF="gmtdefaults.html#N_HEADER_RECS">N_HEADER_RECS</A></b>. Use <b>&minus;Hi</b> if
only input data should have header records [Default will
write out header records if the input data have them]. Blank
lines and lines starting with # are always skipped.</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;I</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top"><i>x_inc</i> [and
optionally <i>y_inc</i>] is the grid spacing. Optionally,
append a suffix modifier. <b>Geographical (degrees)
coordinates</b>: Append <b>m</b> to indicate arc minutes or
<b>c</b> to indicate arc seconds. If one of the units
<b>e</b>, <b>k</b>, <b>i</b>, or <b>n</b> is appended
instead, the increment is assumed to be given in meter, km,
miles, or nautical miles, respectively, and will be
converted to the equivalent degrees longitude at the middle
latitude of the region (the conversion depends on
<b><A HREF="gmtdefaults.html#ELLIPSOID">ELLIPSOID</A></b>). If /<i>y_inc</i> is given but set to 0 it
will be reset equal to <i>x_inc</i>; otherwise it will be
converted to degrees latitude. <b>All coordinates</b>: If
<b>=</b> is appended then the corresponding max <i>x</i>
(<i>east</i>) or <i>y</i> (<i>north</i>) may be slightly
adjusted to fit exactly the given increment [by default the
increment may be adjusted slightly to fit the given domain].
Finally, instead of giving an increment you may specify the
<i>number of nodes</i> desired by appending <b>+</b> to the
supplied integer argument; the increment is then
recalculated from the number of nodes and the domain. The
resulting increment value depends on whether you have
selected a gridline-registered or pixel-registered grid; see
Appendix B for details. Note: if
<b>&minus;R</b><i>grdfile</i> is used then grid spacing has
already been initialized; use <b>&minus;I</b> to override
the values.</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;Q</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Specify one of four
ways to calculate tension factors to preserve local shape
properties or satisfy arc constraints [Default is no
tension].</p> </td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p style="margin-top: 1em" valign="top"><b>&minus;Q</b>
0</p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Piecewise linear
interpolation; no tension is applied.</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p style="margin-top: 1em" valign="top"><b>&minus;Q</b>
1</p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Smooth
interpolation with local gradient estimates.</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p style="margin-top: 1em" valign="top"><b>&minus;Q</b>
2</p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Smooth
interpolation with global gradient estimates. You may
optionally append /<i>N</i>/<i>M</i>/<i>U</i>, where
<i>N</i> is the number of iterations used to converge at
solutions for gradients when variable tensions are selected
(e.g., <b>&minus;T</b> only) [3], <i>M</i> is the number of
Gauss-Seidel iterations used when determining the global
gradients [10], and <i>U</i> is the maximum change in a
gradient at the last iteration [0.01].</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p style="margin-top: 1em" valign="top"><b>&minus;Q</b>
3</p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Smoothing.
Optionally append <i>/E/U</i> [/0/0], where <i>E</i> is
Expected squared error in a typical (scaled) data value, and
<i>U</i> is Upper bound on weighted sum of squares of
deviations from data.</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;R</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top"><i>west, east,
south,</i> and <i>north</i> specify the Region of interest,
and you may specify them in decimal degrees or in
[+-]dd:mm[:ss.xxx][W|E|S|N] format. Append <b>r</b> if lower
left and upper right map coordinates are given instead of
w/e/s/n. The two shorthands <b>&minus;Rg</b> and
<b>&minus;Rd</b> stand for global domain (0/360 and
-180/+180 in longitude respectively, with -90/+90 in
latitude). Alternatively, specify the name of an existing
grid file and the <b>&minus;R</b> settings (and grid
spacing, if applicable) are copied from the grid.</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;T</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Use variable
tension (ignored with <b>&minus;Q</b> 0 [constant]</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;V</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Selects verbose
mode, which will send progress reports to stderr [Default
runs &quot;silently&quot;].</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;Z</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Before
interpolation, scale data by the maximum data range [no
scaling].</p> </td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;:</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Toggles between
(longitude,latitude) and (latitude,longitude) input and/or
output. [Default is (longitude,latitude)]. Append <b>i</b>
to select input only or <b>o</b> to select output only.
[Default affects both].</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;bi</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Selects binary
input. Append <b>s</b> for single precision [Default is
<b>d</b> (double)]. Uppercase <b>S</b> or <b>D</b> will
force byte-swapping. Optionally, append <i>ncol</i>, the
number of columns in your binary input file if it exceeds
the columns needed by the program. Or append <b>c</b> if the
input file is netCDF. Optionally, append
<i>var1</i><b>/</b><i>var2</i><b>/</b><i>...</i> to specify
the variables to be read. [Default is 3 input columns].</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;bo</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Selects binary
output. Append <b>s</b> for single precision [Default is
<b>d</b> (double)]. Uppercase <b>S</b> or <b>D</b> will
force byte-swapping. Optionally, append <i>ncol</i>, the
number of desired columns in your binary output file.
[Default is same as input].</p></td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">



<p style="margin-top: 1em" valign="top"><b>&minus;m</b></p> </td>
<td width="5%"></td>
<td width="78%">


<p style="margin-top: 1em" valign="top">Multiple segment
file(s). Segments are separated by a special record. For
ASCII files the first character must be <i>flag</i> [Default
is &rsquo;&gt;&rsquo;]. For binary files all fields must be
NaN and <b>&minus;b</b> must set the number of output
columns explicitly. By default the <b>&minus;m</b> setting
applies to both input and output. Use <b>&minus;mi</b> and
<b>&minus;mo</b> to give separate settings to input and
output.</p> </td>
</table>

<a name="ASCII FORMAT PRECISION"></a>
<h2>ASCII FORMAT PRECISION</h2>


<p style="margin-left:11%; margin-top: 1em">The ASCII
output formats of numerical data are controlled by
parameters in your .gmtdefaults4 file. Longitude and
latitude are formatted according to
<b><A HREF="gmtdefaults.html#OUTPUT_DEGREE_FORMAT">OUTPUT_DEGREE_FORMAT</A></b>, whereas other values are
formatted according to <b><A HREF="gmtdefaults.html#D_FORMAT">D_FORMAT</A></b>. Be aware that the
format in effect can lead to loss of precision in the
output, which can lead to various problems downstream. If
you find the output is not written with enough precision,
consider switching to binary output (<b>&minus;bo</b> if
available) or specify more decimals using the
<b><A HREF="gmtdefaults.html#D_FORMAT">D_FORMAT</A></b> setting.</p>

<a name="GRID VALUES PRECISION"></a>
<h2>GRID VALUES PRECISION</h2>


<p style="margin-left:11%; margin-top: 1em">Regardless of
the precision of the input data, GMT programs that create
grid files will internally hold the grids in 4-byte floating
point arrays. This is done to conserve memory and
furthermore most if not all real data can be stored using
4-byte floating point values. Data with higher precision
(i.e., double precision values) will lose that precision
once GMT operates on the grid or writes out new grids. To
limit loss of precision when processing data you should
always consider normalizing the data prior to
processing.</p>

<a name="EXAMPLES"></a>
<h2>EXAMPLES</h2>


<p style="margin-left:11%; margin-top: 1em">To interpolate
the points in the file testdata.txt on a global 1x1 degree
grid with no tension, use</p>


<p style="margin-left:11%; margin-top: 1em"><b>sphinterpolate</b>
testdata.txt <b>&minus;Rg &minus;I</b>1
<b>&minus;G</b>solution.grd</p>

<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>


<p style="margin-left:11%; margin-top: 1em"><i><A HREF="GMT.html">GMT</A></i>(1),
<i><A HREF="greenspline.html">greenspline</A></i>(1) <i><A HREF="sphdistance.html">sphdistance</A></i>(1)
<i><A HREF="sphtriangulate.html">sphtriangulate</A></i>(1) <i><A HREF="triangulate.html">triangulate</A></i>(1)</p>

<a name="REFERENCES"></a>
<h2>REFERENCES</h2>


<p style="margin-left:11%; margin-top: 1em">Renka, R, J.,
1997, Algorithm 772: STRIPACK: Delaunay Triangulation and
Voronoi Diagram on the Surface of a Sphere, <i>AMC Trans.
Math. Software, 23</i> (3), 416&minus;434. <br>
Renka, R, J,, 1997, Algorithm 773: SSRFPACK: Interpolation
of scattered data on the Surface of a Sphere with a surface
under tension, <i>AMC Trans. Math. Software, 23</i> (3),
435-442.</p>
<hr>
</body>
</html>