getScenes: Query scenes from CODE-DE EO Finder API

View source: R/getScenes.R

getScenesR Documentation

Query scenes from CODE-DE EO Finder API

Description

Returns metadata for satellite imagery that matches several input criteria

Usage

getScenes(
  aoi,
  bufferDist = NULL,
  startDate = NULL,
  endDate = NULL,
  codede = TRUE,
  satellite = NULL,
  productType = NULL,
  sensorMode = NULL,
  orbitDirection = NULL,
  relativeOrbitNumber = NULL,
  view = FALSE
)

Arguments

aoi

Area of interest for the query. Has to be an sf object with polygonal or point geometry. In case of a point geometry, the buffer argument has to be set.

bufferDist

Buffer around the AOI in meters. Defaults to 0.

startDate

Starting date for the query of format "YYYY-MM-DD".

endDate

End date for query.

codede

If TRUE (default) use CODE-DE repository covering Germany, if FALSE use CREODIAS for worldwide coverage including Landsat data.

satellite

Satellite to query from. One of "Sentinel1", "Sentinel2" etc. If none is chosen, all available results are returned.

productType

Product type to query. One of "SLC", "GRD", "CARD-INF6", "CARD-BS", "CARD-BS-MC", "L3-WASP"... Only considered if set.

sensorMode

Sensor mode for Sentinel-1. One of "IW", "EW", ... Only considered if set.

orbitDirection

Direction of satellite orbit. One of "ascending" or "descending". Only considered if set.

relativeOrbitNumber

Relative orbit number. Only considered if set.

view

logical indicating if the queried scenes should be visualized with mapview. Defaults to FALSE.

Value

sf object containing footprints and metadata for all queried scenes.

Examples

# example AOI
aoi <- c(10.441054, 52.286959) %>%
  sf::st_point() %>%
  sf::st_sfc(crs = 4326)

# scenes for aoi and given criteria
scenes <-
  getScenes(
    aoi = aoi,
    startDate = "2019-01-01",
    endDate = "2019-01-15",
    satellite = "Sentinel1",
    productType = "SLC",
    view = TRUE
  )

felixlobert/rcodede documentation built on July 31, 2022, 4:57 a.m.