senPreview: Preview Sentinel-2 satellite images

Description Usage Arguments Details Value Examples

View source: R/senPreview.R

Description

senPreview shows a preview of the n-th image from a set of search results on an interactive map.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
senPreview(
  searchres,
  username,
  password,
  n,
  dates,
  lpos = c(3, 2, 1),
  add.Layer = FALSE,
  verbose = FALSE,
  ...
)

Arguments

searchres

a vector with the results from senSearch.

username

ESA’s ‘SciHub’ username.

password

ESA’s ‘SciHub’ password.

n

a numeric argument identifying the row of the image in searchres.

dates

a vector with the dates being considered for previewing. This argument is mandatory if n is not defined.

lpos

vector argument. Defines the position of the red-green-blue layers to enable false color visualization.

add.Layer

logical argument. If TRUE, the function plots the image on an existing map. Allows combinations of images on a map using lsPreview and modPreview functions.

verbose

logical argument. If TRUE, the function prints the running steps and warnings.

...

arguments for nested functions:

  • arguments allowed by the viewRGB function from mapview packages are valid arguments

Details

The function shows a preview of the n-th output image from a search in Sentinel archives (modSearch). The preview is downloaded from ‘SciHub’s' website. Please, be aware that only some images may have a preview. Credentials from an ESA’s ‘SciHub’ account are needed, which can be obtained here.

Value

this function does not return anything. It displays a preview of one of the search results.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
## Not run: 
# load a spatial polygon object of Navarre
data(ex.navarre)
# perform the search query
sres <- senSearch(startDate = as.Date("2018210","%Y%j"),
                  endDate = as.Date("2018218","%Y%j"),
                  platform = "Sentinel-2",
                  extent = ex.navarre,
                  product = "S2MSI1C",
                  username = "username",
                  password = "password")
# preview some images
senPreview(sres, username = "username", password = "password",n=1)
senPreview(sres, username = "username", password = "password",n=3, add.Layer =TRUE)

# show the dates in julian days
senGetDates(names(sres),format="%Y%j")

senPreview(sres, 
           username = "username", 
           password = "password", 
           dates = senGetDates(names(sres[3])))

## End(Not run)

RGISTools documentation built on July 2, 2020, 3:58 a.m.