oracle.dmt.odm.settings.algorithm
Class OClusterAlgorithmSettings

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.settings.algorithm.MiningAlgorithmSettings
              |
              +--oracle.dmt.odm.settings.algorithm.ClusteringAlgorithmSettings
                    |
                    +--oracle.dmt.odm.settings.algorithm.OClusterAlgorithmSettings

All Implemented Interfaces:

java.io.Serializable

public class OClusterAlgorithmSettings

extends ClusteringAlgorithmSettings

An instance of OClusterAlgorithmSettings holds metadata about settings that are required in the O-Cluster algorithm. The O-Cluster algorithm creates a hierarchical grid-based clustering model. The resulting clusters define dense areas in the attribute space. The clusters are described by intervals along the attribute axes and the corresponding centroids and histograms. A parameter called sensitivity defines a baseline density level. Only areas with peak density above this baseline level can be identified as clusters.

Since:

9.2.0

See Also:

Serialized Form

Constructor Summary

OClusterAlgorithmSettings()
Creates an OClusterAlgorithmSettings object with the the parameter sensitivity set to its default value.

OClusterAlgorithmSettings(float sensitivity)
Creates an OClusterAlgorithmSettings object with the the parameter sensitivity set to the value of the argument.

Method Summary

float	getSensitivity() Returns the sensitivity specified in the OCluster algorithm settings.
void	setSensitivity(float sensitivity) Sets the value of the sensitivity parameter.

Methods inherited from class oracle.dmt.odm.settings.algorithm.MiningAlgorithmSettings

getMiningAlgorithm, getMiningAlgorithmName

Methods inherited from class java.lang.Object

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

Constructor Detail

OClusterAlgorithmSettings

public OClusterAlgorithmSettings(float sensitivity)
                          throws InvalidArgumentException

Creates an OClusterAlgorithmSettings object with the the parameter sensitivity set to the value of the argument. The sensitivity parameter is used to compute a baseline density level. Only regions where the density exceeds this baseline level can be identified by the algorithm as clusters.

Parameters:

sensitivity - Parameter in the range [0,1]. Recommended value: 0.5. Increasing the sensitivity may result in the creation of additional clusters, which may result in longer build times.

Throws:

InvalidArgumentException - when sensitivity > 1 or sensitivity < 0.

OClusterAlgorithmSettings

public OClusterAlgorithmSettings()

Creates an OClusterAlgorithmSettings object with the the parameter sensitivity set to its default value. The sensitivity parameter is used to compute a baseline density level. Only regions where the density exceeds this baseline level can be identified by the algorithm as clusters.

Method Detail

getSensitivity

public float getSensitivity()

Returns the sensitivity specified in the OCluster algorithm settings.

Returns:

sensitivity parameter value

setSensitivity

public void setSensitivity(float sensitivity)
                    throws InvalidArgumentException

Sets the value of the sensitivity parameter.

Parameters:

sensitivity - Parameter in the range [0,1] Recommended value: 0.5

Throws:

InvalidArgumentException - when sensitivity > 1 or sensitivity < 0.