S2_query_image: Prepare a list to query database for 'image'

In IVFL-BOKU/sentinel2: Tools to access Sentinel-2 data pre-processed by IVFL, BOKU Vienna

Prepare a list to query database for 'image'

Description

Implements the query options for 'images' described in the wiki.

Usage

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

Arguments

atmCorr	logical if TRUE only results for atmospherically corrected data are returned.
band	chracter spectral band: B01/B02/B03/B04/B05/B06/B07/B08/B8A/B09/ B10/B11/B12/all/SCL/LAI/albedo - see sentinel2 documentation.
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.
imageId	integer internal metadata database image 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)
resolution	integer spatial resolution [m]: 60/20/10 (resolution depends on the spectral band).
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 return of the database.

IVFL-BOKU/sentinel2 documentation built on June 9, 2025, 12:55 a.m.