Packageflare.analytics.cluster
Classpublic class CommunityStructure
InheritanceCommunityStructure Inheritance HierarchicalCluster Inheritance Operator

Hierarchically clusters a network based on inferred community structure. The result is a cluster tree in which each merge is chosen so as to maximize within-cluster linkage while minimizing between-cluster linkage. This class uses Newman's fast algorithm for detecting community structure. Optionally allows clients to provide an edge weight function indicating the strength of ties within the network.



Public Properties
 PropertyDefined by
 InheritedclusterField : String
The property in which to store cluster indices.
HierarchicalCluster
 InheritedclusterTree : Tree
The cluster tree of detected community structures.
HierarchicalCluster
 Inheritedcriteria : Array
Computed criterion values for each merge in the cluster tree.
HierarchicalCluster
  edgeWeights : Function = null
A function defining edge weights in the graph.
CommunityStructure
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
Operator
 Inheritedgroup : String
The data group to cluster.
HierarchicalCluster
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
 InheritedsequenceField : String
The property in which to store sequence indices.
HierarchicalCluster
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Public Methods
 MethodDefined by
  
Creates a new community structure instance
CommunityStructure
 Inherited
applyParameters(op:IOperator, params:Object):void
[static] Static method that applies parameter settings to an operator.
Operator
  
calculate(list:DataList, w:Function = null):void
Calculates the community structure clustering.
CommunityStructure
 Inherited
labelNodes(merge:int = -1):void
Labels nodes with their cluster membership, determined by the given merge number.
HierarchicalCluster
  
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
CommunityStructure
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
Operator
Property detail
edgeWeightsproperty
public var edgeWeights:Function = null

A function defining edge weights in the graph.

Constructor detail
CommunityStructure()constructor
public function CommunityStructure()

Creates a new community structure instance

Method detail
calculate()method
public function calculate(list:DataList, w:Function = null):void

Calculates the community structure clustering. As a result of this method, a cluster tree will be computed and graph nodes will be annotated with both community and sequence indices.

Parameters
list:DataList — the data list to cluster
 
w:Function (default = null) — an edge weighting function. If null, each edge will be given weight one.
operate()method 
public override function operate(t:Transitioner = null):void

Performs an operation over the contents of a visualization.

Parameters
t:Transitioner (default = null) — a Transitioner instance for collecting value updates.