grdedit

Modify header or content of a grid

Synopsis

gmt grdedit ingrid [ -A ] [ -C ] [ -D[+xxname][+yyname][+zzname][+sscale][+ooffset][+ninvalid][+ttitle][+rremark] ] [ -E[a|e|h|l|r|t|v] ] [ -Goutgrid ] [ -Jparameters ] [ -L[+n|p] ] [ -Ntable ] [ -Rregion ] [ -S ] [ -T ] [ -V[level] ] [ -bibinary ] [ -di[+ccol]nodata ] [ -eregexp ] [ -fflags ] [ -hheaders ] [ -iflags ] [ -wflags ] [ -:[i|o] ] [ --PAR=value ]

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

Description

grdedit reads the header information in a binary 2-D grid file and replaces the information with values provided on the command line [if any]. As an option, global, geographical grids (with 360 degrees longitude range) can be rotated in the east-west direction, and individual nodal values can be replaced from a table of x, y, z values. grdedit only operates on files containing a grid header. Note: If it is important to retain the original data you should use -G to save the modified grid to a new file.

Required Arguments

ingrid[=ID|?varname][+bband][+ddivisor][+ninvalid] [+ooffset][+sscale]

Name of the 2-D grid file to modify. Optionally, append =ID for reading a specific file format [Default is =nf] or ?varname for a specific netCDF variable [Default is the first 2-D grid found by GMT] (See full description). The following modifiers are supported:

• +b - Select a band (for images only) [Default is 0].

• +d - Divide data values by the given divisor [Default is 1].

• +n - Replace data values matching invalid with NaN.

• +o - Offset data values by the given offset [Default is 0].

• +s - Scale data values by the given scale [Default is 1].

Note: Any offset is added after any scaling.

Optional Arguments

-A

If necessary, adjust the file’s x_inc, y_inc to be compatible with its domain (or a new domain set with -R). Older grid files (i.e., created prior to GMT 3.1) often had excessive slop in x_inc, y_inc and an adjustment is necessary. Newer files are created correctly.

-C

Clear the command history from the grid header.

-D[+xxname][+yyname][+zzname][+dvname][+sscale][+ooffset][+ninvalid][+ttitle][+rremark][+vvarname]

Give one or more combinations for values xname, yname, zname (3rd dimension in cube), and dname (data value name) and give the names of those variables and in square bracket their units, e.g., “distance [km]”), scale (to multiply data values after read [normally 1]), offset (to add to data after scaling [normally 0]), invalid (a value to represent missing data [NaN]), title (anything you like), and remark (anything you like). Items not listed will remain untouched. Give a blank name to completely reset a particular string. Use quotes to group texts with more than one word. If any of your text contains plus symbols you need to escape them (place a backslash before each plus-sign) so they are not confused with the option modifiers. Alternatively, you can place the entire double-quoted string inside single quotes. If you have shell variables that contain plus symbols you cannot use single quotes but you can escape the plus symbols in a variable using constructs like ${variable/+/\+}. Note that for geographic grids and cubes (-fg) xname and yname are set automatically. Normally, the data netCDF variable is called “z” (grid) or “cube” (data cube). You can name this netCDF variable via +vvarname.

-E[a|e|h|l|r|t|v]

Transform the grid in one of six ways and (for l|r|t) interchange the x and y information: -Ea will flip the grid both horizontally and vertically, -Ee will exchange the x (longitude) and y (latitude) dimensions, -Eh will flip the grid horizontally (left-to-right), -El will rotate the grid 90 degrees counter-clockwise (left), -Er will rotate the grid 90 degrees clockwise (right), -Et will transpose the grid [Default], -Ev will flip the grid vertically (top-to-bottom). Incompatible with the other options (except -G).

-Goutgrid[=ID][+ddivisor][+ninvalid] [+ooffset|a][+sscale|a] [:driver[dataType][+coptions]]

Normally, grdedit will overwrite the existing grid with the modified grid. Use -G to write the modified grid to the file outgrid instead. Optionally, append =ID for writing a specific file format (See full description). The following modifiers are supported:

• +d - Divide data values by given divisor [Default is 1].

• +n - Replace data values matching invalid with a NaN.

• +o - Offset data values by the given offset, or append a for automatic range offset to preserve precision for integer grids [Default is 0].

• +s - Scale data values by the given scale, or append a for automatic scaling to preserve precision for integer grids [Default is 1].

Note: Any offset is added before any scaling. +sa also sets +oa (unless overridden). To write specific formats via GDAL, use = gd and supply driver (and optionally dataType) and/or one or more concatenated GDAL -co options using +c. See the “Writing grids and images” cookbook section for more details.

-Jparameters

