OpenMS  3.0.0
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-2022.
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 #pragma once
35 
38 
40 #include <OpenMS/CONCEPT/Types.h>
42 #include <OpenMS/CONCEPT/Macros.h>
43 
44 #include <map>
45 #include <vector>
46 #include <list>
47 
48 namespace OpenMS
49 {
56 class OPENMS_DLLAPI ClusteringGrid
57 {
58  public:
62  typedef std::pair<int,int> CellIndex;
63 
68 
76  ClusteringGrid(const std::vector<double> &grid_spacing_x, const std::vector<double> &grid_spacing_y);
77 
81  std::vector<double> getGridSpacingX() const;
82 
86  std::vector<double> getGridSpacingY() const;
87 
94  void addCluster(const CellIndex &cell_index, const int &cluster_index);
95 
103  void removeCluster(const CellIndex &cell_index, const int &cluster_index);
104 
108  void removeAllClusters();
109 
116  std::list<int> getClusters(const CellIndex &cell_index) const;
117 
124  CellIndex getIndex(const Point &position) const;
125 
135  bool isNonEmptyCell(const CellIndex &cell_index) const;
136 
142  int getCellCount() const;
143 
144  private:
148  const std::vector<double> grid_spacing_x_;
149  const std::vector<double> grid_spacing_y_;
150 
154  std::pair <double,double> range_x_;
155  std::pair <double,double> range_y_;
156 
160  std::map<CellIndex, std::list<int> > cells_;
161 
162 };
163 
164 }
165 
DPosition.h
Types.h
OpenMS::ClusteringGrid
data structure to store 2D data to be clustered e.g. (m/z, retention time) coordinates from multiplex...
Definition: ClusteringGrid.h:56
OpenMS::ClusteringGrid::range_y_
std::pair< double, double > range_y_
Definition: ClusteringGrid.h:155
Macros.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Exception.h
OpenMS::ClusteringGrid::range_x_
std::pair< double, double > range_x_
[min, max] of the grid in x and y direction
Definition: ClusteringGrid.h:154
OpenMS::ClusteringGrid::Point
DPosition< 2 > Point
Definition: ClusteringGrid.h:67
OpenMS::ClusteringGrid::CellIndex
std::pair< int, int > CellIndex
Definition: ClusteringGrid.h:62
OpenMS::ClusteringGrid::grid_spacing_x_
const std::vector< double > grid_spacing_x_
spacing of the grid in x and y direction
Definition: ClusteringGrid.h:148
OpenMS::DPosition< 2 >
OpenMS::ClusteringGrid::cells_
std::map< CellIndex, std::list< int > > cells_
grid cell index mapped to a list of clusters in it
Definition: ClusteringGrid.h:160
StandardDeclarations.h
OpenMS::ClusteringGrid::grid_spacing_y_
const std::vector< double > grid_spacing_y_
Definition: ClusteringGrid.h:149
StandardTypes.h