psclip(1) GMT psclip(1)
NAME
psclip - Initialize or terminate polygonal clip paths
SYNOPSIS
psclip [ table ] -Jparameters -C[n]
-Rwest/east/south/north[/zmin/zmax][+r] [ -A[m|p|x|y] ] [
-B[p|s]parameters ]
-Jz|Zparameters ] [ -K ] [ -N ] [ -O ] [ -P ] [ -T ] [ -U[stamp]
] [ -V[level] ] [ -Xx_offset ] [ -Yy_offset ] [ -bibinary ] [ -dino-
data ] [ -eregexp ] [ -fflags ] [ -ggaps ] [ -hheaders ] [ -iflags ] [
-pflags ] [ -ttransp ] [ -:[i|o] ]
Note: No space is allowed between the option flag and the associated
arguments.
DESCRIPTION
psclip reads (x,y) file(s) [or standard input] and draws polygons that
are activated as clipping paths. Several files may be read to create
complex paths consisting of several non-connecting segments. Only marks
that are subsequently drawn inside the clipping path will be shown. To
determine what is inside or outside the clipping path, psclip uses the
even-odd rule. When a ray drawn from any point, regardless of direc-
tion, crosses the clipping path segments an odd number of times, the
point is inside the clipping path. If the number is even, the point is
outside. The -N option, reverses the sense of what is the inside and
outside of the paths by plotting a clipping path along the map bound-
ary. After subsequent plotting, which will be clipped against these
paths, the clipping may be deactivated by running psclip a second time
with the -C option only.
REQUIRED ARGUMENTS
-C[|n] Mark end of existing clip path(s). No input file will be pro-
cessed. No projection information is needed unless -B has been
selected as well. With no arguments we terminate all active
clipping paths. Experts may restrict the termination to just n
of the active clipping path by passing that as the argument.
Remember to supply -X and -Y settings if you have moved since
the clip started.
-Jparameters (more a|)
Select map projection.
-Rxmin/xmax/ymin/ymax[+r][+uunit] (more a|)
Specify the region of interest.
For perspective view p, optionally append /zmin/zmax. (more a|)
OPTIONAL ARGUMENTS
table One or more ASCII (or binary, see -bi[ncols][type]) data table
file(s) holding a number of data columns. If no tables are given
then we read from standard input.
-A[m|p|x|y]
By default, geographic line segments are connected as great cir-
cle arcs. To connect them as straight lines, use the -A flag.
Alternatively, add m to connect the line by first following a
meridian, then a parallel. Or append p to start following a par-
allel, then a meridian. (This can be practical to connect lines
along parallels, for example). For Cartesian data, points are
simply connected, unless you append x or y to construct
stair-case paths whose first move is along x or y, respectively.
-B[p|s]parameters (more a|)
Set map boundary frame and axes attributes.
-Jz|Zparameters (more a|)
Set z-axis scaling; same syntax as -Jx.
-K (more a|)
Do not finalize the PostScript plot.
-N Invert the sense of what is inside and outside. For example,
when using a single path, this means that only points outside
that path will be shown. Cannot be used together with -B.
-O (more a|)
Append to existing PostScript plot.
-P (more a|)
Select aPortraita plot orientation.
-T Rather than read any input files, simply turn on clipping for
the current map region. Basically, -T is a convenient way to run
psclip with the arguments -N /dev/null (or, under Windows, -N
NUL). Cannot be used together with -B.
-U[[just]/dx/dy/][c|label] (more a|)
Draw GMT time stamp logo on plot.
-V[level] (more a|)
Select verbosity level [c].
-X[a|c|f|r][x-shift[u]]
-Y[a|c|f|r][y-shift[u]] (more a|)
Shift plot origin.
-bi[ncols][t] (more a|)
Select native binary input. [Default is 2 input columns].
-dinodata (more a|)
Replace input columns that equal nodata with NaN.
-e[~]^<i>apattern^<i>a | -e[~]/regexp/[i] (more a|)
Only accept data records that match the given pattern.
-f[i|o]colinfo (more a|)
Specify data types of input and/or output columns.
-g[a]x|y|d|X|Y|D|[col]z[+|-]gap[u] (more a|)
Determine data gaps and line breaks.
-h[i|o][n][+c][+d][+rremark][+rtitle] (more a|)
Skip or produce header record(s).
-icols[+l][+sscale][+ooffset][,^<i>a|] (more a|)
Select input columns and transformations (0 is first column).
-p[x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0] (more a|)
Select perspective view.
-t[transp] (more a|)
Set PDF transparency level in percent.
-:[i|o] (more a|)
Swap 1st and 2nd column on input and/or output.
-^ 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 explana-
tion 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 make an clipping PostScript file that will set up a complex clip
area to which subsequent plotting will be confined, run:
gmt psclip my_region.xy -R0/40/0/40 -Jm0.3i -K > clip_mask_on.ps
To deactivate the clipping in an existing plotfile, run:
gmt psclip -C -O >> complex_plot.ps
SEE ALSO
gmt(1), grdmask(1), psbasemap(1), psmask(1)
COPYRIGHT
2017, P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis, and F. Wobbe
5.4.2 Jun 24, 2017 psclip(1)
gmt5 5.4.2 - Generated Thu Jun 29 15:03:11 CDT 2017