/usr/share/doc/gmt/html/man/x2sys_datalist.html is in gmt-doc 4.5.12-1.
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 | <!-- Creator : groff version 1.22.2 -->
<!-- CreationDate: Thu Feb 27 18:15:39 2014 -->
<!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; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>X2SYS_DATALIST</title>
</head>
<body bgcolor="#ffffff">
<h1 align="center">X2SYS_DATALIST</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="#EXAMPLES">EXAMPLES</a><br>
<a href="#CORRECTIONS">CORRECTIONS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">x2sys_datalist
− A generic data-extractor for ASCII or binary
files</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>x2sys_datalist</b>
<i>track(s)</i> <b>−T</b><i>TAG</i> [ <b>−A</b>
] [ <b>−F</b><i>name1,name2,...</i> ] [
<b>−H</b>[<b>i</b>][<i>nrec</i>] ] [
<b>−L</b>[<i>corrtable</i>] ] [
<b>−R</b><i>west</i>/<i>east</i>/<i>south</i>/<i>north</i>[<b>r</b>]
] [ <b>−S</b> ] [ <b>−V</b> ] [
<b>−bo</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>−m</b>[<i>flag</i>] ]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>x2sys_datalist</b>
reads one or more files and produces a single ASCII [or
binary] table. The files can be of any format, which must be
described and passed with the <b>−T</b> option. You
may limit the output to a geographic region, and insist that
the output from several files be separated by a multiple
segment header. Only the named data fields will be output
[Default selects all columns].</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="9%">
<p><i>tracks</i></p></td>
<td width="2%"></td>
<td width="78%">
<p>Can be one or more ASCII, native binary, or COARDS
netCDF 1-D data files. To supply the data files via a text
file with a list of tracks (one per record), specify the
name of the track list after a leading equal-sign (e.g.,
=tracks.lis). If the names are missing their file extension
we will append the suffix specified for this <i>TAG</i>.
Track files will be searched for first in the current
directory and second in all directories listed in
<b>$X2SYS_HOME</b>/<i>TAG</i>/<i>TAG</i>_paths.txt (if it
exists). [If <b>$X2SYS_HOME</b> is not set it will default
to <b>$GMT_SHAREDIR</b>/x2sys]. (Note: MGD77 files will also
be looked for via <b>MGD77_HOME</b>/mgd77_paths.txt and
*.gmt files will be searched for via
<b>$GMT_SHAREDIR</b>/mgg/gmtfile_paths).</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>−T</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Specify the x2sys <i>TAG</i> which tracks the attributes
of this data type.</p></td></tr>
</table>
<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">No space
between the option flag and the associated arguments.</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="4%">
<p style="margin-top: 1em"><b>−A</b></p></td>
<td width="7%"></td>
<td width="78%">
<p style="margin-top: 1em">Eliminate COEs by distributing
the COE between the two tracks in proportion to track
weight. These (dist, adjustment) spline knots files for each
track and data column are called <i>track.column</i>.adj and
are expected to be in the <b>$X2SYS_HOME</b>/<i>TAG</i>
directory. The adjustments are only applied if the
corresponding adjust file can be found [No residual
adjustments]</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−F</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>Give a comma-separated sub-set list of column names
defined in the definition file. [Default selects all data
columns].</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−H</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>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>−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>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−L</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>Apply optimal corrections to columns where such
corrections are available. Append the correction table to
use [Default uses the correction table
<i>TAG</i>_corrections.txt which is expected to reside in
the <b>$X2SYS_HOME</b>/<i>TAG</i> directory]. For the format
of this file, see CORRECTIONS below.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−R</b></p></td>
<td width="7%"></td>
<td width="78%">
<p><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>−Rg</b> and <b>−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>−R</b> settings (and
grid spacing, if applicable) are copied from the grid. For
Cartesian data just give <i>xmin/xmax/ymin/ymax</i>. This
option limits the COEs to those that fall inside the
specified domain.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−S</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>Suppress output records where all the data columns are
NaN [Default will output all records].</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−V</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>Selects verbose mode, which will send progress reports
to stderr [Default runs "silently"].</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−bo</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>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.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>−m</b></p></td>
<td width="7%"></td>
<td width="78%">
<p>Output a multisegment header between data from each
track. Note this option does not imply anything about the
input file; that information is conveyed via the system tag
(<b>−T</b>).</p> </td></tr>
</table>
<h2>EXAMPLES
<a name="EXAMPLES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">To extract all
data from the old-style MGG supplement file c2104.gmt,
recognized by the tag GMT:</p>
<p style="margin-left:11%; margin-top: 1em"><b>x2sys_datalist</b>
c2104.gmt <b>−T</b> GMT > myfile</p>
<p style="margin-left:11%; margin-top: 1em">To make
lon,lat, and depth input for <b><A HREF="blockmean.html">blockmean</A></b> and
<b><A HREF="surface.html">surface</A></b> using all the files listed in the file
tracks.lis and define by the tag TRK, but only the data that
are inside the specified area, and make output binary,
run</p>
<p style="margin-left:11%; margin-top: 1em"><b>x2sys_datalist</b>
=tracks.lis <b>−T</b> TRK <b>−F</b>
lon,lat,depth <b>−R</b>-40/-30/25/35 <b>−bo</b>
> alltopo_bin.xyz</p>
<h2>CORRECTIONS
<a name="CORRECTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The correction
table is an ASCII file with coefficients and parameters
needed to carry out corrections. This table is usually
produced by <b><A HREF="x2sys_solve.html">x2sys_solve</A></b>. Comment records beginning
with # are allowed. All correction records are of the
form</p>
<p style="margin-left:11%; margin-top: 1em"><i>trackID
observation correction</i></p>
<p style="margin-left:11%; margin-top: 1em">where
<i>trackID</i> is the track name, <i>observation</i> is one
of the abbreviations for an observed field contained in
files under this TAG, and <i>correction</i> consists of one
or more white-space-separated <i>term</i>s that will be
<b>subtracted</b> from the observation before output. Each
<i>term</i> must have this exact syntax:</p>
<p style="margin-left:11%; margin-top: 1em"><i>factor</i>[*[<i>function</i>]([<i>scale</i>](<i>abbrev</i>[-<i>origin</i>]))[^<i>power</i>]]</p>
<p style="margin-left:11%; margin-top: 1em">where terms in
brackets are optional (the brackets themselves are not used
but regular parentheses must be used exactly as indicated).
No spaces are allowed except between <i>term</i>s. The
<i>factor</i> is the amplitude of the basis function, while
the optional <i>function</i> can be one of sin, cos, or exp.
The optional <i>scale</i> and <i>origin</i> can be used to
translate the argument (before giving it to the optional
function). The argument <i>abbrev</i> is one of the
abbreviations for columns known to this TAG. However, it can
also be one of the three auxiliary terms <b>dist</b> (for
along-track distances), <b>azim</b> for along-track
azimuths, and <b>vel</b> (for along-track speed); these are
all sensitive to the <b>−C</b> and <b>−N</b>
settings used when defining the TAB; furthermore, <b>vel</b>
requires <b>time</b> to be present in the data. If
<i>origin</i> is given as <b>T</b> it means that we should
replace it with the value of <i>abbrev</i> for the very
first record in the file (this is usually only done for
<i>time</i>). If the first data record entry is NaN we
revert <i>origin</i> to zero. Optionally, raise the entire
expression to the given <i>power</i>, before multiplying by
<i>factor</i>. The following is an example of fictitious
corrections to the track ABC, implying the <b>z</b> column
should have a linear trend removed, the field <b>obs</b>
should be corrected by a strange dependency on latitude,
<b>weight</b> needs to have 1 added (hence correction is
given as -1), and <b>fuel</b> should be reduced by a linear
distance term:</p>
<p style="margin-left:11%; margin-top: 1em">ABC z 7.1
1e-4*((time-T)) <br>
ABC obs 0.5*exp(-1e-3(lat))^1.5 <br>
ABC weight -1 <br>
ABC fuel 0.02*((dist))</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i><A HREF="blockmean.html">blockmean</A></i>(1),
<i><A HREF="GMT.html">GMT</A></i>(1), <i><A HREF="surface.html">surface</A></i>(1), <i><A HREF="x2sys_init.html">x2sys_init</A></i>(1),
<i>x2sys_datalist</i>(1), <i><A HREF="x2sys_get.html">x2sys_get</A></i>(1),
<i><A HREF="x2sys_list.html">x2sys_list</A></i>(1), <i><A HREF="x2sys_put.html">x2sys_put</A></i>(1),
<i><A HREF="x2sys_report.html">x2sys_report</A></i>(1), <i><A HREF="x2sys_solve.html">x2sys_solve</A></i>(1)</p>
<hr>
</body>
</html>
|