getHSAM {discharge}

High Spectral Anomaly Mangitude (HSAM)

Description

Compute High Spectral Anomaly Magnitude (HSAM) from the given residual values each year

Usage

getHSAM(resid, years, for.year = NULL)

Arguments

resid

A vector of residual values generated with respect to the baseline signal

years

A vector of years corrosponding to the residual values

for.year

(optional) Calculate HSAM values only for the given year in this argument. If argument is omitted, HSAM values for all years are calculated.

Value

Data frame containing four columns:

year	First column, represents year
HSAM	Second column, represents HSAM values
index.year	Third column, representing index of HSAM value in that year
index.all	Fourth column, representing index of HSAM value in the input resid

Examples

# load sample data
data("sycamore")
x = sycamore

# get streamflow object for the sample data
x.streamflow = asStreamflow(x)

# prepare baseline signal 
x.bl = prepareBaseline(x.streamflow)

# HSAM
hsam = getHSAM(x.bl$resid.sig, x.streamflow$data$year)