de.lmu.ifi.dbs.elki.visualization.style

Class ClusterStylingPolicy

java.lang.Object

de.lmu.ifi.dbs.elki.visualization.style.ClusterStylingPolicy

All Implemented Interfaces:

ClassStylingPolicy, StylingPolicy, VisualizationItem

public class ClusterStylingPolicy
extends java.lang.Object
implements ClassStylingPolicy

Styling policy based on cluster membership.

Since:

0.5.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Clustering<?>	clustering Clustering in use.
(package private) it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap<Cluster<?>>	cmap Map from cluster objects to color offsets.
(package private) it.unimi.dsi.fastutil.ints.IntArrayList	colors Colors
(package private) java.util.ArrayList<DBIDs>	ids Object IDs

Constructor Summary

Constructors

Constructor and Description
ClusterStylingPolicy(Clustering<?> clustering, StyleLibrary style) Constructor.

Method Summary

Modifier and Type	Method and Description
int	classSize(int cnum) Get the number of elements in the styling class.
Clustering<?>	getClustering() Get the clustering used by this styling policy
int	getColorForDBID(DBIDRef id) Get the color for an individual object.
int	getMaxStyle() Get the maximum style in use.
java.lang.String	getMenuName() Name to display in the menu.
int	getMinStyle() Get the minimum style in use.
int	getStyleForCluster(Cluster<?> c) Get the style number for a cluster.
int	getStyleForDBID(DBIDRef id) Get the style number for a particular object
DBIDIter	iterateClass(int cnum) Iterate over all objects from a given class.

Methods inherited from class java.lang.Object

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

Field Detail

ids

java.util.ArrayList<DBIDs> ids

Object IDs

cmap

it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap<Cluster<?>> cmap

Map from cluster objects to color offsets.

colors

it.unimi.dsi.fastutil.ints.IntArrayList colors

Colors

clustering

Clustering<?> clustering

Clustering in use.

Constructor Detail

ClusterStylingPolicy

public ClusterStylingPolicy(Clustering<?> clustering,
                            StyleLibrary style)

Constructor.

Parameters:

clustering - Clustering to use.

Method Detail

getStyleForDBID

public int getStyleForDBID(DBIDRef id)

Description copied from interface: ClassStylingPolicy

Get the style number for a particular object

Specified by:

getStyleForDBID in interface ClassStylingPolicy

Parameters:

id - Object ID

Returns:

Style number

getColorForDBID

public int getColorForDBID(DBIDRef id)

Description copied from interface: StylingPolicy

Get the color for an individual object. Note: if possible, use a class styling policy which can optimize better.

Specified by:

getColorForDBID in interface StylingPolicy

Parameters:

id - Object ID

Returns:

Color value

getMinStyle

public int getMinStyle()

Description copied from interface: ClassStylingPolicy

Get the minimum style in use.

Specified by:

getMinStyle in interface ClassStylingPolicy

Returns:

Style number

getMaxStyle

public int getMaxStyle()

Description copied from interface: ClassStylingPolicy

Get the maximum style in use.

Specified by:

getMaxStyle in interface ClassStylingPolicy

Returns:

Style number

iterateClass

public DBIDIter iterateClass(int cnum)

Description copied from interface: ClassStylingPolicy

Iterate over all objects from a given class.

Specified by:

iterateClass in interface ClassStylingPolicy

Parameters:

cnum - Class number

Returns:

Iterator over object IDs

classSize

public int classSize(int cnum)

Description copied from interface: ClassStylingPolicy

Get the number of elements in the styling class.

Specified by:

classSize in interface ClassStylingPolicy

Parameters:

cnum - Class number

Returns:

Size of class.

getClustering

public Clustering<?> getClustering()

Get the clustering used by this styling policy

Returns:

Clustering in use

getStyleForCluster

public int getStyleForCluster(Cluster<?> c)

Get the style number for a cluster.

Parameters:

c - Cluster

Returns:

Style number

getMenuName

public java.lang.String getMenuName()

Description copied from interface: VisualizationItem

Name to display in the menu. May be null or empty string.

Specified by:

getMenuName in interface VisualizationItem

Returns:

Menu name.