ClusteringGrid.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Lars Nilse $
// $Authors: Lars Nilse $
// --------------------------------------------------------------------------
#pragma once
 
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/DATASTRUCTURES/DPosition.h>
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/CONCEPT/Macros.h>
 
#include <list>
#include <unordered_map>
#include <vector>
 
namespace OpenMS
{
class OPENMS_DLLAPI ClusteringGrid
{
    public:
    typedef std::pair<int,int> CellIndex;
    
    typedef DPosition<2> Point;
    
    ClusteringGrid(const std::vector<double> &grid_spacing_x, const std::vector<double> &grid_spacing_y);
    
    std::vector<double> getGridSpacingX() const;
    
    std::vector<double> getGridSpacingY() const;
    
    void addCluster(const CellIndex &cell_index, const int &cluster_index);
    
    void removeCluster(const CellIndex &cell_index, const int &cluster_index);
 
    void removeAllClusters();
 
    const std::list<int>& getClusters(const CellIndex &cell_index) const;
 
    CellIndex getIndex(const Point &position) const;
 
    bool isNonEmptyCell(const CellIndex &cell_index) const;
 
    int getCellCount() const;
 
    private:
    const std::vector<double> grid_spacing_x_;
    const std::vector<double> grid_spacing_y_;
 
    std::pair <double,double> range_x_;  
    std::pair <double,double> range_y_;  
 
    struct CellIndexHash
    {
      size_t operator()(const CellIndex& cell_index) const noexcept;
    };
 
    std::unordered_map<CellIndex, std::list<int>, CellIndexHash> cells_;
 
};
 
}