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
|
#' S2 Geography Accessors
#'
#' Accessors extract information about [geography vectors][as_s2_geography].
#'
#' @param x,y [geography vectors][as_s2_geography]. These inputs
#' are passed to [as_s2_geography()], so you can pass other objects
#' (e.g., character vectors of well-known text) directly.
#' @param radius Radius of the earth. Defaults to the average radius of
#' the earth in meters as defined by [s2_earth_radius_meters()].
#'
#' @export
#'
#' @seealso
#' BigQuery's geography function reference:
#'
#' - [ST_ISCOLLECTION](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_iscollection)
#' - [ST_DIMENSION](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_dimension)
#' - [ST_NUMPOINTS](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_numpoints)
#' - [ST_ISEMPTY](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_isempty)
#' - [ST_AREA](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_area)
#' - [ST_LENGTH](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_length)
#' - [ST_PERIMETER](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_perimeter)
#' - [ST_X](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_x)
#' - [ST_Y](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_y)
#' - [ST_DISTANCE](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_distance)
#' - [ST_MAXDISTANCE](https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_maxdistance)
#'
#' @examples
#' # s2_is_collection() tests for multiple geometries in one feature
#' s2_is_collection(c("POINT (-64 45)", "MULTIPOINT ((-64 45), (8 72))"))
#'
#' # s2_dimension() returns 0 for point, 1 for line, 2 for polygon
#' s2_dimension(
#' c(
#' "GEOMETRYCOLLECTION EMPTY",
#' "POINT (-64 45)",
#' "LINESTRING (-64 45, 8 72)",
#' "POLYGON ((0 0, 0 10, 10 10, 10 0, 0 0))",
#' "GEOMETRYCOLLECTION (POINT (-64 45), LINESTRING (-64 45, 8 72))"
#' )
#' )
#'
#' # s2_num_points() counts points
#' s2_num_points(c("POINT (-64 45)", "LINESTRING (-64 45, 8 72)"))
#'
#' # s2_is_empty tests for emptiness
#' s2_is_empty(c("POINT (-64 45)", "POINT EMPTY"))
#'
#' # calculate area, length, and perimeter
#' s2_area("POLYGON ((0 0, 0 10, 10 10, 10 0, 0 0))")
#' s2_perimeter("POLYGON ((0 0, 0 10, 10 10, 10 0, 0 0))")
#' s2_length(s2_boundary("POLYGON ((0 0, 0 10, 10 10, 10 0, 0 0))"))
#'
#' # extract x and y coordinates from points
#' s2_x(c("POINT (-64 45)", "POINT EMPTY"))
#' s2_y(c("POINT (-64 45)", "POINT EMPTY"))
#'
#' # calculate minimum and maximum distance between two geometries
#' s2_distance(
#' "POLYGON ((0 0, 0 10, 10 10, 10 0, 0 0))",
#' "POINT (-64 45)"
#' )
#' s2_max_distance(
#' "POLYGON ((0 0, 0 10, 10 10, 10 0, 0 0))",
#' "POINT (-64 45)"
#' )
#'
s2_is_collection <- function(x) {
cpp_s2_is_collection(as_s2_geography(x))
}
#' @rdname s2_is_collection
#' @export
s2_is_valid <- function(x) {
cpp_s2_is_valid(as_s2_geography(x, check = FALSE))
}
#' @rdname s2_is_collection
#' @export
s2_is_valid_detail <- function(x) {
x <- as_s2_geography(x, check = FALSE)
data.frame(
is_valid = cpp_s2_is_valid(x),
reason = cpp_s2_is_valid_reason(x),
stringsAsFactors = FALSE
)
}
#' @rdname s2_is_collection
#' @export
s2_dimension <- function(x) {
cpp_s2_dimension(as_s2_geography(x))
}
#' @rdname s2_is_collection
#' @export
s2_num_points <- function(x) {
cpp_s2_num_points(as_s2_geography(x))
}
#' @rdname s2_is_collection
#' @export
s2_is_empty <- function(x) {
cpp_s2_is_empty(as_s2_geography(x))
}
#' @rdname s2_is_collection
#' @export
s2_area <- function(x, radius = s2_earth_radius_meters()) {
recycled <- recycle_common(as_s2_geography(x), radius)
cpp_s2_area(recycled[[1]]) * radius ^ 2
}
#' @rdname s2_is_collection
#' @export
s2_length <- function(x, radius = s2_earth_radius_meters()) {
recycled <- recycle_common(as_s2_geography(x), radius)
cpp_s2_length(recycled[[1]]) * radius
}
#' @rdname s2_is_collection
#' @export
s2_perimeter <- function(x, radius = s2_earth_radius_meters()) {
recycled <- recycle_common(as_s2_geography(x), radius)
cpp_s2_perimeter(recycled[[1]]) * radius
}
#' @rdname s2_is_collection
#' @export
s2_x <- function(x) {
cpp_s2_x(as_s2_geography(x))
}
#' @rdname s2_is_collection
#' @export
s2_y <- function(x) {
cpp_s2_y(as_s2_geography(x))
}
# document these with the other linear referencers
#' @rdname s2_interpolate
#' @export
s2_project <- function(x, y, radius = s2_earth_radius_meters()) {
recycled <- recycle_common(as_s2_geography(x), as_s2_geography(y), radius)
length <- cpp_s2_length(recycled[[1]]) * radius
cpp_s2_project_normalized(recycled[[1]], recycled[[2]]) * length
}
#' @rdname s2_interpolate
#' @export
s2_project_normalized <- function(x, y) {
recycled <- recycle_common(as_s2_geography(x), as_s2_geography(y))
cpp_s2_project_normalized(recycled[[1]], recycled[[2]])
}
#' @rdname s2_is_collection
#' @export
s2_distance <- function(x, y, radius = s2_earth_radius_meters()) {
recycled <- recycle_common(as_s2_geography(x), as_s2_geography(y), radius)
cpp_s2_distance(recycled[[1]], recycled[[2]]) * radius
}
#' @rdname s2_is_collection
#' @export
s2_max_distance <- function(x, y, radius = s2_earth_radius_meters()) {
recycled <- recycle_common(as_s2_geography(x), as_s2_geography(y), radius)
cpp_s2_max_distance(recycled[[1]], recycled[[2]]) * radius
}
|
