rGEDI (version 0.6.0)

clipLevel2AGeometry: Clip GEDI Level2A data by geometry

Description

This function clips GEDI Level2A data within a given geometry

Usage

clipLevel2AGeometry(level2a, polygon, output = "", split_by = NULL)

Value

Returns a list of S4 object of class "gedi.level2a" containing clipped GEDI Level2A data.

Arguments

level2a

A GEDI Level2A object (output of readLevel2A() function). An S4 object of class "gedi.level2a".

polygon

Polygon. An object of class sf::sf, which can be loaded as an ESRI shapefile using sf::st_read() function in the sf package.

output

optional character path where to save the new h5file. Default "" (temporary file).

split_by

Polygon id. If defined, GEDI data will be clipped by each polygon using the attribute specified by split_by from the attribute table.

See Also

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

Examples

# \donttest{
outdir <- tempdir()

# Specifying the path to GEDI level2A data (zip file)
level2A_fp_zip <- system.file("extdata",
  "GEDI02_A_2019108080338_O01964_T05337_02_001_01_sub.zip",
  package = "rGEDI"
)

# Unzipping GEDI level2A data
level2Apath <- unzip(level2A_fp_zip, exdir = outdir)

# Reading GEDI level2A data (h5 file)
level2a <- readLevel2A(level2Apath = level2Apath)

# Specifying the path to shapefile
polygon_filepath <- system.file("extdata", "stands_cerrado.shp", package = "rGEDI")

# Reading shapefile as sf object
library(sf)
polygon <- sf::st_read(polygon_filepath)
polygon <- polygon[1, , drop = FALSE]

# Specifying output file and path
output <- file.path(outdir, "GEDI02_A_2019108080338_O01964_T05337_02_001_01_clip")

# Clipping GEDI Level2A data by geometry
level2a_clip <- clipLevel2AGeometry(level2a,
  polygon = polygon,
  output = output
)
close(level2a)
lapply(level2a_clip, close)
# }