Commit e4a519d2 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC #445] added missing doc parts

parent ddb54075
......@@ -57,9 +57,9 @@ class WDendrogram
friend class WDendrogramTest;
public:
/**
* Constructs a new dendrogram for \ref size many objects.
* Constructs a new dendrogram for \c n many objects.
*
* \param size The number of leafs.
* \param n The number of leafs.
*/
explicit WDendrogram( size_t n );
......
......@@ -38,9 +38,14 @@ class WTractData
public:
/**
* Constructs a new WTractData.
* \param pointComponents x, y, and z components of each position of each tract
* \param startIndices For each tract the index of the first x component in pointComponents.
*/
WTractData( boost::shared_ptr< std::vector< float > > pointComponents, boost::shared_ptr< std::vector< size_t > > startIndices );
/**
* \return Number of tracts.
*/
size_t numTracts() const;
protected:
......
......@@ -128,8 +128,18 @@ protected:
*/
void computeDistanceMatrix( boost::shared_ptr< const WDataSetGP > dataSet );
/**
* Constructs Euclidean minimal spanning tree (EMST) as preprocessing for dendrogram.
* \param dataSet Gaussian processes
* \return Euclidean spanning tree (map from weight (double) to edge (pair<size_t,size_t>))
*/
boost::shared_ptr< WMDetTractClusteringGP::MST > computeEMST( boost::shared_ptr< const WDataSetGP > dataSet ) const;
/**
* Constructs single linkage agglomerative clustering from EMST.
* \param edges Sorted weighted edges of EMST
* \return The dendrogram
*/
boost::shared_ptr< WDendrogram > computeDendrogram( boost::shared_ptr< const WMDetTractClusteringGP::MST > edges ) const;
/**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment