OpenWalnut  1.4.0
Public Types | Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Attributes
WDataSetHierarchicalClustering Class Reference

Represents a hierarchy of clusters. More...

#include <WDataSetHierarchicalClustering.h>

+ Inheritance diagram for WDataSetHierarchicalClustering:

List of all members.

Public Types

typedef boost::shared_ptr
< WDataSetHierarchicalClustering
SPtr
 Pointer to dataset.
typedef boost::shared_ptr
< const
WDataSetHierarchicalClustering
ConstSPtr
 Pointer to const dataset.

Public Member Functions

 WDataSetHierarchicalClustering (WTreeNode::SPtr rootNode, std::map< size_t, WFiberCluster::SPtr > clusterMap)
 Constructs a hierarchical clustering dataset.
 WDataSetHierarchicalClustering ()
 Constructs a new set of tracts.
virtual ~WDataSetHierarchicalClustering ()
 Destructor.
virtual const std::string getName () const
 Gets the name of this prototype.
virtual const std::string getDescription () const
 Gets the description for this prototype.
WTreeNode::SPtr getRootNode ()
 Returns the root cluster.
std::map< size_t,
WFiberCluster::SPtr
getClusterMap ()
 Returns the whole cluster map.
std::vector< WTreeNode::SPtrgetClustersDownToLevel (WTreeNode::SPtr node, size_t level)
 Returns all clusters down (root node has highest level) to a certain level in the hierarchy.

Static Public Member Functions

static boost::shared_ptr
< WPrototyped
getPrototype ()
 Returns a prototype instantiated with the true type of the deriving class.

Static Protected Attributes

static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.

Private Attributes

WTreeNode::SPtr m_rootNode
 Pointer to the root cluster.
std::map< size_t,
WFiberCluster::SPtr
m_clusters
 Stores the cluster map.

Detailed Description

Represents a hierarchy of clusters.

Definition at line 44 of file WDataSetHierarchicalClustering.h.


Member Typedef Documentation

Pointer to const dataset.

Reimplemented from WDataSet.

Definition at line 56 of file WDataSetHierarchicalClustering.h.

Pointer to dataset.

Reimplemented from WDataSet.

Definition at line 51 of file WDataSetHierarchicalClustering.h.


Constructor & Destructor Documentation

Constructs a hierarchical clustering dataset.

Parameters:
rootNodethe root node of the WTreeNode-tree holding indices to the clusterMap
clusterMapa map of fiber clusters accessible via index

Definition at line 40 of file WDataSetHierarchicalClustering.cpp.

References m_clusters, and m_rootNode.

Constructs a new set of tracts.

The constructed instance is not usable but needed for prototype mechanism.

Definition at line 35 of file WDataSetHierarchicalClustering.cpp.

Referenced by getPrototype().

Destructor.

Definition at line 48 of file WDataSetHierarchicalClustering.cpp.


Member Function Documentation

Returns the whole cluster map.

Returns:
the whole cluster map

Definition at line 77 of file WDataSetHierarchicalClustering.cpp.

References m_clusters.

Returns all clusters down (root node has highest level) to a certain level in the hierarchy.

Parameters:
nodethe node used as a starting point for the recursive lookup
levelthe maximum level for a node to be selected
Returns:
the clusters down to a certain level in the hierarchy

Definition at line 83 of file WDataSetHierarchicalClustering.cpp.

const std::string WDataSetHierarchicalClustering::getDescription ( ) const [virtual]

Gets the description for this prototype.

Returns:
the description

Reimplemented from WDataSet.

Definition at line 67 of file WDataSetHierarchicalClustering.cpp.

const std::string WDataSetHierarchicalClustering::getName ( ) const [virtual]

Gets the name of this prototype.

Returns:
the name.

Reimplemented from WDataSet.

Definition at line 62 of file WDataSetHierarchicalClustering.cpp.

boost::shared_ptr< WPrototyped > WDataSetHierarchicalClustering::getPrototype ( ) [static]

Returns a prototype instantiated with the true type of the deriving class.

Returns:
the prototype.

Reimplemented from WDataSet.

Definition at line 53 of file WDataSetHierarchicalClustering.cpp.

References m_prototype, and WDataSetHierarchicalClustering().

Returns the root cluster.

Returns:
the root cluster

Definition at line 72 of file WDataSetHierarchicalClustering.cpp.

References m_rootNode.


Member Data Documentation

Stores the cluster map.

Definition at line 135 of file WDataSetHierarchicalClustering.h.

Referenced by getClusterMap(), and WDataSetHierarchicalClustering().

boost::shared_ptr< WPrototyped > WDataSetHierarchicalClustering::m_prototype = boost::shared_ptr< WPrototyped >() [static, protected]

The prototype as singleton.

Reimplemented from WDataSet.

Definition at line 124 of file WDataSetHierarchicalClustering.h.

Referenced by getPrototype().

Pointer to the root cluster.

Definition at line 130 of file WDataSetHierarchicalClustering.h.

Referenced by getRootNode(), and WDataSetHierarchicalClustering().


The documentation for this class was generated from the following files: