find_discord: Search for Discord

In tsmp: Time Series with Matrix Profile

Search for Discord

Description

Search for Discord

Usage

find_discord(.mp, ...)

## S3 method for class 'MatrixProfile'
find_discord(
  .mp,
  data,
  n_discords = 1,
  n_neighbors = 3,
  radius = 3,
  exclusion_zone = NULL,
  ...
)

## S3 method for class 'PMP'
find_discord(
  .mp,
  data,
  n_discords = 1,
  n_neighbors = 3,
  radius = 3,
  exclusion_zone = NULL,
  ...
)

Arguments

.mp	a MatrixProfile object.
...	further arguments to be passed to class specific function.
data	the data used to build the Matrix Profile, if not embedded.
n_discords	an int. Number of discords to find. (Default is 1).
n_neighbors	an int. Number of neighbors to find. (Default is 3).
radius	an int. Set a threshold to exclude matching neighbors with distance > current discord distance * radius. (Default is 3).
exclusion_zone	if a number will be used instead of embedded value. (Default is NULL).

Value

For class MatrixProfile, returns the input .mp object with a new name discord. It contains: discord_idx, a vector of discords found

For class PMP, returns the input .mp object with a new name discord. It contains: discord_idx, a vector of discords found

Examples

# Single dimension data
w <- 50
data <- mp_gait_data
mp <- tsmp(data, window_size = w, exclusion_zone = 1 / 4, verbose = 0)
mp <- find_discord(mp)
pan <- tsmp(mp_gait_data, window_size = 20:30, mode = "pmp")
mp <- find_discord(pan)

tsmp documentation built on Aug. 21, 2022, 1:13 a.m.