OpenWalnut  1.4.0
Public Types | Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Attributes | List of all members
WDataSetHierarchicalClustering Class Reference

Represents a hierarchy of clusters. More...

#include <WDataSetHierarchicalClustering.h>

+ Inheritance diagram for WDataSetHierarchicalClustering:

Public Types

typedef boost::shared_ptr
< WDataSetHierarchicalClustering
SPtr
 Pointer to dataset.
typedef boost::shared_ptr
< const
WDataSetHierarchicalClustering
ConstSPtr
 Pointer to const dataset.
- Public Types inherited from WDataSet
typedef boost::shared_ptr
< WDataSet
SPtr
 Shared pointer abbreviation to a instance of this class.
typedef boost::shared_ptr
< const WDataSet
ConstSPtr
 Shared pointer abbreviation to a const instance of this class.

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.
- Public Member Functions inherited from WDataSet
 WDataSet ()
 This constructor should be used if a dataSet does not stem from a file.
virtual ~WDataSet ()
 Since WDataSet is a base class and thus should be polymorphic we add virtual destructor.
void setFilename (const std::string filename)
 Set the name of the file that this data set stems from.
std::string getFilename () const
 Get the name of the file that this data set stems from.
OW_API_DEPRECATED void setFileName (const std::string filename)
 Set the name of the file that this data set stems from.
OW_API_DEPRECATED std::string getFileName () const
 Get the name of the file that this data set stems from.
virtual bool isTexture () const
 Determines whether this dataset can be used as a texture.
virtual boost::shared_ptr
< WDataSetVector
isVectorDataSet ()
 Checks if this dataset is a vector dataset.
virtual osg::ref_ptr
< WDataTexture3D
getTexture () const
 Returns the texture- representation of the dataset.
boost::shared_ptr< WPropertiesgetProperties () const
 Return a pointer to the properties object of the dataset.
boost::shared_ptr< WPropertiesgetInformationProperties () const
 Return a pointer to the information properties object of the dataset.
- Public Member Functions inherited from WTransferable
 WTransferable ()
 Default constructor.
virtual ~WTransferable ()
 Destructor.
- Public Member Functions inherited from WPrototyped
 WPrototyped ()
 Default constructor.
virtual ~WPrototyped ()
 Destructor.
template<typename T >
bool isA ()
 Checks whether the actual prototype has the specified runtime type.

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.
- Static Protected Attributes inherited from WDataSet
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.

Additional Inherited Members

- Protected Attributes inherited from WDataSet
boost::shared_ptr< WPropertiesm_properties
 The property object for the dataset.
boost::shared_ptr< WPropertiesm_infoProperties
 The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION".

Detailed Description

Represents a hierarchy of clusters.

Definition at line 44 of file WDataSetHierarchicalClustering.h.

Member Typedef Documentation

Pointer to const dataset.

Definition at line 56 of file WDataSetHierarchicalClustering.h.

Pointer to dataset.

Definition at line 51 of file WDataSetHierarchicalClustering.h.

Constructor & Destructor Documentation

WDataSetHierarchicalClustering::WDataSetHierarchicalClustering ( WTreeNode::SPtr  rootNode,
std::map< size_t, WFiberCluster::SPtr clusterMap 
)

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.

WDataSetHierarchicalClustering::WDataSetHierarchicalClustering ( )

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().

WDataSetHierarchicalClustering::~WDataSetHierarchicalClustering ( )
virtual

Destructor.

Definition at line 48 of file WDataSetHierarchicalClustering.cpp.

Member Function Documentation

std::map< size_t, WFiberCluster::SPtr > WDataSetHierarchicalClustering::getClusterMap ( )

Returns the whole cluster map.

Returns
the whole cluster map

Definition at line 77 of file WDataSetHierarchicalClustering.cpp.

References m_clusters.

std::vector< WTreeNode::SPtr > WDataSetHierarchicalClustering::getClustersDownToLevel ( WTreeNode::SPtr  node,
size_t  level 
)

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().

WTreeNode::SPtr WDataSetHierarchicalClustering::getRootNode ( )

Returns the root cluster.

Returns
the root cluster

Definition at line 72 of file WDataSetHierarchicalClustering.cpp.

References m_rootNode.

Member Data Documentation

std::map< size_t, WFiberCluster::SPtr > WDataSetHierarchicalClustering::m_clusters
private

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 >()
staticprotected

The prototype as singleton.

Definition at line 124 of file WDataSetHierarchicalClustering.h.

Referenced by getPrototype().

WTreeNode::SPtr WDataSetHierarchicalClustering::m_rootNode
private

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: