File: grdlandmask.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 (132 lines) | stat: -rw-r--r-- 4,661 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
<HTML>
<HEAD>
<TITLE>grdlandmask</TITLE>
</HEAD>
<BODY>
<H1>grdlandmask</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
       grdlandmask - Create "wet-dry" mask grdfile from shoreline
       data base.


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>grdlandmask</B>    <B>-G</B><I>mask</I><B>_</B><I>grd</I><B>_</B><I>file</I>]    <B>-I</B><I>xinc</I>[<B>m|c</B>][/<I>yinc</I>[<B>m|c</B>]]
       <B>-R</B><I>west/east/south/north</I>[<B>r</B>]                               [
       <B>-A</B><I>min</I><B>_</B><I>area</I>[/<I>min</I><B>_</B><I>level/max</I><B>_</B><I>level</I>] ] [ <B>-D</B><I>resolution</I> ] [ <B>-F</B> ]
       [ <B>-N</B><I>maskvalues</I>[<B>o</B>] ] [ <B>-V</B> ]


</PRE>
<H2>DESCRIPTION</H2><PRE>
       <B>grdlandmask</B> reads the selected shoreline database and uses
       that information to decide which nodes  in  the  specified
       grid are over land or over water. The nodes defined by the
       selected region and lattice spacing will be set  according
       to  one  of  two  criteria: (1) Lands vs water, or (2) the
       more detailed (hierarchial)  ocean  vs  land  vs  lake  vs
       island  vs pond. The resulting mask grdfile may be used in
       subsequent operations involving <B><A HREF="grdmath.html">grdmath</A></B> to mask  out  data
       from land [or water] areas.

       <B>-G</B>     Name of resulting output mask grd file.

       <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>-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>-A</B>     Features with an area smaller than <I>min</I><B>_</B><I>area</I> in km^2
              or  of  hierarchical  level  that  is  lower   than
              <I>min</I><B>_</B><I>level</I>  or higher than <I>max</I><B>_</B><I>level</I> will be ignored
              [Default  is  0/4  (all  features)].  See  DATABASE
              INFORMATION  in  the  <B><A HREF="pscoast.html">pscoast</A></B>  man-pages  for  more
              details.

       <B>-D</B>     Selects the resolution  of  the  data  set  to  use
              ((<B>f</B>)ull,    (<B>h</B>)igh,   (<B>i</B>)ntermediate,   (<B>l</B>)ow,   or
              (<B>c</B>)rude). The resolution drops off by ~80%  between
              data  sets.  [Default  is <B>l</B>]. Note that because the
              coastlines differ in details a node in a mask  file
              using  one  resolution  is not guaranteed to remain
              inside [or outside] when a different resolution  is
              selected.

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

              NaN. Append <B>o</B>  to  let  nodes  exactly  on  feature
              boundaries   be   considered  outside  [Default  is
              inside].  Specify this information  using  1  of  2
              formats:
                      <B>-N</B><I>wet/dry</I>.
                      <B>-N</B><I>ocean/land/lake/island/pond</I>.
              [Default is 0/1/0/1/0 (i.e., 0/1)].

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


</PRE>
<H2>EXAMPLES</H2><PRE>
       To set all nodes on land to NaN, and nodes over  water  to
       1, using the high resolution data set, do

       grdlandmask    <B>-R</B>-60/-40/-40/-30    <B>-Dh</B>    <B>-I</B>5<B>m</B>    <B>-N</B>1/NaN
       <B>-G</B>land_mask.grd <B>-V</B>

       To make a 1x1 degree global  grid  with  the  hierarchical
       levels of the nodes based on the low resolution data, try

       grdlandmask    <B>-R</B>0/360/-90/90    <B>-Dl</B>    <B>-I</B>1    <B>-N</B>0/1/2/3/4
       <B>-G</B>levels.grd <B>-V</B>


</PRE>
<H2>SEE ALSO</H2><PRE>
       <I>gmt</I>(l),  <I><A HREF="grdmath.html">grdmath</A></I>(l),  <I><A HREF="grdclip.html">grdclip</A></I>(l),  <I><A HREF="psmask.html">psmask</A></I>(l),   <I><A HREF="psclip.html">psclip</A></I>(l),
       <I><A HREF="pscoast.html">pscoast</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">