Package elki.outlier.trivial

Class ByLabelOutlier

java.lang.Object

elki.outlier.trivial.ByLabelOutlier

All Implemented Interfaces:

Algorithm, OutlierAlgorithm

@Priority(-100)
public class ByLabelOutlier
extends java.lang.Object
implements OutlierAlgorithm

Trivial algorithm that marks outliers by their label. Can be used as reference algorithm in comparisons.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ByLabelOutlier.Par	Parameterization class.

Nested classes/interfaces inherited from interface elki.Algorithm

Algorithm.Utils

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_PATTERN	The default pattern to use.
(package private) java.util.regex.Pattern	pattern	The pattern we match with.

Constructor Summary

Constructors

Constructor	Description
ByLabelOutlier()	Constructor.
ByLabelOutlier(java.util.regex.Pattern pattern)	Constructor.

Method Summary

Modifier and Type	Method	Description
OutlierResult	autorun(Database database)	Try to auto-run the algorithm on a database by calling a method called run, with an optional Database first, and with data relations as specified by Algorithm.getInputTypeRestriction().
TypeInformation[]	getInputTypeRestriction()	Get the input type restriction used for negotiating the data query.
OutlierResult	run(Relation<?> relation)	Run the algorithm

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PATTERN

public static final java.lang.String DEFAULT_PATTERN

The default pattern to use.

See Also:

Constant Field Values

pattern

final java.util.regex.Pattern pattern

The pattern we match with.

Constructor Detail

ByLabelOutlier

public ByLabelOutlier(java.util.regex.Pattern pattern)

Constructor.

Parameters:

pattern - Pattern to match with.

ByLabelOutlier

public ByLabelOutlier()

Constructor.

Method Detail

getInputTypeRestriction

public TypeInformation[] getInputTypeRestriction()

Description copied from interface: Algorithm

Get the input type restriction used for negotiating the data query.

Specified by:

getInputTypeRestriction in interface Algorithm

Returns:

Type restriction

autorun

public OutlierResult autorun(Database database)

Description copied from interface: Algorithm

Try to auto-run the algorithm on a database by calling a method called run, with an optional Database first, and with data relations as specified by Algorithm.getInputTypeRestriction().

Specified by:

autorun in interface Algorithm

Specified by:

autorun in interface OutlierAlgorithm

Parameters:

database - the database to run the algorithm on

Returns:

the Result computed by this algorithm

run

public OutlierResult run(Relation<?> relation)

Run the algorithm

Parameters:

relation - Relation to process.

Returns:

Result