FunctionDescriptions.md

Implemented QC functions

Main documentation of the implemented functions, their purpose and parameters and their description.

Index

• Miscellaneous
  • range
  • seasonalRange
  • isolated
  • missing
  • clear
  • force
• Spike Detection
  • spikes_basic
  • spikes_simpleMad
  • spikes_slidingZscore
  • spikes_spektrumBased
• Constant Detection
  • constant
  • constants_varianceBased
• Break Detection
  • breaks_spektrumBased
• Time Series Harmonization
  • harmonize_shift2Grid
  • harmonize_aggregate2Grid
  • harmonize_linear2Grid
  • harmonize_interpolate2Grid
  • harmonize_downsample
  • harmonize
  • deharmonize
  • aggregations
• Soil Moisture
  • soilMoisture_plateaus
  • soilMoisture_spikes
  • soilMoisture_breaks
  • soilMoisture_byFrost
  • soilMoisture_byPrecipitation
• Machine Learning
  • machinelearning

Miscellaneous

range

range(min, max)

parameter	data type	default value	description
min	float		upper bound for valid values
max	float		lower bound for valid values

The function flags all values, that exceed the closed interval [min, max].

seasonalRange

sesonalRange(min, max, startmonth=1, endmonth=12, startday=1, endday=31)

parameter	data type	default value	description
min	float		upper bound for valid values
max	float		lower bound for valid values
startmonth	integer	1	interval start month
endmonth	integer	12	interval end month
startday	integer	1	interval start day
endday	integer	31	interval end day

The function does the same as range (flags all data, that exceed the interval [min, max]), but only, if the timestamp of the data-point lies in a time interval defined by day and month only. The year is not used by the interval calculation. The left interval boundary is defined by startmonth and startday, the right by endmonth and endday. Both boundaries are inclusive. If the left side occurs later in the year than the right side, the interval is extended over the change of year (e.g. an interval of [01/12, 01/03], will flag values in december, january and february).

Note: Only works for datetime indexed data

isolated

isolated(window, group_size=1, continuation_range='1min') 

parameter	data type	default value	description
window	offset string		The range, within there are no valid values allowed for a valuegroup to get flagged isolated. See condition (1) and (2).
group_size	integer	1	The upper bound for the size of a value group to be considered an isolated group. See condition (3).
continuation_range	offset string	"1min"	The upper bound for the temporal extension of a value group to be considered an isolated group. See condition (4). Only relevant if group_size > 1.

The function flags isolated values / value groups. Isolated values are values / value groups, that, in a range of window, are surrounded either by already flagged or missing values only.

The function defaults to flag isolated single values only. But the parameters allow for detections of more complex isolation definitions, including groups of isolated values.

A continuous group of timeseries values x_{k}, x_{k+1},...,x_{k+n} is considered to be "isolated", if: