15
15
@fmt_docstring
16
16
@use_alias (
17
17
A = "area_thresh" ,
18
- # D="resolution",
19
- # G="gridmask",
18
+ D = "resolution" ,
19
+ G = "gridmask" ,
20
20
I = "reverse" ,
21
21
J = "projection" ,
22
- # N="mask",
22
+ N = "mask" ,
23
23
R = "region" ,
24
24
V = "verbose" ,
25
25
Z = "z_subregion" ,
35
35
s = "skiprows" ,
36
36
w = "wrap" ,
37
37
)
38
- @kwargs_to_strings (R = "sequence" , i = "sequence_comma" , o = "sequence_comma" )
38
+ @kwargs_to_strings (M = "sequence" , R = "sequence" , i = "sequence_comma" , o = "sequence_comma" )
39
39
def select (data = None , outfile = None , ** kwargs ):
40
40
r"""
41
41
Select data table subsets based on multiple spatial criteria.
@@ -68,6 +68,19 @@ def select(data=None, outfile=None, **kwargs):
68
68
outfile : str
69
69
The file name for the output ASCII file.
70
70
{A}
71
+ resolution : str
72
+ *resolution*\ [**+f**].
73
+ Ignored unless **mask** is set. Selects the resolution of the coastline
74
+ data set to use ((**f**)ull, (**h**)igh, (**i**)ntermediate, (**l**)ow,
75
+ or (**c**)rude). The resolution drops off by ~80% between data sets.
76
+ [Default is **l**]. Append (**+f**) to automatically select a lower
77
+ resolution should the one requested not be available [Default is abort
78
+ if not found]. Note that because the coastlines differ in details it is
79
+ not guaranteed that a point will remain inside [or outside] when a
80
+ different resolution is selected.
81
+ gridmask : str
82
+ Pass all locations that are inside the valid data area of the grid
83
+ *gridmask*. Nodes that are outside are either NaN or zero.
71
84
reverse : str
72
85
[**cflrsz**].
73
86
Reverses the sense of the test for each of the criteria specified:
@@ -83,6 +96,16 @@ def select(data=None, outfile=None, **kwargs):
83
96
- **z** select records NOT within the range specified by
84
97
**z_subregion**.
85
98
{J}
99
+ mask : str or list
100
+ Pass all records whose location is inside specified geographical
101
+ features. Specify if records should be skipped (s) or kept (k) using
102
+ 1 of 2 formats:
103
+
104
+ - *wet/dry*.
105
+ - *ocean/land/lake/island/pond*.
106
+
107
+ [Default is s/k/s/k/s (i.e., s/k), which passes all points on dry
108
+ land].
86
109
{R}
87
110
{V}
88
111
z_subregion : str
0 commit comments