CompleteLinkage ClusterMethod. More...
#include <OpenMS/COMPARISON/CLUSTERING/CompleteLinkage.h>
Public Member Functions | |
| CompleteLinkage () | |
| default constructor More... | |
| CompleteLinkage (const CompleteLinkage &source) | |
| copy constructor More... | |
| virtual | ~CompleteLinkage () |
| destructor More... | |
| CompleteLinkage & | operator= (const CompleteLinkage &source) |
| assignment operator More... | |
| void | operator() (DistanceMatrix< Real > &original_distance, std::vector< BinaryTreeNode > &cluster_tree, const Real threshold=1) const |
| clusters the indices according to their respective element distances More... | |
Public Member Functions inherited from ClusterFunctor | |
| ClusterFunctor () | |
| default constructor More... | |
| ClusterFunctor (const ClusterFunctor &source) | |
| copy constructor More... | |
| virtual | ~ClusterFunctor () |
| destructor More... | |
| ClusterFunctor & | operator= (const ClusterFunctor &source) |
| assignment operator More... | |
Public Member Functions inherited from ProgressLogger | |
| ProgressLogger () | |
| Constructor. More... | |
| ~ProgressLogger () | |
| Destructor. More... | |
| void | setLogType (LogType type) const |
| Sets the progress log that should be used. The default type is NONE! More... | |
| LogType | getLogType () const |
| Returns the type of progress log being used. More... | |
| void | startProgress (SignedSize begin, SignedSize end, const String &label) const |
| Initializes the progress display. More... | |
| void | setProgress (SignedSize value) const |
| Sets the current progress. More... | |
| void | endProgress () const |
| Ends the progress display. More... | |
Static Public Member Functions | |
| static ClusterFunctor * | create () |
| creates a new instance of a CompleteLinkage object More... | |
| static const String | getProductName () |
| get the identifier for this object More... | |
Static Public Member Functions inherited from ClusterFunctor | |
| static void | registerChildren () |
| registers all derived products More... | |
Additional Inherited Members | |
Public Types inherited from ProgressLogger | |
| enum | LogType { CMD, GUI, NONE } |
| Possible log types. More... | |
Protected Attributes inherited from ProgressLogger | |
| LogType | type_ |
| SignedSize | begin_ |
| SignedSize | end_ |
| SignedSize | value_ |
| QProgressDialog * | dlg_ |
| StopWatch | stop_watch_ |
| time_t | last_invoke_ |
Static Protected Attributes inherited from ProgressLogger | |
| static int | recursion_depth_ |
CompleteLinkage ClusterMethod.
The details of the method can be found in: Backhaus, Erichson, Plinke, Weiber Multivariate Analysemethoden, Springer 2000 and Ellen M. Voorhees: Implementing agglomerative hierarchic clustering algorithms for use in document retrieval. Inf. Process. Manage. 22(6): 465-476 (1986)
| CompleteLinkage | ( | ) |
default constructor
| CompleteLinkage | ( | const CompleteLinkage & | source | ) |
copy constructor
|
virtual |
destructor
|
inlinestatic |
creates a new instance of a CompleteLinkage object
|
inlinestatic |
get the identifier for this object
|
virtual |
clusters the indices according to their respective element distances
| original_distance | DistanceMatrix<Real> containing the distances of the elements to be clustered, will be changed during clustering process, make sure to have a copy or be able to redo |
| cluster_tree | vector< BinaryTreeNode >, represents the clustering, each node contains the next merged clusters (not element indices) and their distance, strict order is kept: left_child < right_child |
| threshold | Real value, the minimal distance from which on cluster merging is considered unrealistic. By default set to 1, i.e. complete clustering until only one cluster remains |
| ClusterFunctor::InsufficientInput | thrown if input is <2 The clustering method is complete linkage, where the updated distances after merging two clusters are each the maximal distance between the elements of their clusters. After theshold is exceeded, cluster_tree is filled with dummy clusteringsteps (children: (0,1), distance:-1) to the root. |
Implements ClusterFunctor.
| CompleteLinkage& operator= | ( | const CompleteLinkage & | source | ) |
assignment operator
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5 |