S2_query_granule: Query database for 'granule'

View source: R/S2_query_granule.R

S2_query_granuleR Documentation

Query database for 'granule'

Description

Implements the query options for granule described in the wiki.

Usage

S2_query_granule(atmCorr = NULL, broken = FALSE, cloudCovMin = NULL,
  cloudCovMax = NULL, dateMax = NULL, dateMin = NULL,
  geometry = NULL, granule = NULL, granuleId = NULL,
  orbitNo = NULL, owned = FALSE, product = NULL, productId = NULL,
  regionId = NULL, retGeometry = FALSE, utm = NULL,
  dateSingle = NULL, spatial = NULL, ...)

Arguments

atmCorr

logical if TRUE only results for atmospherically corrected data are returned.

broken

logical, TRUE if the granule is marked as broken (almost for sure you want to use FALSE, the default).

cloudCovMin

integer minimum cloud coverage from 0 to 100.

cloudCovMax

integer maximum cloud coverage from 0 to 100.

dateMax

character end date of format "YYYY-MM-DD".

dateMin

character start date of format "YYYY-MM-DD".

geometry

geometry which should intersect with granules. Can be a geoJSON geometry string (e.g. "type":"Point","coordinates":[16.5,48.5]), the path to a Point/Polygon shapefile, a SpatialPoints object or a SpatialPolygons object.

granule

character ESA granule id.

granuleId

integer internal metadata database granule id.

orbitNo

integer from 1 to 143.

owned

logical when TRUE only already bought granules will be returned.

product

chracter ESA product id.

productId

integer internal metadata database product id.

regionId

region of interest id (overrides the geometry parameter, if dateMin, dateMax or cloudCovMax are not specified, they are taken from the region of interest settings)

retGeometry

logical should product geometry be included in the response?

utm

character UTM zone, e.g. 33U, 01C.

dateSingle

character date of format "YYYY-MM-DD", specifies a single date and will override dateMin and dateMax.

spatial

character, R package name (sp or sf) to the format used by which granule geometries should be converted. Be aware that such conversion may take quite some time for large number of returned granules.

...

further arguments not implemented directly - see the API doc.

Value

data.frame describing matching granules.


IVFL-BOKU/sentinel2 documentation built on May 13, 2022, 11:15 p.m.