ucrdtw_ff: UCR DTW Algorithm file-file method
In rucrdtw: R Bindings for the UCR Suite

ucrdtw_ff

R Documentation

UCR DTW Algorithm file-file method

Description

Sliding-window similarity search using DTW distance. This implementation is very close to the UCR Suite command line utility, in that it takes files as inputs for both query and data

Usage

ucrdtw_ff(data, query, qlength, dtwwindow)

Arguments

`data`	character; path to data file
`query`	character; path to query file
`qlength`	integer; length of the query (number of data points), usually this should be equivalent to length(query), but it can be shorter.
`dtwwindow`	double; Size of the warping window size (as a proportion of query length). The DTW calculation in 'rucrdtw' uses a symmetric Sakoe-Chiba band. See Giorgino (2009) for a general coverage of warping window constraints.

Value

a ucrdtw object. A list with the following elements

location: The starting location of the nearest neighbor of the given query, of size length(query), in the data. Note that location starts from 1.
distance: The DTW distance between the nearest neighbor and the query.
prunedKim: Percentage of subsequences that were pruned based on the LB-Kim criterion.
prunedKeogh: Percentage of subsequences that were pruned based on the LB-Keogh-EQ criterion.
prunedKeogh2: Percentage of subsequences that were pruned based on the LB-Keogh-EC criterion.
dtwCalc: Percentage of subsequences for which the full DTW distance was calculated.

For an explanation of the pruning criteria see Rakthanmanon et al. (2012).

References

Rakthanmanon, Thanawin, Bilson Campana, Abdullah Mueen, Gustavo Batista, Brandon Westover, Qiang Zhu, Jesin Zakaria, and Eamonn Keogh. 2012. Searching and Mining Trillions of Time Series Subsequences Under Dynamic Time Warping. In Proceedings of the 18th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining, 262-70. ACM. doi:\Sexpr[results=rd]{tools:::Rd_expr_doi("10.1145/2339530.2339576")}.

Giorgino, Toni (2009). Computing and Visualizing Dynamic Time Warping Alignments in R: The dtw Package. Journal of Statistical Software, 31(7), 1-24, doi:\Sexpr[results=rd]{tools:::Rd_expr_doi("10.18637/jss.v031.i07")}.

Examples

#locate example data file
dataf <- system.file("extdata/col_sc.txt", package="rucrdtw")
#locate example query file
queryf <- system.file("extdata/mid_sc.txt", package="rucrdtw")
#determine length of query file
qlength <- length(scan(queryf))
#run query
ucrdtw_ff(dataf, queryf, qlength, 0.05)

rucrdtw documentation built on Aug. 24, 2023, 5:06 p.m.