File: psmask.html

package info (click to toggle)
gmt-doc 3.4-1.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,756 kB
  • ctags: 1,800
  • sloc: makefile: 30
file content (236 lines) | stat: -rw-r--r-- 10,551 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<HTML>
<HEAD>
<TITLE>psmask</TITLE>
</HEAD>
<BODY>
<H1>psmask</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
       psmask - To clip or mask areas of no data on a map


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>psmask</B>    [<I>xyzfile</I>]    <B>-I</B><I>dx</I>[<B>m|c</B>][<I>/dy</I>[<B>m|c</B>]]    <B>-J</B><I>parameters</I>
       <B>-R</B><I>west/east/south/north</I>[<B>r</B>] [ <B>-B</B><I>tickinfo</I> ] [ <B>-D</B><I>dumpfile</I> ] [
       <B>-E</B><I>azimuth/elevation</I>  ] [ <B>-F</B> ] [ <B>-G</B><I>fill</I> ] [ <B>-H</B>[<I>nrec</I>] ] [ <B>-K</B>
       ] [ <B>-M</B>[<I>flag</I>] ] [ <B>-N</B> ] [ <B>-O</B> ] [ <B>-P</B> ] [ <B>-S</B><I>radius</I>[<B>k</B>] ] [ <B>-T</B> ]
       [  <B>-U</B>[<I>/dx/dy/</I>][<I>label</I>] ] [ <B>-V</B> ] [ <B>-X</B><I>x-shift</I> ] [ <B>-Y</B><I>y-shift</I> ]
       [ <B>-c</B><I>copies</I> ] [ <B>-:</B> ] [ <B>-bi</B>[<B>s</B>][<I>n</I>] ]

       <B>psmask</B> <B>-C</B> [ <B>-K</B> ] [ <B>-O</B> ]


