.. index:: ! grdproject
.. include:: module_core_purpose.rst_

**********
grdproject
**********

|grdproject_purpose|

Synopsis
--------

.. include:: common_SYN_OPTs.rst_

**gmt grdproject** *ingrid* |-G|\ *outgrid* |-J|\ *parameters*
[ |-C|\ [*dx/dy*] ]
[ |-D|\ *xinc*\ [**+e**\|\ **n**][/\ *yinc*\ [**+e**\|\ **n**]] ]
[ |-E|\ *dpi* ] [ |-F|\ [**c**\|\ **i**\|\ **p**\|\ **e**\|\ **f**\|\ **k**\|\ **M**\|\ **n**\|\ **u**] ] [ |-I| ] [ |-M|\ **c**\|\ **i**\|\ **p** ]
[ |SYN_OPT-R| ]
[ |SYN_OPT-V| ]
[ |SYN_OPT-j| ]
[ |SYN_OPT-n| ]
[ |SYN_OPT-r| ]
[ |SYN_OPT--| ]

|No-spaces|

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

**grdproject** will do one of two things depending whether |-I| has
been set. If set, it will transform a gridded data set from a
rectangular coordinate system onto a geographical system by resampling
the surface at the new nodes. If not set, it will project a geographical
gridded data set onto a rectangular grid. To obtain the value at each
new node, its location is inversely projected back onto the input grid
after which a value is interpolated between the surrounding input grid
values. By default bi-cubic interpolation is used. Aliasing is avoided
by also forward projecting the input grid nodes. If two or more nodes
are projected onto the same new node, their average will dominate in the
calculation of the new node value. Interpolation and aliasing is
controlled with the **-n** option. The new node spacing may be
determined in one of several ways by specifying the grid spacing, number
of nodes, or resolution. Nodes not constrained by input data are set to
NaN.

The |-R| option can be used to select a map region larger or smaller
than that implied by the extent of the grid file.

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

.. |Add_ingrid| replace:: 2-D gridded data set to be transformed.
.. include:: explain_grd_inout.rst_
    :start-after: ingrid-syntax-begins
    :end-before: ingrid-syntax-ends

.. _-G:

.. |Add_outgrid| replace:: Give the name of the output grid file.
.. include:: /explain_grd_inout.rst_
    :start-after: outgrid-syntax-begins
    :end-before: outgrid-syntax-ends

.. |Add_-J| replace:: |Add_-J_links|
.. include:: explain_-J.rst_
    :start-after: **Syntax**
    :end-before: **Description**

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

.. _-C:

**-C**\ [*dx/dy*]
    Let projected coordinates be relative to projection center [Default
    is relative to lower left corner]. Optionally, add offsets in the
    projected units to be added (or subtracted when |-I| is set) to
    (from) the projected coordinates, such as false eastings and
    northings for particular projection zones [0/0].

.. _-D:

**-D**\ *xinc*\ [**+e**\|\ **n**][/\ *yinc*\ [**+e**\|\ **n**]]
    Set the grid spacing for the new grid.  If neither |-D| nor |-E| are set then we
    select the same number of output nodes as there are input nodes.
    Optionally append a suffix modifier.
    **Geographical (degrees) coordinates**: Append
    **m** to indicate arc minutes or **s** to indicate arc seconds. If one
    of the units **e**, **f**, **k**, **M**, **n** or **u** is appended
    instead, the increment is assumed to be given in meter, foot, km, Mile,
    nautical mile or US survey foot, respectively, and will be converted to
    the equivalent degrees longitude at the middle latitude of the region
    (the conversion depends on :term:`PROJ_ELLIPSOID`). If *y_inc* is given
    but set to 0 it will be reset equal to *x_inc*; otherwise it will be
    converted to degrees latitude. **All coordinates**: If **+e** is appended
    then the corresponding max *x* (*east*) or *y* (*north*) 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 *number of nodes* desired by
    appending **+n** 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 :ref:`GMT File Formats` for
    details. **Note**: If **-R**\ *grdfile* is used then the grid spacing (and registration) have
    already been initialized; use |-D| (and **-r**) to override the values.

.. _-E:

**-E**\ *dpi*
    Set the resolution for the new grid in dots per inch.

.. _-F:

**-F**\ [**c**\|\ **i**\|\ **p**\|\ **e**\|\ **f**\|\ **k**\|\ **M**\|\ **n**\|\ **u**]
    Force 1:1 scaling, i.e., output (or input, see |-I|) data are in
    actual projected meters [**e**]. To specify other units, append
    **f** (foot), **k** (km), **M** (statute mile), **n** (nautical
    mile), **u** (US survey foot), **i** (inch), **c** (cm), or **p**
    (point). Without |-F|, the output (or input, see |-I|) are in
    the units specified by :term:`PROJ_LENGTH_UNIT` (but see |-M|).

.. _-I:

**-I**
    Do the Inverse transformation, from rectangular to geographical.

.. _-M:

**-Mc**\|\ **i**\|\ **p**
    Append **c**, **i**, or **p** to indicate that cm, inch, or point
    should be the projected measure unit [Default is set by
    :term:`PROJ_LENGTH_UNIT` in :doc:`gmt.conf`]. Cannot be used with |-F|.

.. |Add_-R| replace:: You may ask to project only a subset of the grid by specifying a smaller input *w/e/s/n* region
    [Default is the region given by the grid file]. |Add_-R_links|
.. include:: explain_-R.rst_
    :start-after: **Syntax**
    :end-before: **Description**

.. |Add_-V| replace:: |Add_-V_links|
.. include:: explain_-V.rst_
    :start-after: **Syntax**
    :end-before: **Description**

.. include:: explain_distcalc.rst_

.. include:: explain_-n.rst_

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

.. include:: explain_help.rst_

Examples
--------

.. include:: explain_example.rst_

To transform a chunk of the geographical remote grid earth_relief_05m onto a pixel Mercator grid at 300 dpi
given a scale of 0.25 inches per degree, run

::

  gmt grdproject @earth_relief_05m -R20/50/12/25 -Jm0.25i -E300 -r -Getopo5_merc.nc -Mi

To inversely transform the file topo_tm.nc back onto a geographical grid, use

::

  gmt grdproject topo_tm.nc -R-80/-70/20/40 -Jt-75/1:500000 -I -D5m -V -Gtopo.nc

This assumes, of course, that the coordinates in topo_tm.nc were
created with the same projection parameters.

To inversely transform the file topo_utm.nc (which is in UTM meters)
back to a geographical grid we specify a one-to-one mapping with meter
as the measure unit:

::

  gmt grdproject topo_utm.nc -R203/205/60/65 -Ju5/1:1 -I -Gtopo.nc -V

To inversely transform the file data.nc (which is in Mercator meters with Greenwich
as the central longitude and a false easting of -4 and produced on the ellipse WGS-72)
back to a geographical grid we specify a one-to-one mapping with meter
as the measure unit:

::

  gmt grdproject data.nc -Jm/1:1 -I -F -C-4/0 -Gdata_geo.nc -V --PROJ_ELLIPSOID=WGS-72

Output Region Issues
--------------------

The boundaries of a projected (rectangular) data set will not
necessarily give rectangular geographical boundaries (Mercator is one
exception). In those cases some nodes may be unconstrained (set to NaN).
To get a full grid back, your input grid may have to cover a larger area
than you are interested in.

.. include:: explain_ellipsoidal.rst_

See Also
--------

:doc:`gmt`, :doc:`gmt.conf`, :doc:`mapproject`
