rGEDI: getLevel2BVPM – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

getLevel2BVPM

Get GEDI Canopy Cover and Vertical Profile Metrics (GEDI Level2B)

Description

This function extracts information from GEDI Level2B data: Total Plant Area Index, Foliage Height Diversity, Foliage Clumping Index, Total Gap Probability (theta), and Total canopy cover.

Usage

getLevel2BVPM(level2b)

Arguments

level2b

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

Details

These are the biophysical variables and additional information extracted:

beam Beam identifie
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
sensitivity Maxmimum canopy cover that can be penetrated
solar_elevation Solar elevation
latitude_lastbin Latitude of last bin of the pgap_theta_z, interpolated from L1B waveform coordinate
latitude_bin0 Latitude of first bin of the pgap_theta_z, interpolated from L1B waveform coordinate
elev_highestreturn Elevation of highest detected return relative to reference ellipsoid
elev_lowestmode Elevation of center of lowest mode relative to reference ellipsoid
pai Total Plant Area Index
fhd_normal Foliage Height Diversity
omega Foliage Clumping Index
pgap_theta Total Gap Probability (theta)
cover Total canopy cover

Value

Returns an S4 object of class data.table-class containing the Vegetation Profile Biophysical Variables.

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 Vegetation Profile Biophysical Variables
level2BVPM<-getLevel2BVPM(level2b)
head(level2BVPM)

close(level2b)

rGEDI

NASA's Global Ecosystem Dynamics Investigation (GEDI) Data Visualization and Processing

v0.1.11

GPL-3

Authors

Carlos Alberto Silva [aut, cre, cph], Caio Hamamura [aut, cph], Ruben Valbuena [aut, ctb], Steven Hancock [aut, ctb], Adrian Cardil [aut, ctb], Eben North Broadbent [aut, ctb], Danilo Roberti Alves de Almeida [aut, ctb], Celso H. L. Silva Junior [aut, ctb], Carine Klauberg [aut, ctb], Burton Garbow [cph] (Is the author of the MINPACK-1 Least Squares Fitting Library), Kenneth Hillstrom [cph] (Is the author of the MINPACK-1 Least Squares Fitting Library), Jorge More [cph] (Is the author of the MINPACK-1 Least Squares Fitting Library), Craig Markwardt [cph] (Is the author of the enhanced MINPACK-1 Least Squares Fitting Library)

Initial release