rGEDI (version 0.1.11)

clipLevel2BGeometry: Clip GEDI Level2B data by geometry

Description

This function extracts GEDI Level1B data within a given geometry

Usage

clipLevel2BGeometry(level2b, polygon_spdf, output = "", split_by = NULL)

Arguments

level2b

A GEDI Level2B object (output of readLevel2B function). An S4 object of class "gedi.level2b".

polygon_spdf

Polygon. An object of class SpatialPolygonsDataFrame-class, which can be loaded as an ESRI shapefile using raster::shapefile() function in the raster 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.

Value

Returns a list of S4 objects of class "gedi.level2b" containing clipped GEDI Level2B data.

See Also

https://lpdaac.usgs.gov/products/gedi01_bv001/

Examples

# NOT RUN {
outdir = tempdir()

# Specifying the path to GEDI level2B data (zip file)
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)

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

# Reading shapefile as SpatialPolygonsDataFrame object
library(raster)
polygon_spdf<-shapefile(polygon_filepath)

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

# Clipping GEDI data by extent boundary box
level2b_clip <- clipLevel2BGeometry(level2b, polygon_spdf = polygon_spdf,
                                   output=output,
                                   split_by="id")

close(level2b)
lapply(level2b_clip, close)
# }