ai.libs.jaicore.ml.tsc.classifier.shapelets

Class ShapeletTransformLearningAlgorithm

java.lang.Object

ai.libs.jaicore.basic.algorithm.AAlgorithm<TimeSeriesDataset,C>

ai.libs.jaicore.ml.tsc.classifier.ASimplifiedTSCLearningAlgorithm<java.lang.Integer,ShapeletTransformTSClassifier>

ai.libs.jaicore.ml.tsc.classifier.shapelets.ShapeletTransformLearningAlgorithm

All Implemented Interfaces:

ai.libs.jaicore.basic.algorithm.IAlgorithm<TimeSeriesDataset,ShapeletTransformTSClassifier>, ai.libs.jaicore.basic.Cancelable, ai.libs.jaicore.basic.ILoggingCustomizable, java.lang.Iterable<ai.libs.jaicore.basic.algorithm.events.AlgorithmEvent>, java.util.concurrent.Callable<ShapeletTransformTSClassifier>, java.util.Iterator<ai.libs.jaicore.basic.algorithm.events.AlgorithmEvent>

public class ShapeletTransformLearningAlgorithm
extends ASimplifiedTSCLearningAlgorithm<java.lang.Integer,ShapeletTransformTSClassifier>

Algorithm training a ShapeletTransform classifier as described in Jason Lines, Luke M. Davis, Jon Hills, and Anthony Bagnall. 2012. A shapelet transform for time series classification. In Proceedings of the 18th ACM SIGKDD international conference on Knowledge discovery and data mining (KDD '12). ACM, New York, NY, USA, 289-297.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShapeletTransformLearningAlgorithm.IShapeletTransformLearningAlgorithmConfig

Constructor Summary

Constructors

Constructor and Description
ShapeletTransformLearningAlgorithm(ShapeletTransformLearningAlgorithm.IShapeletTransformLearningAlgorithmConfig config, ShapeletTransformTSClassifier classifier, TimeSeriesDataset dataset, IQualityMeasure qualityMeasure) Constructs a training algorithm for the ShapeletTransformTSClassifier classifier specified by the given parameters.

Method Summary

Modifier and Type	Method and Description
ShapeletTransformTSClassifier	call() Training procedure for ShapeletTransformTSClassifier using the training algorithm described in the paper.
java.util.List<Shapelet>	clusterShapelets(java.util.List<Shapelet> shapelets, int noClusters, long beginTime) Clusters the given shapelets into noClusters clusters (cf. algorithm 6 of the original paper).
java.util.List<java.lang.Double>	findDistances(Shapelet s, double[][] matrix) Function finding the minimum single squared Euclidean distance for each instance among all of its subsequences compared to the shapelet s.
static java.util.Set<Shapelet>	generateCandidates(double[] data, int l, int candidateIndex) Function generation shapelet candidates for a given instance vector data, the length l and the candidate index which is used to identify the source of the shapelet's data.
ShapeletTransformLearningAlgorithm.IShapeletTransformLearningAlgorithmConfig	getConfig()
AMinimumDistanceSearchStrategy	getMinDistanceSearchStrategy() Getter for minDistanceSearchStrategy.
static java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>>	merge(int k, java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> kShapelets, java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> shapelets) Function merging shapelet lists based on their quality scores.
ai.libs.jaicore.basic.algorithm.events.AlgorithmEvent	nextWithException()
void	registerListener(java.lang.Object listener)
static java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>>	removeSelfSimilar(java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> shapelets) Function removing self-similar shapelets from a list storing shapelet and their quality entries.
void	setMinDistanceSearchStrategy(AMinimumDistanceSearchStrategy minDistanceSearchStrategy) Setter for minDistanceSearchStrategy.
static double[]	shapeletTransform(double[] instance, java.util.List<Shapelet> shapelets, AMinimumDistanceSearchStrategy searchStrategy) Function transforming the given instance into the new feature space spanned by the shapelets.
static TimeSeriesDataset	shapeletTransform(TimeSeriesDataset dataSet, java.util.List<Shapelet> shapelets, ai.libs.jaicore.basic.TimeOut timeout, long beginTime, AMinimumDistanceSearchStrategy searchStrategy) Performs a shapelet transform on a complete dataSet.

Methods inherited from class ai.libs.jaicore.ml.tsc.classifier.ASimplifiedTSCLearningAlgorithm

cancel, getClassifier, hasNext, iterator, next

Methods inherited from class ai.libs.jaicore.basic.algorithm.AAlgorithm

activate, announceTimeoutDetected, avoidReinterruptionOnShutdownOnCurrentThread, checkAndConductTermination, checkTermination, computeTimeoutAware, getActivationTime, getId, getInput, getLoggerName, getNumCPUs, getRemainingTimeToDeadline, getState, getTimeout, getTimeoutPrecautionOffset, hasThreadBeenInterruptedDuringShutdown, interruptThreadAsPartOfShutdown, isCanceled, isShutdownInitialized, isStopCriterionSatisfied, isTimeouted, post, registerActiveThread, resolveShutdownInterruptOnCurrentThread, setConfig, setLoggerName, setMaxNumThreads, setNumCPUs, setState, setTimeout, setTimeout, setTimeoutPrecautionOffset, shutdown, terminate, unregisterActiveThread, unregisterThreadAndShutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

ShapeletTransformLearningAlgorithm

public ShapeletTransformLearningAlgorithm(ShapeletTransformLearningAlgorithm.IShapeletTransformLearningAlgorithmConfig config,
                                          ShapeletTransformTSClassifier classifier,
                                          TimeSeriesDataset dataset,
                                          IQualityMeasure qualityMeasure)

Constructs a training algorithm for the ShapeletTransformTSClassifier classifier specified by the given parameters.

Parameters:

qualityMeasure - Quality measure used to assess the shapelets

Method Detail

call

public ShapeletTransformTSClassifier call()
                                   throws ai.libs.jaicore.basic.algorithm.exceptions.AlgorithmException,
                                          java.lang.InterruptedException

Training procedure for ShapeletTransformTSClassifier using the training algorithm described in the paper.

Returns:

Returns the trained model

Throws:

ai.libs.jaicore.basic.algorithm.exceptions.AlgorithmException - Thrown if the training could not be finished

java.lang.InterruptedException

clusterShapelets

public java.util.List<Shapelet> clusterShapelets(java.util.List<Shapelet> shapelets,
                                                 int noClusters,
                                                 long beginTime)
                                          throws java.lang.InterruptedException

Clusters the given shapelets into noClusters clusters (cf. algorithm 6 of the original paper).

Parameters:

shapelets - Shapelets to be clustered.

noClusters - Number of clusters to be used, i. e. the size of the output list

beginTime - Begin time of the training execution used for the timeout checks

Returns:

Returns the clustered shapelets

Throws:

java.lang.InterruptedException - Thrown when a timeout occurred

merge

public static java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> merge(int k,
                                                                                   java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> kShapelets,
                                                                                   java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> shapelets)

Function merging shapelet lists based on their quality scores. Only the k best shapelets of the union of both lists are retained.

Parameters:

k - Number of elements to be retained

kShapelets - The previous best shapelets

shapelets - The new shapelets to be added to the top-k list

Returns:

Returns the list containing the k best shapelets only

removeSelfSimilar

public static java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> removeSelfSimilar(java.util.List<java.util.Map.Entry<Shapelet,java.lang.Double>> shapelets)

Function removing self-similar shapelets from a list storing shapelet and their quality entries. See isSelfSimilar(Shapelet, Shapelet).

Parameters:

shapelets - Shapelets to be compared

Returns:

A sublist from the given shapelets list which does not contain any self-similar shapelets

findDistances

public java.util.List<java.lang.Double> findDistances(Shapelet s,
                                                      double[][] matrix)

Function finding the minimum single squared Euclidean distance for each instance among all of its subsequences compared to the shapelet s.

Parameters:

s - Shapelet which is compared to the instances

matrix - Matrix storing the data instance vectors

Returns:

Returns the list of all minimum distances of the shapelet and all the instances

generateCandidates

public static java.util.Set<Shapelet> generateCandidates(double[] data,
                                                         int l,
                                                         int candidateIndex)

Function generation shapelet candidates for a given instance vector data, the length l and the candidate index which is used to identify the source of the shapelet's data.

Parameters:

data - Data vector from which the values are extracted

l - The length of the generated candidate shapelet

candidateIndex - Instance index which is used to identify the generated shapelets

Returns:

Returns a set of shapelet candidates with the length l

shapeletTransform

public static TimeSeriesDataset shapeletTransform(TimeSeriesDataset dataSet,
                                                  java.util.List<Shapelet> shapelets,
                                                  ai.libs.jaicore.basic.TimeOut timeout,
                                                  long beginTime,
                                                  AMinimumDistanceSearchStrategy searchStrategy)
                                           throws java.lang.InterruptedException

Performs a shapelet transform on a complete dataSet. See ShapeletTransformLearningAlgorithm#shapeletTransform(double[], List).

Parameters:

dataSet - Data set to be transformed

shapelets - Shapelets used as new feature dimensions

timeout - Timeout compared to the current time difference to the beginTime

beginTime - System time in ms when the training algorithm has started

searchStrategy - Search strategy used to find the minimum distance from a shapelet to the time series

Returns:

Returns the transformed data set

Throws:

java.lang.InterruptedException - Thrown if there was a timeout

shapeletTransform

public static double[] shapeletTransform(double[] instance,
                                         java.util.List<Shapelet> shapelets,
                                         AMinimumDistanceSearchStrategy searchStrategy)

Function transforming the given instance into the new feature space spanned by the shapelets. Uses the minimum squared Euclidean distance of the corresponding shapelets to the instance as feature values.

Parameters:

instance - The instance to be transformed

shapelets - The shapelets to be used as new feature dimensions

searchStrategy - Search strategy used to find the minimum distance from a shapelet to the time series

Returns:

Returns the transformed instance feature vector

getMinDistanceSearchStrategy

public AMinimumDistanceSearchStrategy getMinDistanceSearchStrategy()

Getter for minDistanceSearchStrategy.

Returns:

the minDistanceSearchStrategy

setMinDistanceSearchStrategy

public void setMinDistanceSearchStrategy(AMinimumDistanceSearchStrategy minDistanceSearchStrategy)

Setter for minDistanceSearchStrategy.

Parameters:

minDistanceSearchStrategy - the minDistanceSearchStrategy to set

registerListener

public void registerListener(java.lang.Object listener)

Specified by:

registerListener in interface ai.libs.jaicore.basic.algorithm.IAlgorithm<TimeSeriesDataset,ShapeletTransformTSClassifier>

Overrides:

registerListener in class ASimplifiedTSCLearningAlgorithm<java.lang.Integer,ShapeletTransformTSClassifier>

nextWithException

public ai.libs.jaicore.basic.algorithm.events.AlgorithmEvent nextWithException()

Specified by:

nextWithException in interface ai.libs.jaicore.basic.algorithm.IAlgorithm<TimeSeriesDataset,ShapeletTransformTSClassifier>

Overrides:

nextWithException in class ASimplifiedTSCLearningAlgorithm<java.lang.Integer,ShapeletTransformTSClassifier>

getConfig

public ShapeletTransformLearningAlgorithm.IShapeletTransformLearningAlgorithmConfig getConfig()

Specified by:

getConfig in interface ai.libs.jaicore.basic.algorithm.IAlgorithm<TimeSeriesDataset,ShapeletTransformTSClassifier>

Overrides:

getConfig in class ai.libs.jaicore.basic.algorithm.AAlgorithm<TimeSeriesDataset,ShapeletTransformTSClassifier>