An HDBSCAN* cluster, which will have a birth level, death level, stability, and constraint satisfaction once fully constructed.
Cluster
01 Syntax
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| .ctor | 1 | Creates a new Cluster. |
| DetachPoints | 1 | Removes the specified number of points from this cluster at the given edge level, which will update the stability of this cluster and potentially cause cluster death. |
| Propagate | 1 | This cluster will propagate itself to its parent if its number of satisfied constraints is higher than the number of propagated constraints. |
| ReleaseVirtualChildCluster | 1 | Sets the virtual child cluster to null, thereby saving memory. |
| AddPointsToVirtualChildCluster | 1 | |
| VirtualChildClusterConstraintsPoint | 1 | |
| AddVirtualChildConstraintsSatisfied | 1 | |
| AddConstraintsSatisfied | 1 |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| PropagatedDescendants | 1 | |
| PropagatedLowestChildDeathLevel | 1 | |
| Parent | 1 | |
| Stability | 1 | |
| HasChildren | 1 | |
| Label | 1 | |
| HierarchyPosition | 1 |
04 Members
Creates a new Cluster.
| Name | Type | Description |
|---|---|---|
label | Int32 | The cluster label, which should be globally unique |
parent | Cluster | The cluster which split to create this cluster |
birthLevel | Double | The MST edge level at which this cluster first appeared |
numPoints | Int32 | The initial number of points in this cluster |
Int32, Double)Removes the specified number of points from this cluster at the given edge level, which will update the stability of this cluster and potentially cause cluster death. If cluster death occurs, the number of constraints satisfied by the virtual child cluster will also be calculated.
| Name | Type | Description |
|---|---|---|
numPoints | Int32 | The number of points to remove from the cluster |
level | Double | The MST edge level at which to remove these points |
This cluster will propagate itself to its parent if its number of satisfied constraints is higher than the number of propagated constraints. Otherwise, this cluster propagates its propagated descendants. In the case of ties, stability is examined. Additionally, this cluster propagates the lowest death level of any of its descendants to its parent.
Sets the virtual child cluster to null, thereby saving memory. Only call this method after computing the number of constraints satisfied by the virtual child cluster.
SortedSet(Of Int32))Int32)Int32)Int32)