MSImagingRegion#

class pyopenms.MSImagingRegion(*args, **kwargs)#

Bases: object

Region handling class that provides membership checks and region local indexing. Regions are either Rectangle based and defined by their x/y minima and maxima or bitmasked with a bounding box for irregular shapes.

__init__(self) → None#
__init__(self, arg: pyopenms._pyopenms_experiment.MSImagingRegion, /) → None

Attributes

area

contains

fromMask

getBBoxHeight

getBBoxWidth

getId

getMaxX

getMaxY

getMinX

getMinY

getName

getShape

get_mask

Returns a 2D uint8 numpy array (bbox_h, bbox_w); 1 = inside region.

intersects

rectangle

class Shape(*values)#

Bases: Enum

Mask = 1#
Rectangle = 0#
getMapping()#

Returns a dict mapping int values to enum member name strings.

area#
contains#
fromMask = <nanobind.nb_func object>#
getBBoxHeight#
getBBoxWidth#
getId#
getMaxX#
getMaxY#
getMinX#
getMinY#
getName#
getShape#
get_mask#

Returns a 2D uint8 numpy array (bbox_h, bbox_w); 1 = inside region.

intersects#
rectangle = <nanobind.nb_func object>#