gmt-fork/doc/rst/source/gmtinfo.rst

.. index:: ! gmtinfo
.. include:: module_core_purpose.rst_

*******
gmtinfo
*******

|gmtinfo_purpose|

Synopsis
--------

.. include:: common_SYN_OPTs.rst_

**gmt info** [ *table* ] [ |-A|\ **a**\|\ **f**\|\ **s** ]
[ |-C| ]
[ |-D|\ [*dx*\ [/*dy*]] ]
[ |-E|\ **L**\|\ **l**\|\ **H**\|\ **h**\ [*col*] ]
[ |-F|\ [**i**\|\ **d**\|\ **t**] ]
[ |-I|\ [**b**\|\ **e**\|\ **f**\|\ **p**\|\ **s**]\ *dx*\ [/*dy*\ [/*dz*...][**+e**\|\ **r**\|\ **R**] ]
[ |-L| ]
[ |-S|\ [**x**][**y**] ]
[ |-T|\ *dz*\ [**+c**\ *col*] ]
[ |SYN_OPT-V| ]
[ |SYN_OPT-a| ]
[ |SYN_OPT-bi| ]
[ |SYN_OPT-di| ]
[ |SYN_OPT-e| ]
[ |SYN_OPT-f| ]
[ |SYN_OPT-g| ]
[ |SYN_OPT-h| ]
[ |SYN_OPT-i| ]
[ |SYN_OPT-o| ]
[ |SYN_OPT-qi| ]
[ |SYN_OPT-r| ]
[ |SYN_OPT-s| ]
[ |SYN_OPT-:| ]
[ |SYN_OPT--| ]

|No-spaces|

Description
-----------

**info** reads its standard input [or from files] and finds the
extreme values in each of the columns reported as slash-separated min/max
pairs. It recognizes NaNs and will print warnings if the number of columns
vary from record to record. The pairs can be split into two separate columns
by using the **-C** option.  As another option, **info** can find the extent
of data in the first two columns rounded up and down to the nearest multiple of the
supplied increments given by **-I**. Such output will be in the text form
**-R**\ *w/e/s/n*, which can be used directly on the command line for other
modules (hence only *dx* and *dy* are needed).  If **-C** is combined with
**-I** then the output will be in column form and rounded up/down for as many
columns as there are increments provided in **-I**. A similar option (**-T**)
will provide a **-T**\ *zmin/zmax/dz* string for makecpt.

Required Arguments
------------------

None.

Optional Arguments
------------------

.. |Add_intables| unicode:: 0x20 .. just an invisible code
.. include:: explain_intables.rst_

.. _-A:

**-A**\ **a**\|\ **f**\|\ **s**
    Specify how the range should be reported. Choose **-Aa** for the
    range of all files combined, **-Af** to report the range for each
    file separately, and **-As** to report the range for each segment
    (in multisegment files) separately. [Default is **-Aa**].

.. _-C:

**-C**
    Report the min/max values per column in separate columns [Default
    uses <min/max> format]. When used, users may also use **-o** to
    limit which output columns should be reported [all].

.. _-D:

**-D**\ [*dx*\ [/*dy*]]
    Modifies results obtained by **-I** by shifting the region to better
    align with the center of the data.  Optionally, append granularity
    for this shift [Default performs an exact shift].

.. _-E:

**-EL**\|\ **l**\|\ **H**\|\ **h**\ [*col*]
    Returns the record whose column *col* contains the minimum
    (**l**) or maximum (**h**) value. Upper case
    (**L\|H**) works on absolute value of the data. In case of multiple
    matches, only the first record is returned. If *col* is not
    specified we default to the last column in the data.

.. _-F:

**-F**\ [**i**\|\ **d**\|\ **t**]
    Returns the counts of various records depending on the appended mode:
    **i** returns a single record with the total number of tables, segments,
    data records, header records, and overall records.  In contrast, **d** returns
    information for each segment in the virtual data set: *tbl_number, seg_number,
    n_rows, start_rec, stop_rec*. Mode **t** does the same but honors the input
    table organization and thus resets *seg_number, start_rec, stop_rec* at the
    start of each new table.

.. _-I:

**-I**\ [**b**\|\ **e**\|\ **f**\|\ **p**\|\ **s**]\ *dx*\ [/*dy*\ [/*dz*...][**+e**\|\ **r**\|\ **R**]
    Report the min/max of the first *n* columns to the nearest multiple
    of the provided increments (separate the *n* increments by slashes),
    and output results in the form **-R**\ *w/e/s/n* (unless **-C** is
    set). If only one increment is given we also use it for the second
    column (for backwards compatibility). To override this behavior, use
    **-Ip**\ *dx*. If the input *x*- and *y*-coordinates all have the
    same phase shift relative to the *dx* and *dy* increments then we
    use those phase shifts in determining the region, and you may use
    |SYN_OPT-r| to switch from gridline-registration to pixel-registration.
    For irregular data both phase shifts are set to 0 and the |SYN_OPT-r| is ignored.
    Use **-If**\ *dx*\ [/*dy*] to report an extended region optimized
    to give grid dimensions for fastest results in programs using FFTs.
    Use **-Is**\ *dx*\ [/*dy*] to report an extended region optimized to
    give grid dimensions for fastest results in programs like surface.
    Use **-Ib** to write the bounding box of the data table or segments (see **-A**)
    as a closed polygon segment. **Note**: For oblique projections you should
    use the **-Ap** option in :doc:`plot` to draw the box properly.
    If **-Ie** is given then the exact min/max of the input is given in the **-R** string.
    Append **+r** to modify the min/max of the first *n* columns further:
    Append *inc*, *xinc*/*yinc*, or *winc*/*einc*/*sinc*/*ninc* to adjust the
    region to be a multiple of these steps [no adjustment]. Alternatively, use **+R** to extend the region
    outward by adding these increments instead, or **+e** which is like **+r** but
    it ensures that the bounding box extends by at least 0.25 times the increment [no extension].

.. _-L:

**-L**
    Determines common limits across tables (**-Af**) or segments (**-As**).
    If used with **-I** it will round inwards so that the resulting bounds
    lie within the actual data domain.

.. _-S:

**-S**\ [**x**][**y**]
    Add extra space for error bars. Useful together with **-I** option
    and when later plotting with :doc:`plot` **-E**. **-Sx** leaves space
    for horizontal error bars using the values in third
    (2) column. **-Sy** leaves space for vertical error
    bars using the values in fourth (3) column. **-S**
    or **-Sxy** leaves space for both error bars using the values in
    third and fourth (2 and 3) columns.

.. _-T:

**-T**\ *dz*\ [**+c**\ *col*]
    Report the min/max of the first (0'th) column to the nearest multiple of *dz* and output this as the
    string **-T**\ *zmin/zmax/dz*. To use another column, append **+c**\ *col*. Cannot be used together with **-I**.

.. _-V:

.. |Add_-V| unicode:: 0x20 .. just an invisible code
.. include:: explain_-V.rst_

.. include:: explain_-aspatial.rst_

.. |Add_-bi| replace:: [Default is 2 input columns].
.. include:: explain_-bi.rst_

.. |Add_-di| unicode:: 0x20 .. just an invisible code
.. include:: explain_-di.rst_

.. |Add_-e| unicode:: 0x20 .. just an invisible code
.. include:: explain_-e.rst_

.. |Add_-f| unicode:: 0x20 .. just an invisible code
.. include:: explain_-f.rst_

.. |Add_-g| unicode:: 0x20 .. just an invisible code
.. include:: explain_-g.rst_

.. |Add_-h| unicode:: 0x20 .. just an invisible code
.. include:: explain_-h.rst_

.. include:: explain_-icols.rst_

.. include:: explain_-ocols.rst_

.. include:: explain_-qi.rst_

.. |Add_nodereg| unicode:: 0x20 .. just an invisible code
.. include:: explain_nodereg.rst_

.. include:: explain_-s.rst_

.. include:: explain_colon.rst_

.. include:: explain_help.rst_

.. include:: explain_precision.rst_

Examples
--------

.. include:: explain_example.rst_

To find the extreme values in the remote file @ship_15.txt::

    gmt info @ship_15.tx

Output should look like::

    ship_15.txt: N = 82651	<245/254.705>	<20/29.99131>	<-4504/-9>

To find the extreme values in @ship_15.txt to the nearest 5 units
but shifted to within 1 unit of the data center, and use this region to
plot all the points as small black circles using :doc:`plot`, run

  ::

    gmt plot `gmt info -I5 -D1 @ship_15.txt` @ship_15.txt -B -Sc2p -pdf map

To find the min and max values for each of the first 3 columns, but
rounded to integers, and return the result individually for each data
file, use

  ::

    gmt info @ship_15.txt -C -I1/1/1

Given seven profiles with different start and stop positions, we
want to find a range of positions, with increment of 5, that are
common to all the profiles.  We use

  ::

    gmt info profile_[123567].txt -L -I5

The file magprofs.txt contains a number of magnetic profiles stored
as separate data segments.  We need to know how many segments there
are and use

  ::

    gmt info magprofs.txt -Fi

Bugs
----

The **-I** option does not yet work properly with time series data
(e.g., **-f**\ 0T). Thus, such variable intervals as months and years
are not calculated. Instead, specify your interval in the same units as
the current setting of :term:`TIME_UNIT`.

See Also
--------

:doc:`gmt`,
:doc:`gmtconvert`,
:doc:`plot`