1X2SYS_BINLIST(1)                      GMT                     X2SYS_BINLIST(1)
2
3
4

NAME

6       x2sys_binlist - Create bin index listing from track data files
7

SYNOPSIS

9       x2sys_binlist track(s)  -TTAG [  -D ] [  -E ] [  -V[level] ]
10
11       Note:  No  space  is allowed between the option flag and the associated
12       arguments.
13

DESCRIPTION

15       x2sys_binlist reads one or more track data files and produces a  multi‐
16       segment  ASCII  track  bin-index  file (tbf) with the track name in the
17       header and one data record per bin crossed; these records contain  lon,
18       lat,  index,  flags[,  dist], where lon, lat are the coordinates of the
19       center of the bin, the index is the 1-D number of the bin, and flags is
20       a  bitflag that describes which data fields were available in this bin.
21       The optional dist requires  -D. The input files can be of  any  format,
22       which must be described and passed with the
23        -T  option.  The  bin-index listing is a crude representation of where
24       the track goes and is used by the data  archivist  to  build  an  x2sys
25       track  data  base for miscellaneous track queries, such as when needing
26       to determine which tracks should be compared in a  crossover  analysis.
27       You  must  run  x2sys_init to initialize the tag before you can run the
28       indexing.
29

REQUIRED ARGUMENTS

31       tracks Can be one or more ASCII, native binary, or  COARDS  netCDF  1-D
32              data files. To supply the data files via a text file with a list
33              of tracks (one per record), specify the name of the  track  list
34              after a leading equal-sign (e.g., =tracks.lis). If the names are
35              missing their file extension we will append the suffix specified
36              for this TAG. Track files will be searched for first in the cur‐
37              rent  directory  and  second  in  all  directories   listed   in
38              $X2SYS_HOME/TAG/TAG_paths.txt (if it exists). [If $X2SYS_HOME is
39              not set it will default to  $GMT_SHAREDIR/x2sys].  (Note:  MGD77
40              files will also be looked for via MGD77_HOME/mgd77_paths.txt and
41              *.gmt files will  be  searched  for  via  $GMT_SHAREDIR/mgg/gmt‐
42              file_paths).
43
44       -TTAG  Specify  the  x2sys TAG which tracks the attributes of this data
45              type.
46

OPTIONAL ARGUMENTS

48       -D     Calculate the length of track-line  segments  per  bin  [Default
49              skips this step]. The length fragments are given as the 5th out‐
50              put column (after the flags). The length units are obtained  via
51              the TAB setting (see x2sys_init).
52
53       -E     Convert  geographic  data to a cylindrical equal-area projection
54              prior  to  binning.   Basically,   we   apply   the   projection
55              -JYlon0/37:04:17.166076/360,  where lon0 is the mid-longitude of
56              the region. Requires -D, geographical data, and a global  region
57              (e.g., -Rg or -Rd). This option is useful for statistics related
58              to track-line density but should  not  be  used  when  preparing
59              bin-index files for the x2sys track data bases.
60
61       -V[level] (more ...)
62              Select verbosity level [c].
63
64       -^ or just -
65              Print  a  short  message  about  the syntax of the command, then
66              exits (NOTE: on Windows just use -).
67
68       -+ or just +
69              Print an extensive usage (help) message, including the  explana‐
70              tion  of  any  module-specific  option  (but  not the GMT common
71              options), then exits.
72
73       -? or no arguments
74              Print a complete usage (help) message, including the explanation
75              of all options, then exits.
76

EXAMPLES

78       To create a bin index file from the MGD77 file 01030061.mgd77 using the
79       settings associated with the tag MGD77, do
80
81              gmt x2sys_binlist 01030061.mgd77 -TMGD77 > 01030061.tbf
82
83       To create a track bin index file of all MGD77+ files  residing  in  the
84       current directory using the settings associated with the tag MGD77+ and
85       calculate track distances, run
86
87              gmt x2sys_binlist *.nc -TMGD77+ -D > all.tbf
88

SEE ALSO

90       x2sys_cross,   x2sys_datalist,   x2sys_get,   x2sys_init,    x2sys_put,
91       x2sys_report, x2sys_solve
92
94       2019, P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis, and F. Wobbe
95
96
97
98
995.4.5                            Feb 24, 2019                 X2SYS_BINLIST(1)
Impressum