perform_PCA: Performs PCA for all images and create PCA file with either...

View source: R/Lib_PerformPCA.R

perform_PCAR Documentation

Performs PCA for all images and create PCA file with either all or a selection of PCs

Description

Performs PCA for all images and create PCA file with either all or a selection of PCs

Usage

perform_PCA(
  Input_Image_File,
  Input_Mask_File,
  Output_Dir,
  Continuum_Removal = TRUE,
  TypePCA = "SPCA",
  NbPCs_To_Keep = 30,
  FilterPCA = FALSE,
  Excluded_WL = FALSE,
  nb_partitions = 20,
  nbCPU = 1,
  MaxRAM = 0.25
)

Arguments

Input_Image_File

character. Path of the image to be processed

Input_Mask_File

character. Path of the mask corresponding to the image

Output_Dir

character. Path for output directory

Continuum_Removal

boolean. Set to TRUE if continuum removal should be applied

TypePCA

character. Type of PCA: choose either "PCA" or "SPCA"

NbPCs_To_Keep

numeric. number of components to ke saved in the PCA file. default = 30 if set to FALSE (or nb PC if <30)

FilterPCA

boolean. Set to TRUE if 2nd filtering based on PCA is required

Excluded_WL

numeric. Water Vapor Absorption domains (in nanometers, min and max WL). Can also be used to exclude spectific domains. dims = N x 2 (N = number of domains to be eliminated)

nb_partitions

numeric. Number of repetitions to estimate diversity from the raster (averaging repetitions).

nbCPU

numeric. Number fo CPUs in use.

MaxRAM

numeric. Maximum size of chunk in GB to limit RAM allocation when reading image file.

Value

list of paths corresponding to resulting PCA files


jbferet/biodivMapR documentation built on April 25, 2024, 10:44 p.m.