rGEDI (version 0.6.0)

clipLevel2BVPM: Clip GEDI Canopy Cover and Vertical Profile Metrics by Coordinates

Description

This function clips GEDI level2B derived Canopy Cover and Vertical Profile metrics a within given bounding coordinates

Usage

clipLevel2BVPM(level2BVPM, xmin, xmax, ymin, ymax)

Value

Returns an S4 object of class data.table::data.table

containing the Canopy Cover and Vertical Profile metrics.

Arguments

level2BVPM

A GEDI Level2B object (output of readLevel1B() function). An S4 object of class "data.table".

xmin

Numeric. West longitude (x) coordinate of the bounding rectangle, in decimal degrees.

xmax

Numeric. East longitude (x) coordinate of the bounding rectangle, in decimal degrees.

ymin

Numeric. South latitude (y) coordinate of the bounding rectangle, in decimal degrees.

ymax

Numeric. North latitude (y) coordinate of the bounding rectangle, in decimal degrees.

See Also

https://www.earthdata.nasa.gov/data/catalog/lpcloud-gedi02-b-002

Examples

# Specifying the path to GEDI level2B data (zip file)
outdir <- tempdir()
level2B_fp_zip <- system.file("extdata",
  "GEDI02_B_2019108080338_O01964_T05337_02_001_01_sub.zip",
  package = "rGEDI"
)

# Unzipping GEDI level2A data
level2Bpath <- unzip(level2B_fp_zip, exdir = outdir)

# Reading GEDI level2B data (h5 file)
level2b <- readLevel2B(level2Bpath = level2Bpath)

# Extracting canopy cover and vertical profile metrics
beam <- grep("^BEAM", (level2b@h5)$ls(recursive = FALSE)$name,
             value = TRUE)[1]
level2BVPM <- getLevel2BVPM(level2b, beams = beam)

# Bounding rectangle coordinates
xmin <- -44.15036
xmax <- -44.10066
ymin <- -13.75831
ymax <- -13.71244

# Clipping level2BVPM by extent boundary box
level2b_clip <- clipLevel2BVPM(level2BVPM, xmin, xmax, ymin, ymax)

hasLeaflet <- require(leaflet)

if (hasLeaflet) {
  leaflet() %>%
    addCircleMarkers(level2b_clip$longitude_bin0,
      level2b_clip$latitude_bin0,
      radius = 1,
      opacity = 1,
      color = "red"
    ) %>%
    addScaleBar(options = list(imperial = FALSE)) %>%
    addProviderTiles(providers$Esri.WorldImagery)
}

close(level2b)