1PSCLIP(1) GMT PSCLIP(1)
2
6 psclip - Initialize or terminate polygonal clip paths
7
9 psclip [ table ] -Jparameters -C[n]
10 -Rwest/east/south/north[/zmin/zmax][+r] [ -A[m|p|x|y] ] [
11 -B[p|s]parameters ]
12 -Jz|Zparameters ] [ -K ] [ -N ] [ -O ] [ -P ] [ -T ] [ -U[stamp]
13 ] [ -V[level] ] [ -Xx_offset ] [ -Yy_offset ] [ -bibinary ] [ -dino‐
14 data ] [ -eregexp ] [ -fflags ] [ -ggaps ] [ -hheaders ] [ -iflags ] [
15 -pflags ] [ -ttransp ] [ -:[i|o] ]
16 Note: No space is allowed between the option flag and the associated
18 arguments.
19
21 psclip reads (x,y) file(s) [or standard input] and draws polygons that
22 are activated as clipping paths. Several files may be read to create
23 complex paths consisting of several non-connecting segments. Only marks
24 that are subsequently drawn inside the clipping path will be shown. To
25 determine what is inside or outside the clipping path, psclip uses the
26 even-odd rule. When a ray drawn from any point, regardless of direc‐
27 tion, crosses the clipping path segments an odd number of times, the
28 point is inside the clipping path. If the number is even, the point is
29 outside. The -N option, reverses the sense of what is the inside and
30 outside of the paths by plotting a clipping path along the map bound‐
31 ary. After subsequent plotting, which will be clipped against these
32 paths, the clipping may be deactivated by running psclip a second time
33 with the -C option only.
34
36 -C[|n] Mark end of existing clip path(s). No input file will be pro‐
37 cessed. No projection information is needed unless -B has been
38 selected as well. With no arguments we terminate all active
39 clipping paths. Experts may restrict the termination to just n
40 of the active clipping path by passing that as the argument.
41 Remember to supply -X and -Y settings if you have moved since
42 the clip started.
43 -Jparameters (more ...)
45 Select map projection.
46 -Rxmin/xmax/ymin/ymax[+r][+uunit] (more ...)
48 Specify the region of interest.
49 For perspective view p, optionally append /zmin/zmax. (more ...)
51
53 table One or more ASCII (or binary, see -bi[ncols][type]) data table
54 file(s) holding a number of data columns. If no tables are given
55 then we read from standard input.
56 -A[m|p|x|y]
58 By default, geographic line segments are connected as great cir‐
59 cle arcs. To connect them as straight lines, use the -A flag.
60 Alternatively, add m to connect the line by first following a
61 meridian, then a parallel. Or append p to start following a par‐
62 allel, then a meridian. (This can be practical to connect lines
63 along parallels, for example). For Cartesian data, points are
64 simply connected, unless you append x or y to construct
65 stair-case paths whose first move is along x or y, respectively.
66 -B[p|s]parameters (more ...)
68 Set map boundary frame and axes attributes.
69 -Jz|Zparameters (more ...)
71 Set z-axis scaling; same syntax as -Jx.
72 -K (more ...)
74 Do not finalize the PostScript plot.
75 -N Invert the sense of what is inside and outside. For example,
77 when using a single path, this means that only points outside
78 that path will be shown. Cannot be used together with -B.
79 -O (more ...)
81 Append to existing PostScript plot.
82 -P (more ...)
84 Select "Portrait" plot orientation.
85 -T Rather than read any input files, simply turn on clipping for
87 the current map region. Basically, -T is a convenient way to run
88 psclip with the arguments -N /dev/null (or, under Windows, -N
89 NUL). Cannot be used together with -B.
90 -U[[just]/dx/dy/][c|label] (more ...)
92 Draw GMT time stamp logo on plot.
93 -V[level] (more ...)
95 Select verbosity level [c].
96 -X[a|c|f|r][x-shift[u]]
98 -Y[a|c|f|r][y-shift[u]] (more ...)
100 Shift plot origin.
101 -bi[ncols][t] (more ...)
103 Select native binary input. [Default is 2 input columns].
104 -dinodata (more ...)
106 Replace input columns that equal nodata with NaN.
107 -e[~]"pattern" | -e[~]/regexp/[i] (more ...)
109 Only accept data records that match the given pattern.
110 -f[i|o]colinfo (more ...)
112 Specify data types of input and/or output columns.
113 -g[a]x|y|d|X|Y|D|[col]z[+|-]gap[u] (more ...)
115 Determine data gaps and line breaks.
116 -h[i|o][n][+c][+d][+rremark][+rtitle] (more ...)
118 Skip or produce header record(s).
119 -icols[+l][+sscale][+ooffset][,...] (more ...)
121 Select input columns and transformations (0 is first column).
122 -p[x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0] (more ...)
124 Select perspective view.
125 -t[transp] (more ...)
127 Set PDF transparency level in percent.
128 -:[i|o] (more ...)
130 Swap 1st and 2nd column on input and/or output.
131 -^ or just -
133 Print a short message about the syntax of the command, then
134 exits (NOTE: on Windows just use -).
135 -+ or just +
137 Print an extensive usage (help) message, including the explana‐
138 tion of any module-specific option (but not the GMT common
139 options), then exits.
140 -? or no arguments
142 Print a complete usage (help) message, including the explanation
143 of all options, then exits.
144
146 To make an clipping PostScript file that will set up a complex clip
147 area to which subsequent plotting will be confined, run:
148 gmt psclip my_region.xy -R0/40/0/40 -Jm0.3i -K > clip_mask_on.ps
150 To deactivate the clipping in an existing plotfile, run:
152 gmt psclip -C -O >> complex_plot.ps
154
156 gmt, grdmask, psbasemap, psmask
157
159 2019, P. Wessel, W. H. F. Smith, R. Scharroo, J. Luis, and F. Wobbe
1605.4.5 Feb 24, 2019 PSCLIP(1)