VPR.BFAST: BFAST Breakpoint Detector

Description Usage Arguments Value Author(s) Examples

View source: R/VPR_BFAST.R

Description

takes the Complete VI and optimally accumulated Rainfall (and tmperature if included), calculates a lm between them And then performs a bfast.in the residuals. If BFAST.raw=TRUE, it will perform bfast on the Complete VI ts

Usage

1
2
3
4
5
6
7
8
VPR.BFAST(
  CTSR.VI,
  CTSR.RF,
  CTSR.TM = NULL,
  season = "none",
  BFAST.raw = FALSE,
  h = 0.15
)

Arguments

CTSR.VI

Complete Monthly Time Series of Vegetation Index values. An object of class 'ts' object without NA's.

CTSR.RF

Complete Time Series of Rainfall. An object of class 'ts' object without NA's and be the same length and cover the same time range as CTSR.VI. If ACP.table is provided, CTSR.RF will be automitaclly calculated using the ACP.calculator

CTSR.TM

Complete Time Series of temperature. An object of class 'ts' object without NA's and be the same length and cover the same time range as CTSR.VI. Default (CTSR.TM=NULL).

season

See bfast. This season value only applies to bfast done using the CTS VPR. if a non VPR adjusted BFAST is performed.a harmonic season is used.

BFAST.raw

Defualt = FALSE If TRUE will perform a BFAST (season="harmonic") on the CTSR.VI If FALSE will perform BFAST on the CTSR VPR residuals

h

See bfast, The.minimal segment size between potentially detected breaks in the trend model given as fraction relative to the sample size (i.e. the minimal number of observations in each segment divided by the total length of the timeseries. Default h = 0.15.

Value

List of objects:

bkps The index of the Breakpoints detected. If no breakpoints are detected, bkps = FASLE

BFAST.obj See bfast

CTS.lm the lm of CTSR.VI and CTSR.RF

BFAST.type the type of BFAST done (VPR residuals or on the VI timeseris itself)

Author(s)

Arden Burrell, arden.burrell@unsw.edu.au

Examples

1
2
3
4
## Not run: 
VPRBFdem <- VPR.BFAST(segVPRCTSR$cts.NDVI, segVPRCTSR$cts.precip)
print(VPRBFdem)
## End(Not run)

TSS.RESTREND documentation built on Aug. 3, 2020, 1:07 a.m.