getLevel2BPAIProfile: Get GEDI Plant Area Index (PAI) Profile (GEDI Level2B)

In carlos-alberto-silva/rGEDI: NASA's Global Ecosystem Dynamics Investigation (GEDI) Data Visualization and Processing

Get GEDI Plant Area Index (PAI) Profile (GEDI Level2B)

Description

This function extracts the Plant Area Index (PAI) Profile from GEDI Level2B data.

Usage

getLevel2BPAIProfile(level2b)

Arguments

level2b

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

Details

Characteristics. Flag indicating likely invalid waveform (1=valid, 0=invalid).

• beam Beam identifier

• shot_number Shot number

• algorithmrun_flag The L2B algorithm is run if this flag is set to 1 indicating data have sufficient waveform fidelity for L2B to run

• l2b_quality_flag L2B quality flag

• delta_time Transmit time of the shot since Jan 1 00:00 2018

• lat_lowestmode Latitude of center of lowest mode

• lon_lowestmode Longitude of center of lowest mode

• elev_highestreturn Elevation of highest detected return relative to reference ellipsoid

• elev_lowestmode Elevation of center of lowest mode relative to reference ellipsoid

• height_lastbin Height of the last bin of the pgap_theta_z, relative to the ground

• pai_z Plant Area Index profile

Value

Returns an S4 object of class data.table::data.table containing the elevation and relative heights.

See Also

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

Examples

# 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 (PAI) Profile (GEDI Level2B)
level2BPAIProfile<-getLevel2BPAIProfile(level2b)
head(level2BPAIProfile)

close(level2b)

carlos-alberto-silva/rGEDI documentation built on Oct. 18, 2024, 4:46 a.m.