rGEDI (version 0.1.11)

clipLevel1BGeometry: Clip GEDI Level1B data by geometry

Description

This function clips GEDI Level1B (geolocated waveforms) data within a given bounding geometry

Usage

clipLevel1BGeometry(level1b, polygon_spdf, output = "", split_by = NULL)

Arguments

level1b

A GEDI Level1B object (output of readLevel1B function). An S4 object of class "gedi.level1b".

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 hdf5file. The default stores a temporary file only.

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 object of class "gedi.level1b" containing clipped GEDI Level1B data.

Examples

# NOT RUN {
outdir = tempdir()

# Specifying the path to GEDI level1B data (zip file)
level1B_fp_zip <- system.file("extdata",
                  "GEDI01_B_2019108080338_O01964_T05337_02_003_01_sub.zip",
                  package="rGEDI")

# Unzipping GEDI level1B data
level1Bpath <- unzip(level1B_fp_zip,exdir = outdir)

# Reading GEDI level1B data (h5 file)
level1b<-readLevel1B(level1Bpath=level1Bpath)

# 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)

# Spepecifing output file and path
output<-file.path(outdir,"GEDI01_B_2019108080338_O01964_T05337_02_003_01_clip")

# clipping GEDI Level1B data by extent boundary box
level1b_clip <- clipLevel1BGeometry(level1b, polygon_spdf = polygon_spdf,
                                   output=output,
                                   split_by="id")

close(level1b)
lapply(level1b_clip, close)
# }