rGEDI (version 0.1.11)

clipLevel2BPAIProfile: Clip GEDI Plant Area Index profile by Coordinates

Description

This function clips GEDI level2B derived Plant Area Index profile a within given bounding coordinates

Usage

clipLevel2BPAIProfile(level2BPAIProfile, xmin, xmax, ymin, ymax)

Arguments

level2BPAIProfile

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

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.

Value

Returns an S4 object of class data.table-class containing the Plant Area Index profile data.

See Also

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

Examples

# NOT RUN {
# 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 GEDI Plant Area Index profile
level2BPAIProfile<-getLevel2BPAIProfile(level2b)

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

# Clipping GEDI Plant Area Index profile by extent boundary box
level2b_clip <- clipLevel2BPAIProfile(level2BPAIProfile,xmin, xmax, ymin, ymax)

close(level2b)
# }