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-2015.
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 
35 #include <map>
36 #include <vector>
37 
39 
40 #ifndef OPENMS_COMPARISON_CLUSTERING_CLUSTERINGGRID_H
41 #define OPENMS_COMPARISON_CLUSTERING_CLUSTERINGGRID_H
42 
43 namespace OpenMS
44 {
51 class OPENMS_DLLAPI ClusteringGrid
52 {
53  public:
57  typedef std::pair<int,int> CellIndex;
58 
63 
71  ClusteringGrid(const std::vector<double> &grid_spacing_x, const std::vector<double> &grid_spacing_y);
72 
76  std::vector<double> getGridSpacingX() const;
77 
81  std::vector<double> getGridSpacingY() const;
82 
89  void addCluster(const CellIndex &cell_index, const int &cluster_index);
90 
98  void removeCluster(const CellIndex &cell_index, const int &cluster_index);
99 
103  void removeAllClusters();
104 
111  std::list<int> getClusters(const CellIndex &cell_index) const;
112 
119  CellIndex getIndex(const Point &position) const;
120 
130  bool isNonEmptyCell(const CellIndex &cell_index) const;
131 
137  int getCellCount() const;
138 
139  private:
143  const std::vector<double> grid_spacing_x_;
144  const std::vector<double> grid_spacing_y_;
145 
149  std::pair <double,double> range_x_;
150  std::pair <double,double> range_y_;
151 
155  std::map<CellIndex, std::list<int> > cells_;
156 
157 };
158 
159 }
160 
161 #endif /* OPENMS_COMPARISON_CLUSTERING_CLUSTERINGGRID_H */
std::pair< int, int > CellIndex
Definition: ClusteringGrid.h:57
std::pair< double, double > range_x_
[min, max] of the grid in x and y direction
Definition: ClusteringGrid.h:149
DPosition< 2 > Point
Definition: ClusteringGrid.h:62
std::map< CellIndex, std::list< int > > cells_
grid cell index mapped to a list of clusters in it
Definition: ClusteringGrid.h:155
std::pair< double, double > range_y_
Definition: ClusteringGrid.h:150
const std::vector< double > grid_spacing_y_
Definition: ClusteringGrid.h:144
data structure to store 2D data to be clustered e.g. (m/z, retention time) coordinates from multiplex...
Definition: ClusteringGrid.h:51
const std::vector< double > grid_spacing_x_
spacing of the grid in x and y direction
Definition: ClusteringGrid.h:143

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 16:18:38 using doxygen 1.8.5