locan.data.filter.select_by_image_mask#
- locan.data.filter.select_by_image_mask(locdata, mask)[source]#
Select by masking using a binary image(e.g. generated by thresholding a transmitted-light microscopy image.
- Parameters:
locdata (LocData) – specifying the localization data from which to select.
mask (
Union
[_SupportsArray
[dtype
[Any
]],_NestedSequence
[_SupportsArray
[dtype
[Any
]]],bool
,int
,float
,complex
,str
,bytes
,_NestedSequence
[Union
[bool
,int
,float
,complex
,str
,bytes
]]]) – binary image.
- Returns:
a new instance of Selection referring to the specified dataset.
- Return type: