HierarchicalClusteringResult Class

Spotfire 14.3 API Reference
ClusteringResult holds information how leaves and clusters are joined and on what height they are joined. The class also contains an index order how to sort the leaves to draw a dendrogram without crosssing. (The clustering information is in a format similar to the clustering result from hclust function in S-PLUS.)
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Data.Computations.ClusteringHierarchicalClusteringResult

Namespace:  Spotfire.Dxp.Data.Computations.Clustering
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
[SerializableAttribute]
[ImmutableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class HierarchicalClusteringResult : ISerializable

The HierarchicalClusteringResult type exposes the following members.

Properties

  NameDescription
Public propertyHeight
Gets the similarity/distance of the clusters joined in Merge1 and Merge2.
Public propertyMerge1
Gets the first merge column. Merge1[n] holds the index representing the first cluster/leaf to join at level n. Merge1 and Merge2 hold information about which clusters are joined and in what order they are joined. Negative values refer to leaves (1-based indexing of the input), positive values refer to clusters joined at lower level (1-based indexing of merge1 and merge2).

Observe that PageableList indexing is zero-base but the information in Merge1 and Merge2 is 1-based.

Public propertyMerge2
Gets the second merge column. Merge2[n] holds the index representing the second cluster/leaf to join at level n. Merge1 and Merge2 hold information about which clusters are joined and in what order they are joined. Negative values refer to leaves (1-based indexing of the input), positive values refer to clusters joined at lower level (1-based indexing of merge1 and merge2).

Observe that PageableList indexing is zero-base but the information in Merge1 and Merge2 is 1-based.

Public propertyOrder
Gets an index (1-based) ordering of the input so the dendrogram can be drawn without crossings.

Observe that PageableList indexing is zero-base but the information in order is 1-based.

Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodISerializableGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
Top
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference