From 03c68e7804ce85894fb611f18776655401e94e2b Mon Sep 17 00:00:00 2001 From: 16EAGLE Date: Fri, 19 Apr 2024 11:36:52 +0200 Subject: [PATCH] updated docs --- R/RStoolbox-package.R | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/R/RStoolbox-package.R b/R/RStoolbox-package.R index 1af3d58..b1a669a 100644 --- a/R/RStoolbox-package.R +++ b/R/RStoolbox-package.R @@ -6,10 +6,10 @@ #' #' \itemize{ #' \item \code{\link{readMeta}}: import Landsat metadata from MTL or XML files -#' \item \code{\link{stackMeta}}: load Landsat bands based on metadata +#' \item \code{\link{stackMeta}}, \code{\link{getMeta}: load Landsat bands based on metadata #' \item \code{\link{readSLI} & \link{writeSLI}}: read and write ENVI spectral libraries #' \item \code{\link{saveRSTBX} & \link{readRSTBX}}: save and re-import RStoolbox classification objects (model and map) -#' \item \code{\link{readEE}}: import and tidy EarthExplorer search results +#' \item \code{\link{readEE}}: import and tidy EarthExplorer search results #' } #' #' @section Data Pre-Processing: @@ -19,11 +19,15 @@ #' \item \code{\link{topCor}}: topographic illumination correction #' \item \code{\link{cloudMask} & \link{cloudShadowMask}}: mask clouds and cloud shadows in Landsat or other imagery which comes with a thermal band #' \item \code{\link{classifyQA}}: extract layers from Landsat 8 QA bands, e.g. cloud confidence +#' \item \code{\link{encodeQA}} & \link{decodeQA}}: encode/decode Landsat 16-bit QA bands. #' \item \code{\link{rescaleImage}}: rescale image to match min/max from another image or a specified min/max range -#' \item \code{\link{normImage}}: normalize imagery by centering and scaling +#' \item \code{\link{normImage}}: normalize imagery by centering and scaling +#' \item \code{\link{oneHotEncode}}: one-hot encode a raster or vector #' \item \code{\link{histMatch}}: matches the histograms of two scenes +#' \item \code{\link{pifMatch}}: matches one scene to another based on linear regression of Pseudo-Invariant Features (PIF) #' \item \code{\link{coregisterImages}}: co-register images based on mutual information #' \item \code{\link{panSharpen}}: sharpen a coarse resolution image with a high resolution image (typically panchromatic) +#' \item \code{\link{estimateHaze}}: estimate image haze for Dark Object Subtraction (DOS) #' } #' #'@section Data Analysis: @@ -34,9 +38,11 @@ #' \item \code{\link{sam}}: spectral angle mapper #' \item \code{\link{rasterPCA}}: principal components transform for raster data #' \item \code{\link{rasterCVA}}: change vector analysis +#' \item \code{\link{rasterEntropy}}: calculates shannon entropy #' \item \code{\link{unsuperClass}}: unsupervised classification -#' \item \code{\link{superClass}}: supervised classification +#' \item \code{\link{superClass}}, \code{\link{validateMap}}, \code{\link{getValidation}}: supervised classification and validation #' \item \code{\link{fCover}}: fractional cover of coarse resolution imagery based on high resolution classification +#' \item \code{\link{mesma}}: spectral unmixing using Multiple Endmember Spectral Mixture Analysis (MESMA) #' } #' #' @section Data Display: