LISp-Miner Control Language Reference, version: 27.09.01 of 21 Apr 2017

Class MCCluster

One found cluster as a result of MCluster-Miner data-mining task
inherits from LMWrap
namespace: lm.tasks.results

Constructor

No constructor available. Objects of this class could not be instantiated from Lua scripts.

Properties List

CenterVectorSize  Size of center-vector (same as the number of attributes used for clustering)
ClassCategory  the most frequent category in this cluster or nil if no class attribute has been provided in task setting
ClassFrequency  Number of objects belonging to the most frequent class or zero if no class attribute provided in task setting
ClusterIndex  Index of this cluster among clusters on the same level
ClusterLevel  Level of this cluster (for hierarchical clustering)
Frequency  Number of objects in this cluster
HypothesisMC  the HypothesisMC, this cluster belongs to
ID  Unique identifier (primary key) of the object
IntraDistanceAvg  Average intra-cluster distance
IntraDistanceMax  Maximal intra-cluster distance
IntraDistanceMin  Minimal intra-cluster distance
LeafFlag  Whether this cluster is a leaf (has no childrens)
LevelIndexString  Text representation of this cluster using levels and indexes
MCParentCluster  the parent cluster for this cluster or nil if this cluster is the top-most
TopMostFlag  Whether this cluster is the top most (has no parents)

Methods List

canDel () Returns true if the object could be deleted (is not used)
getCenterVector () Returns array of floats representing the center of this cluster. The size of the array is equal to number of attributes used for clustering in this hypothesis.
getCenterVectorSize () Returns size of vector of center values, the value of CenterVectorSize property
getClassCategory () Returns the most frequent category in this cluster or nil if no class attribute has been provided in task setting. the value of ClassCategory property
getHypothesisMC () Returns the HypothesisMC, the hypothesis this cluster belongs to, the value of HypothesisMC property
getID () Returns unique identifier (primary key) of the object
getMCParentCluster () Returns the parent cluster of this cluster (optional). the value of MCParentCluster property
onAdd () Store the newly created object into metabase
onDel () Delete the object from metabase (fails if canDel returns false)
onUpdate () Save changes made to the object into metabase

Properties

CenterVectorSize  (read-only) : integer
Size of center-vector (same as the number of attributes used for clustering)
ClassCategory  (read-only) : Category
the most frequent category in this cluster or nil if no class attribute has been provided in task setting
ClassFrequency  (read-only) : integer
Number of objects belonging to the most frequent class or zero if no class attribute provided in task setting
ClusterIndex  (read-only) : integer
Index of this cluster among clusters on the same level
ClusterLevel  (read-only) : integer
Level of this cluster (for hierarchical clustering)
Frequency  (read-only) : integer
Number of objects in this cluster
HypothesisMC  (read-only) : HypothesisMC
the HypothesisMC, this cluster belongs to
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
IntraDistanceAvg  (read-only) : float
Average intra-cluster distance
IntraDistanceMax  (read-only) : float
Maximal intra-cluster distance
IntraDistanceMin  (read-only) : float
Minimal intra-cluster distance
LeafFlag  (read-only) : boolean
Whether this cluster is a leaf (has no childrens)
LevelIndexString  (read-only) : string
Text representation of this cluster using levels and indexes
MCParentCluster  (read-only) : MCCluster
the parent cluster for this cluster or nil if this cluster is the top-most
TopMostFlag  (read-only) : boolean
Whether this cluster is the top most (has no parents)

Methods

canDel() : boolean
Returns true if the object could be deleted (is not used)
Intherited from: LMWrap

Returns

  • boolean
getCenterVector()
Returns array of floats representing the center of this cluster. The size of the array is equal to number of attributes used for clustering in this hypothesis.
getCenterVectorSize() : integer
Returns size of vector of center values, the value of CenterVectorSize property

Returns

  • integer
getClassCategory() : Category
Returns the most frequent category in this cluster or nil if no class attribute has been provided in task setting. the value of ClassCategory property

Returns

getHypothesisMC() : HypothesisMC
Returns the HypothesisMC, the hypothesis this cluster belongs to, the value of HypothesisMC property

Returns

getID() : integer
Returns unique identifier (primary key) of the object
Intherited from: LMWrap

Returns

  • integer
getMCParentCluster() : MCCluster
Returns the parent cluster of this cluster (optional). the value of MCParentCluster property

Returns

onAdd()
Store the newly created object into metabase
Intherited from: LMWrap
onDel()
Delete the object from metabase (fails if canDel returns false)
Intherited from: LMWrap
onUpdate()
Save changes made to the object into metabase
Intherited from: LMWrap