Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
ClusteringGrid.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2017.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Lars Nilse $
32 // $Authors: Lars Nilse $
33 // --------------------------------------------------------------------------
34 #ifndef OPENMS_COMPARISON_CLUSTERING_CLUSTERINGGRID_H
35 #define OPENMS_COMPARISON_CLUSTERING_CLUSTERINGGRID_H
36 
39 
41 #include <OpenMS/CONCEPT/Types.h>
43 #include <OpenMS/CONCEPT/Macros.h>
44 
45 #include <map>
46 #include <vector>
47 #include <list>
48 
49 namespace OpenMS
50 {
57 class OPENMS_DLLAPI ClusteringGrid
58 {
59  public:
63  typedef std::pair<int,int> CellIndex;
64 
69 
77  ClusteringGrid(const std::vector<double> &grid_spacing_x, const std::vector<double> &grid_spacing_y);
78 
82  std::vector<double> getGridSpacingX() const;
83 
87  std::vector<double> getGridSpacingY() const;
88 
95  void addCluster(const CellIndex &cell_index, const int &cluster_index);
96 
104  void removeCluster(const CellIndex &cell_index, const int &cluster_index);
105 
109  void removeAllClusters();
110 
117  std::list<int> getClusters(const CellIndex &cell_index) const;
118 
125  CellIndex getIndex(const Point &position) const;
126 
136  bool isNonEmptyCell(const CellIndex &cell_index) const;
137 
143  int getCellCount() const;
144 
145  private:
149  const std::vector<double> grid_spacing_x_;
150  const std::vector<double> grid_spacing_y_;
151 
155  std::pair <double,double> range_x_;
156  std::pair <double,double> range_y_;
157 
161  std::map<CellIndex, std::list<int> > cells_;
162 
163 };
164 
165 }
166 
167 #endif /* OPENMS_COMPARISON_CLUSTERING_CLUSTERINGGRID_H */
std::pair< int, int > CellIndex
Definition: ClusteringGrid.h:63
std::pair< double, double > range_x_
[min, max] of the grid in x and y direction
Definition: ClusteringGrid.h:155
DPosition< 2 > Point
Definition: ClusteringGrid.h:68
std::map< CellIndex, std::list< int > > cells_
grid cell index mapped to a list of clusters in it
Definition: ClusteringGrid.h:161
std::pair< double, double > range_y_
Definition: ClusteringGrid.h:156
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
const std::vector< double > grid_spacing_y_
Definition: ClusteringGrid.h:150
data structure to store 2D data to be clustered e.g. (m/z, retention time) coordinates from multiplex...
Definition: ClusteringGrid.h:57
const std::vector< double > grid_spacing_x_
spacing of the grid in x and y direction
Definition: ClusteringGrid.h:149

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13