ICluster : Abstract cluster. More...
#include <ICluster.h>
Public Types | |
| using | ClusterIntegratedValues = boost::tuple< double, double > |
Public Member Functions | |
| virtual void | addIndex (const size_t &index)=0 |
| Track a linear IMDHistoWorkspace index that belongs to the cluster. More... | |
| virtual bool | containsLabel (const size_t &label) const =0 |
| Is the label contained in the cluster. More... | |
| virtual size_t | getLabel () const =0 |
| Get the cluster label. More... | |
| virtual size_t | getOriginalLabel () const =0 |
| Get the originally set label. More... | |
| virtual size_t | getRepresentitiveIndex () const =0 |
| Get a represetiative index of the cluster. More... | |
| virtual ClusterIntegratedValues | integrate (std::shared_ptr< const Mantid::API::IMDHistoWorkspace > ws) const =0 |
| integrate the cluster More... | |
| virtual void | setRootCluster (ICluster const *root)=0 |
| Set the root cluster. More... | |
| virtual size_t | size () const =0 |
| Number of indexes tracked. More... | |
| virtual void | toUniformMinimum (std::vector< DisjointElement > &disjointSet)=0 |
| Resolve the proper label for this cluster. More... | |
| virtual void | writeTo (std::shared_ptr< Mantid::API::IMDHistoWorkspace > ws) const =0 |
| Apply labels to the workspace. More... | |
| virtual | ~ICluster ()=default |
| Virtual destructor. More... | |
Detailed Description
ICluster : Abstract cluster.
Identifies neighbour elements in an image that are connected.
Definition at line 25 of file ICluster.h.
Member Typedef Documentation
◆ ClusterIntegratedValues
| using Mantid::Crystal::ICluster::ClusterIntegratedValues = boost::tuple<double, double> |
Definition at line 27 of file ICluster.h.
Constructor & Destructor Documentation
◆ ~ICluster()
|
virtualdefault |
Virtual destructor.
Member Function Documentation
◆ addIndex()
|
pure virtual |
Track a linear IMDHistoWorkspace index that belongs to the cluster.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
◆ containsLabel()
|
pure virtual |
Is the label contained in the cluster.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
◆ getLabel()
|
pure virtual |
Get the cluster label.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
Referenced by Mantid::Crystal::CompositeCluster::findMinimum(), Mantid::Crystal::Cluster::getLabel(), and Mantid::Crystal::CompositeCluster::toUniformMinimum().
◆ getOriginalLabel()
|
pure virtual |
Get the originally set label.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
◆ getRepresentitiveIndex()
|
pure virtual |
Get a represetiative index of the cluster.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
Referenced by Mantid::Crystal::Cluster::toUniformMinimum().
◆ integrate()
|
pure virtual |
integrate the cluster
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
Referenced by Mantid::Crystal::IntegratePeaksHybrid::exec(), and Mantid::Crystal::IntegratePeaksUsingClusters::exec().
◆ setRootCluster()
|
pure virtual |
Set the root cluster.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
◆ size()
|
pure virtual |
Number of indexes tracked.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
◆ toUniformMinimum()
|
pure virtual |
Resolve the proper label for this cluster.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
◆ writeTo()
|
pure virtual |
Apply labels to the workspace.
Implemented in Mantid::Crystal::Cluster, and Mantid::Crystal::CompositeCluster.
The documentation for this class was generated from the following file:
- Framework/Crystal/inc/MantidCrystal/ICluster.h
