rGEDI (version 0.6.0)

clipLevel1B: Clip GEDI Level1B data by Coordinates

Description

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

Usage

clipLevel1B(level1b, xmin, xmax, ymin, ymax, output)

Value

Returns a list of S4 objects of class gedi.level1b containing clipped GEDI Level1B data.

Arguments

level1b

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

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.

output

Optional character path where to save the new hdf5file. The default stores a temporary file only.

See Also

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

Examples

# \donttest{
# Specifying the path to GEDI level1B data (zip file)
outdir <- tempdir()

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)

# Bounding rectangle coordinates
xmin <- -44.13
xmax <- -44.12
ymin <- -13.74
ymax <- -13.73

# Specifying 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 <- clipLevel1B(level1b, xmin, xmax, ymin, ymax, output)

close(level1b)
close(level1b_clip)
# }