map_alpha_div.Rd 1.37 KB
Newer Older
jbferet's avatar
jbferet committed
1
2
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Lib_MapAlphaDiversity.R
3
4
\name{map_alpha_div}
\alias{map_alpha_div}
jbferet's avatar
jbferet committed
5
6
\title{maps alpha diversity indicators  based on prior selection of PCs}
\usage{
7
map_alpha_div(Input.Image.File, Output.Dir, Spatial.Unit,
jbferet's avatar
jbferet committed
8
9
10
11
12
  TypePCA = "SPCA", nbclusters = 50, MinSun = 0.25, pcelim = 0.02,
  Index.Alpha = "Shannon", FullRes = TRUE, LowRes = FALSE,
  MapSTD = FALSE, nbCPU = FALSE, MaxRAM = FALSE)
}
\arguments{
13
\item{Input.Image.File}{character. Path and name of the image to be processed.}
jbferet's avatar
jbferet committed
14

15
\item{Output.Dir}{character. Output directory.}
jbferet's avatar
jbferet committed
16

17
\item{Spatial.Unit}{numeric. Size of spatial units (in pixels) to compute diversity.}
jbferet's avatar
jbferet committed
18

19
\item{TypePCA}{character. Type of PCA (PCA, SPCA, NLPCA...).}
jbferet's avatar
jbferet committed
20

21
\item{nbclusters}{numeric. Number of clusters defined in k-Means.}
jbferet's avatar
jbferet committed
22

23
\item{MinSun}{numeric. Minimum proportion of sunlit pixels required to consider plot.}
jbferet's avatar
jbferet committed
24

25
\item{pcelim}{numeric. Minimum contribution (in \%) required for a spectral species.}
jbferet's avatar
jbferet committed
26

27
28
29
30
31
32
33
34
35
\item{Index.Alpha}{character. Either 'Shannon', 'Simpson' or 'Fisher'.}

\item{FullRes}{boolean. Full resolution.}

\item{LowRes}{boolean. Low resolution.}

\item{nbCPU}{numeric. Number of CPUs to use in parallel.}

\item{MaxRAM}{numeric. MaxRAM maximum size of chunk in GB to limit RAM allocation when reading image file.}
jbferet's avatar
jbferet committed
36
37
38
39
}
\description{
maps alpha diversity indicators  based on prior selection of PCs
}