</PRE>
<H2>DESCRIPTION</H2><PRE>
       <B>psmask</B> reads a (x,y,z) file [or standard input]  and  uses
       this  information  to  find out which grid cells are reli
       able. Only gridcells which have one or  more  data  points
       are  considered  reliable. As an option, you may specify a
       radius of influence. Then, all gridcells that  are  within
       <I>radius</I>  of  a data point are considered reliable. Further
       more, an option is provided to reverse the  sense  of  the
       test.  Having  found  the  reliable/not  reliable  points,
       <B>psmask</B> will either paint tiles to mask these  nodes  (with
       the  <B>-T</B>) switch, or use contouring to create polygons that
       will clip out regions of no  interest.  When  clipping  is
       initiated,  it  will  stay in effect until turned off by a
       second call to <B>psmask</B> using the <B>-C</B> option.

       <I>xyzfile</I>
              File with (x,y,z) values (e.g., that  was  used  to
              run  <B><A HREF="surface.html">surface</A></B>).  If no file is given, standard input
              is read. For binary files, see <B>-b</B>.

       <B>-I</B>     <I>x</I><B>_</B><I>inc</I> [and optionally <I>y</I><B>_</B><I>inc</I>] is the  grid  spacing.
              Append  <B>m</B> to indicate minutes or <B>c</B> to indicate sec
              onds.

       <B>-J</B>     Selects the map projection. Scale  is  UNIT/degree,
              1:xxxxx,  or  width  in UNIT (upper case modifier).
              UNIT is cm, inch,  or  m,  depending  on  the  MEA
              SURE_UNIT  setting in .<A HREF="gmtdefaults.html">gmtdefaults</A>, but this can be
              overridden on the command line by appending the  c,
              i, or m to the scale/width value.

              <B>CYLINDRICAL</B> <B>PROJECTIONS:</B>

              <B>-Jc</B><I>lon0/lat0/scale</I> (Cassini)
              <B>-Jj</B><I>lon0/scale</I> (Miller)
              <B>-Jm</B><I>scale</I>  (Mercator - Greenwich and Equator as ori
              gin)
              <B>-Jm</B><I>lon0/lat0/scale</I> (Mercator -  Give  meridian  and
              standard parallel)
              <B>-Joa</B><I>lon0/lat0/azimuth/scale</I>   (Oblique  Mercator  -
              two points)
              <B>-Joc</B><I>lon0/lat0/lonp/latp/scale</I>  (Oblique  Mercator -
              point and pole)
              <B>-Jq</B><I>lon0/scale</I> (Equidistant  Cylindrical  Projection
              (Plate Carree))
              <B>-Jt</B><I>lon0/scale</I> (TM - Transverse Mercator, with Equa
              tor as y = 0)
              <B>-Jt</B><I>lon0/lat0/scale</I> (TM - Transverse  Mercator,  set
              origin)
              <B>-Ju</B><I>zone/scale</I> (UTM - Universal Transverse Mercator)
              <B>-Jy</B><I>lon0/lats/scale</I> (Basic Cylindrical Projection)

              <B>AZIMUTHAL</B> <B>PROJECTIONS:</B>

              <B>-Ja</B><I>lon0/lat0/scale</I> (Lambert).
              <B>-Je</B><I>lon0/lat0/scale</I> (Equidistant).
              <B>-Jf</B><I>lon0/lat0/horizon/scale</I> (Gnomonic).
              <B>-Jg</B><I>lon0/lat0/scale</I> (Orthographic).
              <B>-Js</B><I>lon0/lat0/</I>[<I>slat/</I>]<I>scale</I> (General Stereographic)

              <B>CONIC</B> <B>PROJECTIONS:</B>

              <B>-Jb</B><I>lon0/lat0/lat1/lat2/scale</I> (Albers)
              <B>-Jd</B><I>lon0/lat0/lat1/lat2/scale</I> (Equidistant)
              <B>-Jl</B><I>lon0/lat0/lat1/lat2/scale</I> (Lambert)

              <B>MISCELLANEOUS</B> <B>PROJECTIONS:</B>

              <B>-Jh</B><I>lon0/scale</I> (Hammer)
              <B>-Ji</B><I>lon0/scale</I> (Sinusoidal)
              <B>-Jk</B>[<B>f|s</B>]<I>lon0/scale</I> (Eckert IV (f) and VI (s))
              <B>-Jn</B><I>lon0/scale</I> (Robinson)
              <B>-Jr</B><I>lon0/scale</I> (Winkel Tripel)
              <B>-Jv</B><I>lon0/scale</I> (Van der Grinten)
              <B>-Jw</B><I>lon0/scale</I> (Mollweide)

              <B>NON-GEOGRAPHICAL</B> <B>PROJECTIONS:</B>

              <B>-Jp</B>[<B>a</B>]<I>scale</I>[<I>/origin</I>] (polar (theta,r)  coordinates,
              optional <B>a</B> for azimuths and offset theta [0])
              <B>-Jx</B><I>x-scale</I>[<B>l|p</B><I>pow</I>][<I>/y-scale</I>[<B>l|p</B><I>pow</I>]]  (Linear, log,
              and power scaling)
              More details can be found  in  the  <B><A HREF="psbasemap.html">psbasemap</A></B>  man
              pages.

       <B>-R</B>     <I>west,</I>  <I>east,</I> <I>south,</I> and <I>north</I> specify the Region of
              interest. To specify boundaries in degrees and min
              utes  [and  seconds],  use  the  dd:mm[:ss] format.
              Append <B>r</B> if lower left and upper right map  coordi
              nates are given instead of wesn.


