getLevel2BPAVDProfile.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/getLevel2BPAVDProfile.R
\name{getLevel2BPAVDProfile}
\alias{getLevel2BPAVDProfile}
\title{Get GEDI Plant Area Volume Density (PAVD) Index (GEDI Level2B)}
\usage{
getLevel2BPAVDProfile(level2b)
}
\arguments{
\item{level2b}{A GEDI Level2B object (output of \code{\link[rGEDI:readLevel2B]{readLevel2B}} function). A S4 object of class "gedi.level2b".}
}
\value{
An S4 object of class \code{\link[data.table:data.table]{data.table-class}}
containing the PAVD Index.
}
\description{
This function extracts Plant Area Volume Density (PAVD) Index from GEDI Level2B data.
}
\examples{
# specify the path to GEDI level2B data (zip file)
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 = dirname(level2B_fp_zip))

# Reading GEDI level2B data (h5 file)
level2b<-readLevel2B(level2Bpath=level2Bpath)

# Getting GEDI Plant Area Volume Density (PAVD) Index
level2BPAVDProfile<-getLevel2BPAVDProfile(level2b)
head(level2BPAVDProfile)

close(level2b)
}
\seealso{
https://lpdaac.usgs.gov/products/gedi02_bv001/
}