Specify the projection. Use the -J syntax to save the georeferencing info as CF-1 compliant metadata in netCDF grids. This metadata will be recognized by GDAL.

-L[+n|p]

Adjust the longitude values in the grid (only applies to geographic grids). By default we will try to adjust west and east so that west >= -180 or east <= +180, but this depends on the range of the longitudes. Append +n to force negative longitude values and +p to force positive longitude values.

-Ntable

Read the ASCII (or binary; see -bi) file table and replace the corresponding nodal values in the grid with these x,y,z values.

-Rxmin/xmax/ymin/ymax[+r][+uunit]

Specify the region of interest. The new w/e/s/n values will replace those in the grid, and the x_inc, y_inc values are adjusted, if necessary. (See full description) (See cookbook information).

-S

For global, geographical grids only. Grid values will be shifted longitudinally according to the new borders given in -R.

-T

Make necessary changes in the header to convert a gridline-registered grid to a pixel-registered grid, or vice-versa. Basically, gridline-registered grids will have their domain extended by half the x- and y-increments whereas pixel-registered grids will have their domain shrunk by the same amount. This is a non-destructive grid change; see Switching registrations.

-V[level]

Select verbosity level [w]. (See full description) (See cookbook information).

-birecord[+b|l] (more …)

Select native binary format for primary table input. [Default is 3 input columns].

-dinodata[+ccol] (more …)

Replace input columns that equal nodata with NaN.

-e[~]“pattern” | -e[~]/regexp/[i] (more …)

Only accept data records that match the given pattern.

-f[i|o]colinfo (more …)

Specify data types of input and/or output columns.

-h[i|o][n][+c][+d][+msegheader][+rremark][+ttitle] (more …)

Skip or produce header record(s).

-icols[+l][+ddivisor][+sscale|d|k][+ooffset][,…][,t[word]] (more …)

Select input columns and transformations (0 is first column, t is trailing text, append word to read one word only).

-wy|a|w|d|h|m|s|cperiod[/phase][+ccol] (more …)

Convert an input coordinate to a cyclical coordinate.

-^ or just -

Print a short message about the syntax of the command, then exit (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 exit.

-? or no arguments

Print a complete usage (help) message, including the explanation of all options, then exit.

--PAR=value

Temporarily override a GMT default setting; repeatable. See gmt.conf for parameters.

Geographical And Time Coordinates

When the output grid type is netCDF, the coordinates will be labeled “longitude”, “latitude”, or “time” based on the attributes of the input data or grid (if any) or on the -f or -R options. For example, both -f0x -f1t and -R90w/90e/0t/3t will result in a longitude/time grid. When the x, y, or z coordinate is time, it will be stored in the grid as relative time since epoch as specified by TIME_UNIT and TIME_EPOCH in the gmt.conf file or on the command line. In addition, the unit attribute of the time variable will indicate both this unit and epoch.

Examples

Note: Below are some examples of valid syntax for this module. The examples that use remote files (file names starting with @) can be cut and pasted into your terminal for testing. Other commands requiring input files are just dummy examples of the types of uses that are common but cannot be run verbatim as written.

Let us assume the file data.nc covers the area 300/310/10/30. We want to change the boundaries from geodetic longitudes to geographic and put a new title in the header. We accomplish this by:

gmt grdedit data.nc -R-60/-50/10/30 -D+t"Gravity Anomalies"

The grid world.nc has the limits 0/360/-72/72. To shift the data so that the limits would be -180/180/-72/72, use:

gmt grdedit world.nc -R-180/180/-72/72 -S

The file junk.nc was created prior to GMT 3.1 with incompatible -R and -I arguments. To reset the x- and y-increments we run:

gmt grdedit junk.nc -A

The file junk.nc was created prior to GMT 4.1.3 and does not contain the required information to indicate that the grid is geographic. To add this information, run:

gmt grdedit junk.nc -fg

To rotate the grid oblique.nc 90 degrees counter-clockwise and write out the rotated grid to a new file, run:

gmt grdedit oblique.nc -El -Goblique_rot.nc

To ensure that the grid depths.nc only has positive longitude values, run:

gmt grdedit depths.nc -L+p

The grid bad.nc has latitude as x-coordinates an longitude as y-coordinates. We can exchange the two dimension by running:

gmt grdedit bad.nc -Ee -Gnew.nc

Notes:

This module is not a general editor for netCDF files. If your netCDF file contains more than one 2-D (or higher dimension) data layer, then only the selected layer will be written out if changes are requested. Likewise, if you have additional netCDF attributes then those will also be lost in any revised output.

See Also

gmt, grd2xyz, grdfill, grdinfo, xyz2grd