de.lmu.ifi.dbs.elki.result

Class ClusteringVectorDumper

java.lang.Object

de.lmu.ifi.dbs.elki.result.ClusteringVectorDumper

All Implemented Interfaces:

ResultHandler, ResultProcessor

public class ClusteringVectorDumper
extends Object
implements ResultHandler

Class to output a clustering result in a simple and compact ascii format: whitespace separated cluster indexes

This format can be read using ClusteringVectorParser for meta analysis, or read as clustering using ExternalClustering.

Author:

Erich Schubert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	append Always append to the output file.
private String	forceLabel Optional label to force for this output.
private static Logging	LOG Class logger.
private File	outputFile Output file.

Constructor Summary

Constructors

Constructor and Description
ClusteringVectorDumper(File outputFile, boolean append) Constructor.
ClusteringVectorDumper(File outputFile, boolean append, String forceLabel) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dumpClusteringOutput(PrintStream writer, ResultHierarchy hierarchy, Clustering<?> c) Dump a single clustering result.
void	processNewResult(ResultHierarchy hier, Result newResult) Process a result.

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

Class logger.

outputFile

private File outputFile

Output file.

forceLabel

private String forceLabel

Optional label to force for this output.

append

private boolean append

Always append to the output file.

Constructor Detail

ClusteringVectorDumper

public ClusteringVectorDumper(File outputFile,
                      boolean append,
                      String forceLabel)

Constructor.

Parameters:

outputFile - Output file

append - Append to output file (overwrite otherwise).

forceLabel - Forced label to use for the output, may be null.

ClusteringVectorDumper

public ClusteringVectorDumper(File outputFile,
                      boolean append)

Constructor.

Parameters:

outputFile - Output file

append - Append to output file (overwrite otherwise).

Method Detail

processNewResult

public void processNewResult(ResultHierarchy hier,
                    Result newResult)

Description copied from interface: ResultProcessor

Process a result.

Specified by:

processNewResult in interface ResultProcessor

Parameters:

hier - The base of the result tree.

newResult - Newly added result subtree.

dumpClusteringOutput

protected void dumpClusteringOutput(PrintStream writer,
                        ResultHierarchy hierarchy,
                        Clustering<?> c)

Dump a single clustering result.

Parameters:

writer - Output writer

hierarchy - Cluster hierarchy to process

c - Clustering result