magclass (version 4.107.0)

lowpass: Lowpass Filter

Description

Filters high frequencies out of a time series. The filter has the structure x'(n) = (x(n-1)+2*x(n)+x(n+1))/4

Usage

lowpass(x, i = 1, fix = NULL, altFilter = NULL, warn = TRUE)

Arguments

x

Vector of data points, that should be filtered or MAgPIE object

i

number of iterations the filter should be applied to the data

fix

Fixes the starting and/or ending data point. Default value is NULL which doesn't fix any point. Available options are: "start" for fixing the starting point, "end" for fixing the ending point and "both" for fixing both ends of the data.

altFilter

set special filter rule to indexes defined in this parameter. The special filter has the structure x'(n) = (2*x(n)+x(n+1))/3

warn

boolean deciding whether lowpass issues a warning for critical parameter choices or not

Value

The filtered data vector or MAgPIE object

Examples

# NOT RUN {
lowpass(c(1,2,11,3,4))
# to fix the starting point
lowpass(c(0,9,1,5,14,20,6,11,0), i=2, fix="start")

# }