de.lmu.ifi.dbs.elki.algorithm.result.clustering
Class HierarchicalAxesParallelCorrelationClusters<V extends RealVector<V,?>,D extends Distance<D>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.algorithm.result.AbstractResult<O>
          de.lmu.ifi.dbs.elki.algorithm.result.clustering.HierarchicalClusters<HierarchicalAxesParallelCorrelationCluster,V>
              de.lmu.ifi.dbs.elki.algorithm.result.clustering.HierarchicalAxesParallelCorrelationClusters<V,D>

Type Parameters:

V - the type of RealVector handled by this Result

D - the type of Distance used by this Result

All Implemented Interfaces:

Result<V>, Loggable

public class HierarchicalAxesParallelCorrelationClusters<V extends RealVector<V,?>,D extends Distance<D>>
extends HierarchicalClusters<HierarchicalAxesParallelCorrelationCluster,V>

Provides a result of a clustering algorithm that computes hierarchical axes parallel correlation clusters from a cluster order.

Author:

Elke Achtert

Field Summary

private ClusterOrder<V,D>	clusterOrder The cluster order.
static String	PREFERENCE_VECTOR Indicating the preference vector of a cluster in the string representation.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.result.clustering.HierarchicalClusters

CHILDREN, LEVEL, LEVEL_INDEX, PARENTS

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.result.AbstractResult

db, FILE_EXTENSION

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug

Fields inherited from interface de.lmu.ifi.dbs.elki.algorithm.result.Result

SEPARATOR

Constructor Summary

HierarchicalAxesParallelCorrelationClusters(List<HierarchicalAxesParallelCorrelationCluster> rootClusters, ClusterOrder<V,D> clusterOrder, Database<V> db)
Provides a result of a clustering algorithm that computes hierarchical axes parallel correlation clusters from a cluster order.

Method Summary

ClusterOrder<V,D>	getClusterOrder() Returns the cluster order.
void	output(File dir, Normalization<V> normalization, List<AttributeSettings> settings) Writes the clustering result to the given file.
void	output(PrintStream outStream, Normalization<V> normalization, List<AttributeSettings> settings) Writes the cluster order to the given stream.
protected void	writeHeader(PrintStream out, List<AttributeSettings> settings, List<String> headerInformation, HierarchicalAxesParallelCorrelationCluster cluster) Writes a header for the specified cluster providing information concerning the underlying database and the specified parameter-settings.

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.result.clustering.HierarchicalClusters

getRootClusters

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.result.AbstractResult

getDatabase, writeHeader

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning

Methods inherited from class java.lang.Object

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

Field Detail

PREFERENCE_VECTOR

public static String PREFERENCE_VECTOR

Indicating the preference vector of a cluster in the string representation.

clusterOrder

private ClusterOrder<V extends RealVector<V,?>,D extends Distance<D>> clusterOrder

The cluster order.

Constructor Detail

HierarchicalAxesParallelCorrelationClusters

public HierarchicalAxesParallelCorrelationClusters(List<HierarchicalAxesParallelCorrelationCluster> rootClusters,
                                                   ClusterOrder<V,D> clusterOrder,
                                                   Database<V> db)

Provides a result of a clustering algorithm that computes hierarchical axes parallel correlation clusters from a cluster order.

Parameters:

rootClusters - the root cluster

db - the database containing the objects of the clusters

clusterOrder - the cluster order

Method Detail

output

public void output(PrintStream outStream,
                   Normalization<V> normalization,
                   List<AttributeSettings> settings)
            throws UnableToComplyException

Description copied from class: HierarchicalClusters

Writes the cluster order to the given stream.

Specified by:

output in interface Result<V extends RealVector<V,?>>

Overrides:

output in class HierarchicalClusters<HierarchicalAxesParallelCorrelationCluster,V extends RealVector<V,?>>

Parameters:

outStream - the stream to write to

normalization - Normalization to restore original values according to, if this action is supported - may remain null.

settings - the settings to be written into the header, if this parameter is null, no header will be written

Throws:

UnableToComplyException - if any feature vector is not compatible with values initialized during normalization

See Also:

Result.output(java.io.PrintStream,de.lmu.ifi.dbs.elki.normalization.Normalization,java.util.List)

output

public void output(File dir,
                   Normalization<V> normalization,
                   List<AttributeSettings> settings)
            throws UnableToComplyException

Description copied from interface: Result

Writes the clustering result to the given file. Clustering result implementations, which are likely to provide several clusters are supposed to use the filename as prefix for every file to create and to append a proper suffix. In case of occuring IOExceptions the output is expected to be given at the standard-out. Therefore this behaviour should be also achievable by giving a null-Object as parameter.

Specified by:

output in interface Result<V extends RealVector<V,?>>

Overrides:

output in class HierarchicalClusters<HierarchicalAxesParallelCorrelationCluster,V extends RealVector<V,?>>

Parameters:

dir - file, which designates the location to write the results, or which's name designates the prefix of any locations to write the results, or which could remain null to designate the standard-out as location for output.

normalization - Normalization to restore original values according to, if this action is supported - may remain null.

settings - the settings to be written into the header, if this parameter is null, no header will be written

Throws:

UnableToComplyException - if any feature vector is not compatible with values initialized during normalization

See Also:

Result.output(java.io.File,de.lmu.ifi.dbs.elki.normalization.Normalization,java.util.List)

writeHeader

protected void writeHeader(PrintStream out,
                           List<AttributeSettings> settings,
                           List<String> headerInformation,
                           HierarchicalAxesParallelCorrelationCluster cluster)

Writes a header for the specified cluster providing information concerning the underlying database and the specified parameter-settings.

Overrides:

writeHeader in class HierarchicalClusters<HierarchicalAxesParallelCorrelationCluster,V extends RealVector<V,?>>

Parameters:

out - the print stream where to write

settings - the settings to be written into the header

headerInformation - additional information to be printed in the header, each entry will be printed in one separate line

cluster - the cluster to write the header for

getClusterOrder

public final ClusterOrder<V,D> getClusterOrder()

Returns the cluster order.

Returns:

the cluster order