ClusteringGrid#

class pyopenms.ClusteringGrid#

Bases: object

Cython implementation of _ClusteringGrid

Original C++ documentation is available here

__init__()#

Overload:

__init__(self, grid_spacing_x: List[float], grid_spacing_y: List[float]) → None

Overload:

__init__(self, in_0: ClusteringGrid) → None

Methods

`__init__`	Overload:
`addCluster`(self, cell_index, cluster_index)	Adds a cluster to this grid cell
`getCellCount`(self)	Returns number of grid cells occupied by one or more clusters
`getGridSpacingX`(self)
`getGridSpacingY`(self)
`getIndex`(self, position)
`isNonEmptyCell`(self, cell_index)	Checks if there are clusters at this cell index
`removeAllClusters`(self)	Removes all clusters from this grid (and hence all cells)
`removeCluster`(self, cell_index, cluster_index)	Removes a cluster from this grid cell and removes the cell if no other cluster left

addCluster(self, cell_index: List[int, int], cluster_index: int) → None#: Adds a cluster to this grid cell

getCellCount(self) → int#: Returns number of grid cells occupied by one or more clusters

getGridSpacingX(self) → List[float]#

getGridSpacingY(self) → List[float]#

getIndex(self, position: Sequence[int] | Sequence[float]) → List[int, int]#

isNonEmptyCell(self, cell_index: List[int, int]) → bool#: Checks if there are clusters at this cell index

removeAllClusters(self) → None#: Removes all clusters from this grid (and hence all cells)

removeCluster(self, cell_index: List[int, int], cluster_index: int) → None#: Removes a cluster from this grid cell and removes the cell if no other cluster left