</PRE>
<H2>OPTIONS</H2><PRE>


       <B>-B</B>     Sets map boundary tickmark intervals. See <B><A HREF="psbasemap.html">psbasemap</A></B>
              for details.

       <B>-C</B>     Mark  end  of  existing clip path. No input file is
              needed. Implicitly sets <B>-O</B>.

       <B>-D</B>     Dumps out the resulting clipping polygons to  disk.
              Ignored if <B>-T</B> is set.  If no dumpprefix is given we
              use mask (Files will be called mask_*.d).

       <B>-E</B>     Sets the viewpoint's azimuth and elevation for per
              spective plots [180/90]'

       <B>-F</B>     Force  pixel  registration. [Default is grid regis
              tration].

       <B>-G</B>     Paint the clip polygons [or  tiles]  with  selected
              fill  [Default  is  no  fill].   Specify  the shade
              (0-255) or color (r/g/b, each in 0-255).

       <B>-H</B>     Input  file(s)  has  Header  record(s).  Number  of
              header records can be changed by editing your .gmt
              defaults file. If used, <B><A HREF="GMT.html">GMT</A></B>  default  is  1  header
              record.  Not used with binary data.

       <B>-K</B>     More   <I>PostScript</I>   code  will  be  appended  later
              [Default terminates the plot system].

       <B>-M</B>     Multiple segment file(s). Segments are separated by
              a  special record.  For ASCII files the first char
              acter must be <I>flag</I> [Default is  '&gt;'].   For  binary
              files all fields must be NaN.

       <B>-N</B>     Invert  the  sense  of  the test, i.e. clip regions
              where there is data coverage.

       <B>-O</B>     Selects Overlay plot mode  [Default  initializes  a
              new plot system].

       <B>-P</B>     Selects  Portrait  plotting  mode  [<B><A HREF="GMT.html">GMT</A></B>  Default is
              Landscape, see gmtdefaults to change this].

       <B>-S</B>     Sets radius of influence. Grid nodes within  <I>radius</I>
              of  a  data point are considered reliable. [Default
              is 0, which means that only grid cells with data in
              them  are reliable]. Append <B>k</B> to indicated km, also
              implying that <B>-R</B> <B>-I</B> are in degrees.

       <B>-T</B>     Plot tiles instead of  clip  polygons  (Only  works
              with <B>-Jx</B>, <B>-Jj</B>, <B>-Jm</B>, <B>-Jq</B>, and <B>-Jy</B>).
              ify where the lower left corner of the stamp should
              fall  on  the page relative to lower left corner of
              plot. Optionally, append a label, or <B>c</B> (which  will
              plot  the  command  string.).  The  GMT  parameters
              UNIX_TIME and UNIX_TIME_POS can affect the  appear
              ance; see the <B><A HREF="gmtdefaults.html">gmtdefaults</A></B> man page for details.

       <B>-V</B>     Selects  verbose  mode,  which  will  send progress
              reports to stderr [Default runs "silently"].

       <B>-X</B> <B>-Y</B>  Shift origin of plot by (<I>x-shift,y-shift</I>).  Prepend
              <B>a</B>  for  absolute  coordinates; the default (<B>r</B>) will
              reset plot origin.

       <B>-:</B>     Toggles  between  (longitude,latitude)  and  (lati
              tude,longitude)  input/output.  [Default is (longi
              tude,latitude)].  Applies to geographic coordinates
              only.

       <B>-c</B>     Specifies the number of plot copies. [Default is 1]

       <B>-bi</B>    Selects binary input. Append <B>s</B> for single precision
              [Default  is  double].   Append <I>n</I> for the number of
              columns in the binary file(s).  [Default is 2 input
              columns].


</PRE>
<H2>EXAMPLES</H2><PRE>
       To  make an overlay <I>PostScript</I> file that will mask out the
       regions of a contour map where there is  no  control  data
       using clip polygons, try:

       psmask  africa_grav.xyg  <B>-R</B>20/40/20/40 <B>-I</B>5<B>m</B> <B>-J</B>M10<B>i</B> <B>-O</B> <B>-K</B> &gt;
       mask.ps

       The same example but this time we use tiling:

       psmask africa_grav.xyg <B>-R</B>20/40/20/40 <B>-I</B>5<B>m</B> <B>-J</B>M10<B>i</B> <B>-T</B> <B>-O</B>  <B>-K</B>
       &gt; mask.ps


</PRE>
<H2>SEE ALSO</H2><PRE>
       <I>gmt</I>(l), <I><A HREF="grdmask.html">grdmask</A></I>(l), <I><A HREF="surface.html">surface</A></I>(l), <I><A HREF="psbasemap.html">psbasemap</A></I>(l), <I><A HREF="psclip.html">psclip</A></I>(l)











</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
<body bgcolor="#ffffff">