bionic (1) x2sys_binlist.1gmt.gz

Provided by: gmt-common_5.4.3+dfsg-1_all bug

NAME
       x2sys_binlist - Create bin index listing from track data files


SYNOPSIS
       x2sys_binlist track(s)  -TTAG [  -D ] [  -E ] [  -V[level] ]

       Note: No space is allowed between the option flag and the associated arguments.


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


REQUIRED ARGUMENTS
       tracks 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 TAG. Track files will be searched for first  in  the  current
              directory  and  second  in all directories listed in $X2SYS_HOME/TAG/TAG_paths.txt (if it exists).
              [If $X2SYS_HOME is not set it will default to $GMT_SHAREDIR/x2sys]. (Note: MGD77 files  will  also
              be   looked  for  via  MGD77_HOME/mgd77_paths.txt  and  *.gmt  files  will  be  searched  for  via
              $GMT_SHAREDIR/mgg/gmtfile_paths).

       -TTAG  Specify the x2sys TAG which tracks the attributes of this data type.


OPTIONAL ARGUMENTS
       -D     Calculate the length of track-line  segments  per  bin  [Default  skips  this  step].  The  length
              fragments  are given as the 5th output column (after the flags). The length units are obtained via
              the TAB setting (see x2sys_init).

       -E     Convert geographic data to a cylindrical equal-area projection prior  to  binning.  Basically,  we
              apply  the  projection -JYlon0/37:04:17.166076/360, where lon0 is the mid-longitude of the region.
              Requires -D, geographical data, and a global region (e.g., -Rg or -Rd). This option is useful  for
              statistics related to track-line density but should not be used when preparing bin-index files for
              the x2sys track data bases.

       -V[level] (more …)
              Select verbosity level [c].

       -^ or just -
              Print a short message about the syntax of the command, then exits (NOTE: on Windows just use -).

       -+ or just +
              Print an extensive usage (help) message, including the explanation of any  module-specific  option
              (but not the GMT common options), then exits.

       -? or no arguments
              Print a complete usage (help) message, including the explanation of all options, then exits.


EXAMPLES
       To  create a bin index file from the MGD77 file 01030061.mgd77 using the settings associated with the tag
       MGD77, do

              gmt x2sys_binlist 01030061.mgd77 -TMGD77 > 01030061.tbf

       To create a track bin index file of all MGD77+ files residing in the current directory using the settings
       associated with the tag MGD77+ and calculate track distances, run

              gmt x2sys_binlist *.nc -TMGD77+ -D > all.tbf


SEE ALSO
       x2sys_cross, x2sys_datalist, x2sys_get, x2sys_init, x2sys_put, x2sys_report, x2sys_solve


       2018, P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis, and F. Wobbe