R/from.R

In rgeedim: Search, Composite, and Download 'Google Earth Engine' Imagery with the 'Python' Module 'geedim'

#' Reference Google Earth Engine Image or Image Collection by ID or Name
#'
#' Create references to a Google Earth Engine Image or Image Collection based on IDs or names, or combine Images into Image Collections.
#'
#' @param x character. `id` of Image, `name` of Image Collection, or a vector of Image `id` to create a new Image Collection
#'
#' @return A `geedim.image.ImageAccessor` (for geedim >= 2.0.0) or `geedim.MaskedImage` (for geedim < 2.0.0) object, or `try-error` on error. See `\link{geedim-versions}` for more details.
#'
#' @export
#' @rdname from
#' @examplesIf isTRUE(as.logical(Sys.getenv("R_RGEEDIM_RUN_EXAMPLES"))) && gd_is_initialized()
#' \donttest{
#' if (gd_is_initialized())
#'   gd_image_from_id('CSP/ERGo/1_0/Global/SRTM_topoDiversity')
#' }
gd_image_from_id <- function(x) {
  .inform_missing_module(gd, "geedim")
  if (.gd_version_ge("2.0.0")) {
    y <- try(gd$utils$ee$Image(x)$gd, silent = FALSE)
  } else {
    if (grepl("^projects/", x)) {
      # manual creation for custom assets in geedim 1.x.x
      # using BaseImage avoids STAC catalog lookups that fail for custom assets
      ee <- earthengine()
      geedim_download_mod <- reticulate::import("geedim.download", delay_load = TRUE)
      y <- try(geedim_download_mod$BaseImage(ee$Image(x)), silent = FALSE)
    } else {
      y <- try(gd$MaskedImage$from_id(x), silent = FALSE)
    }
  }
  if (inherits(y, 'try-error'))
    return(invisible(y))
  y
}

#' @return A `geedim.collection.ImageCollectionAccessor` (for geedim >= 2.0.0) or `geedim.MaskedCollection` (for geedim < 2.0.0) object, or `try-error` on error. See `\link{geedim-versions}` for more details.
#' @export
#' @rdname from
#' @examplesIf isTRUE(as.logical(Sys.getenv("R_RGEEDIM_RUN_EXAMPLES"))) && gd_is_initialized()
#' \donttest{
#' if (gd_is_initialized())
#'
#'   # Find 1m DEMs in arbitrary extent
#'   r <- gd_bbox(xmin = -121.4, xmax = -121.35, ymin = 37.55, ymax = 37.6)
#'
#'   # collection of individual tiles of DEM
#'   x <- gd_collection_from_name("USGS/3DEP/1m")
#'
#'   # search within region
#'   y <- gd_search(x, r)
#'
#'   gd_properties(y)
#'
#' }
gd_collection_from_name <- function(x) {
  .inform_missing_module(gd, "geedim")
  if (.gd_version_ge("2.0.0")) {
    y <- try(gd$utils$ee$ImageCollection(x)$gd, silent = FALSE)
  } else {
    y <- try(gd$MaskedCollection$from_name(x), silent = FALSE)
  }
  if (inherits(y, 'try-error')) return(invisible(y))
  y
}

#' @return A `geedim.collection.ImageCollectionAccessor` (for geedim >= 2.0.0) or `geedim.MaskedCollection` (for geedim < 2.0.0) object, or `try-error` on error. See `\link{geedim-versions}` for more details.
#' @export
#' @rdname from
#' @examplesIf isTRUE(as.logical(Sys.getenv("R_RGEEDIM_RUN_EXAMPLES"))) && gd_is_initialized()
#' \donttest{
#' if (gd_is_initialized())
#'   # Find 1m DEM in arbitrary extent
#'   r <- gd_bbox(xmin = -121.4, xmax = -121.35, ymin = 37.55, ymax = 37.6)
#'
#'   # collection of individual tiles of DEM
#'   x <- gd_collection_from_name("USGS/3DEP/1m")
#'
#'   # search within region
#'   y <- gd_search(x, r)
#'
#'   # select images with some condition of interest

#'   z <- subset(gd_properties(y),
#'               grepl("UpperSouthAmerican_Eldorado_2019", id) > 0)
#'
#'   # create encapsulated images from IDs returned by search
#'   l <- lapply(z$id, gd_image_from_id)
#'
#'   # create a new collection from the list of images
#'   \dontrun{
#'   l2 <- gd_collection_from_list(l)
#'   l2
#'   }
#'
#' ### download composite of custom collection
#' #  gd_download(gd_composite(l2),
#' #              filename = "test.tif",
#' #              region = r,
#' #              crs = "EPSG:5070",
#' #              scale = 30)
#'
#' }
gd_collection_from_list <- function(x) {
  .inform_missing_module(gd, "geedim")
  if (.gd_version_ge("2.0.0")){
    # extract underlying ee.Image if element is a geedim object
    x <- lapply(x, function(i) {
      if (inherits(i, "geedim.image.ImageAccessor")) {
        return(i$ee_image)
      }
      i
    })
    y <- try(gd$utils$ee$ImageCollection(x)$gd, silent = FALSE)
  } else {
    y <- try(gd$MaskedCollection$from_list(x), silent = FALSE)
  }
  if (inherits(y, 'try-error')) return(invisible(y))
  y
}

#' @export
#' @param filename File or Asset Name
#' @param folder Optional: Project Name
#' @rdname from
#' @examplesIf isTRUE(as.logical(Sys.getenv("R_RGEEDIM_RUN_EXAMPLES"))) && gd_is_initialized()
#' \dontrun{
#' if (gd_is_initialized())
#'   gd_asset_id("RGEEDIM_TEST", "rgeedim-demo")
#' }
gd_asset_id <- function(filename, folder = NULL) {
  .inform_missing_module(gd, "geedim")
  gd$utils$asset_id(filename, folder)
}

#' @export
#' @param parent Full path to project folder (with or without `"/assets"` suffix)
#' @rdname from
#' @examplesIf isTRUE(as.logical(Sys.getenv("R_RGEEDIM_RUN_EXAMPLES"))) && gd_is_initialized()
#' \dontrun{
#' if (gd_is_initialized())
#'   gd_list_assets("projects/rgeedim-demo")
#' }
gd_list_assets <- function(parent) {
  if (!endsWith(parent, "/assets"))
    parent <- paste0(parent, "/assets")
  .inform_missing_module(gd, "geedim")
  res <- gd$utils$ee$data$listAssets(list(parent = parent))
  if (length(res) == 0 || length(res[[1]]) == 0) {
    return(data.frame(type = character(0), name = character(0), id = character(0), updateTime = structure(numeric(0), class = c("POSIXct", "POSIXt"), tzone = "GMT"), stringsAsFactors = FALSE))
  }
  res <- do.call('rbind', lapply(res, function(x) {
    data.frame(t(do.call('cbind', x)))
  }))
  res[] <- lapply(res, unlist)
  rownames(res) <- NULL
  res$updateTime <- as.POSIXct(res$updateTime, format = "%Y-%m-%dT%H:%M:%OS", tz = "GMT")
  res
}