R/bounding_box.R

In apache.sedona: R Interface for Apache Sedona

#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#  KIND, either express or implied.  See the License for the
#  specific language governing permissions and limitations
#  under the License.

#' Construct a bounding box object.
#'
#' Construct a axis-aligned rectangular bounding box object.
#'
#' @param sc The Spark connection.
#' @param min_x Minimum x-value of the bounding box, can be +/- Inf.
#' @param max_x Maximum x-value of the bounding box, can be +/- Inf.
#' @param min_y Minimum y-value of the bounding box, can be +/- Inf.
#' @param max_y Maximum y-value of the bounding box, can be +/- Inf.
#'
#' @return A bounding box object.
#'
#' @examples
#' library(sparklyr)
#' library(apache.sedona)
#'
#' sc <- spark_connect(master = "spark://HOST:PORT")
#' bb <- new_bounding_box(sc, -1, 1, -1, 1)
#'
#' @export
new_bounding_box <- function(sc,
                             min_x = -Inf,
                             max_x = Inf,
                             min_y = -Inf,
                             max_y = Inf) {
  invoke_new(
    sc,
    "org.locationtech.jts.geom.Envelope",
    as.numeric(min_x),
    as.numeric(max_x),
    as.numeric(min_y),
    as.numeric(max_y)
  ) %>%
    make_bounding_box()
}

make_bounding_box <- function(jobj) {
  structure(
    list(
      .jobj = jobj,
      minX = function() {
        jobj %>% invoke("getMinX")
      },
      maxX = function() {
        jobj %>% invoke("getMaxX")
      },
      minY = function() {
        jobj %>% invoke("getMinY")
      },
      maxY = function() {
        jobj %>% invoke("getMaxY")
      },
      width = function() {
        jobj %>% invoke("getWidth")
      },
      height = function() {
        jobj %>% invoke("getHeight")
      },
      diameter = function() {
        jobj %>% invoke("getDiameter")
      },
      minExtent = function() {
        jobj %>% invoke("minExtent")
      },
      maxExtent = function() {
        jobj %>% invoke("maxExtent")
      },
      area = function() {
        jobj %>% invoke("getArea")
      }
    ),
    class = "bounding_box"
  )
}