rtsa.scaleEOF: Scale EOF modes

Description Usage Arguments Value Author(s) See Also Examples

View source: R/rtsa.scaleEOF.R

Description

This function rescale resulting spatial modes generated from Empirical Orthogonal Function analysis (EOF) in the range between -1 and 1

Usage

1
rtsa.scaleEOF(x, cut = 1, method = "percentile")

Arguments

x

Input EOFstack-class object generated using rtsa.eof

cut

Numeric. Defines the percentile to be used to scale each EOFs. Default is set to 1 (1st and 99th percentiles)

method

Character. Method used to scale EOF modes. Only default "percentile" is supported

Value

Updates the 'eof' slot in the object of class EOFstack-class containing the following components:

eof Scaled EOF modes as RasterBrick object
expansion_coefficients EOF Expansion Coefficients (EC) as xts object
total_variance Numeric. Total variance of input raster time series
explained_variance Numeric vector. Percentage of variance explained by each EOF mode with respect to the total variance of input raster time series
center Center values from each pixel temporal profile as RasterLayer object (only computed if centered = TRUE)
scale Scale values from each pixel temporal profile as RasterLayer object (only computed if scaled = TRUE)

Author(s)

Federico Filipponi

See Also

rtsa.eof, eof

Examples

1
2
3
4
5
6
7
## Not run: 
## Scale EOF modes by clipping the distribution between 1st and 99th percentile
scaled_eof <- rtsa.scaleEOF(x=eof_result, cut=1)
## Scale EOF modes by clipping the distribution between 5th and 95th percentile
scaled_eof <- rtsa.scaleEOF(x=eof_result, cut=5)

## End(Not run)

ffilipponi/rtsa documentation built on Oct. 18, 2019, 12:37 a.m.