de.lmu.ifi.dbs.elki.algorithm.clustering.meta

Class ExternalClustering

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<Clustering<? extends Model>>

de.lmu.ifi.dbs.elki.algorithm.clustering.meta.ExternalClustering

All Implemented Interfaces:

Algorithm, ClusteringAlgorithm<Clustering<? extends Model>>

@Description(value="Load clustering results from an external file. Each line is expected to consists of one clustering, one integer per point and an (optional) non-numeric label.")
public class ExternalClustering
extends AbstractAlgorithm<Clustering<? extends Model>>
implements ClusteringAlgorithm<Clustering<? extends Model>>

Read an external clustering result from a file, such as produced by ClusteringVectorDumper.

The input format of this parser is text-based:

 # Optional comment
 1 1 1 2 2 2 -1 Example label
 

Where non-negative numbers are cluster assignments, negative numbers are considered noise clusters.

Since:

0.7.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalClustering.Parameterizer Parameterization class

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT The comment character.
private java.io.File	file The file to be reparsed.
private static Logging	LOG The logger for this class.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

ALGORITHM_ID

Constructor Summary

Constructors

Constructor and Description
ExternalClustering(java.io.File file) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	attachToRelation(Database database, Relation<?> r, it.unimi.dsi.fastutil.ints.IntArrayList assignment, java.util.ArrayList<java.lang.String> name) Build a clustering from the file result.
TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
protected Logging	getLogger() Get the (STATIC) logger for this class.
Clustering<? extends Model>	run(Database database) Run the algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

The logger for this class.

COMMENT

public static final java.lang.String COMMENT

The comment character.

See Also:

Constant Field Values

file

private java.io.File file

The file to be reparsed.

Constructor Detail

ExternalClustering

public ExternalClustering(java.io.File file)

Constructor.

Parameters:

file - File to load

Method Detail

run

public Clustering<? extends Model> run(Database database)

Run the algorithm.

Specified by:

run in interface Algorithm

Specified by:

run in interface ClusteringAlgorithm<Clustering<? extends Model>>

Overrides:

run in class AbstractAlgorithm<Clustering<? extends Model>>

Parameters:

database - Database to use

Returns:

Result

attachToRelation

private void attachToRelation(Database database,
                              Relation<?> r,
                              it.unimi.dsi.fastutil.ints.IntArrayList assignment,
                              java.util.ArrayList<java.lang.String> name)

Build a clustering from the file result.

Parameters:

database - Database

r - Result to attach to

assignment - Cluster assignment

name - Name

getLogger

protected Logging getLogger()

Description copied from class: AbstractAlgorithm

Get the (STATIC) logger for this class.

Specified by:

getLogger in class AbstractAlgorithm<Clustering<? extends Model>>

Returns:

the static logger

getInputTypeRestriction

public TypeInformation[] getInputTypeRestriction()

Description copied from class: AbstractAlgorithm

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

Specified by:

getInputTypeRestriction in interface Algorithm

Specified by:

getInputTypeRestriction in class AbstractAlgorithm<Clustering<? extends Model>>

Returns:

Type restriction