estimateCoherence: Estimate the interferometric coherence

View source: R/estimateCoherence.R

estimateCoherenceR Documentation

Estimate the interferometric coherence

Description

Coherence estimation for two corresponding Sentinel-1 SLC scenes

Usage

estimateCoherence(
  scene1,
  scene2,
  outputDirectory = getwd(),
  fileName,
  resolution,
  polarisation = "VV,VH",
  swath = "all",
  firstBurst = 1,
  lastBurst = 9,
  aoi = NULL,
  aoiBuffer = NULL,
  numCores = NULL,
  maxMemory = NULL,
  crs = "AUTO:42001",
  execute = FALSE,
  return = FALSE,
  BigTIFF = FALSE,
  docker = FALSE,
  sudo = FALSE
)

Arguments

scene1

Path of first Sentinel-1 scene for coherence estimation.

scene2

Path of second Sentinel-1 scene.

outputDirectory

Directory for the output file.

fileName

Name of the output file.

resolution

Spatial resolution of the output raster in meters.

polarisation

Polarisations to be processed. One of "VH", "VV", or "VV,VH". Defaults to "VV,VH".

swath

Swath to be processed. One of "IW1", "IW2", "IW3" or "all".

firstBurst

First burst index from the chosen swath. Between 1 and 9. Only relevant if swath != "all".

lastBurst

Last burst index. Has to be higher than or equal to first burst. Only relevant if swath != "all".

aoi

sf object for the area of interest.

aoiBuffer

Buffer around aoi in meters. Defaults to 0.

numCores

Number of CPUs to be used in the process. Chosen by SNAP if not set.

maxMemory

Amount of memory to be used in GB. Chosen by SNAP if not set.

crs

Coordinate reference system to use for output of format "EPSG:XXXX". Defaults to automatic UTM/WGS84 if not set.

execute

logical if command for esa SNAP gpt shall be executed. If FALSE the command is printed instead.

return

logical if processed raster or stack shall be returned.

BigTIFF

logical if output should be written as BigTIFF.

docker

logical if a dockerized version of SNAP (mundialis/esa-snap:ubuntu) should be used. Make sure docker is installed and can be run by the user. The image is pulled automatically from dockerhub on first execution.

sudo

logical if command should be executed or returned with superuser rights

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"
  ) %>%
  dplyr::filter(relativeOrbitNumber == 117)

estimateCoherence(
  scene1 = scenes$productPath[2],
  scene2 = scenes$productPath[1],
  fileName = "test.tif",
  resolution = 30,
  aoi = aoi,
  execute = FALSE)

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