sparrow.im.segment

Contents

sparrow.im.segment#

sparrow.im.segment(sdata, img_layer, model=<function _cellpose>, output_labels_layer='segmentation_mask', output_shapes_layer='segmentation_mask_boundaries', labels_layer_align=None, depth=100, chunks='auto', boundary='reflect', trim=False, iou=True, iou_depth=2, iou_threshold=0.7, crd=None, to_coordinate_system='global', scale_factors=None, overwrite=False, **kwargs)#

Segment images using a provided model and add segmentation results (labels layer and shapes layer) to the SpatialData object.

Parameters:

  • sdata (SpatialData) – The SpatialData object containing the image layer to segment.

  • img_layer (str) – The image layer in sdata to be segmented.

  • model (Callable[..., NDArray] (default: <function _cellpose at 0x7fe4ba6d37f0>)) – The segmentation model function used to process the images. Callable should take as input numpy arrays of dimension (z,y,x,c) and return labels of dimension (z,y,x,c). It can have an arbitrary number of other parameters.

  • output_labels_layer (str | list[str] (default: 'segmentation_mask')) – Name of the label layer in which segmentation results will be stored in sdata. Can be a list of strings, if model returns multi channel mask. If provided as a list, its length should match the c dimension of the output of model.

  • output_shapes_layer (str | list[str] | None (default: 'segmentation_mask_boundaries')) – Name of the shapes layer where boundaries obtained output_labels_layer will be stored. If set to None, shapes won’t be stored. Can be a list of strings, if model returns multi channel mask. If provided as a list, its length should match the c dimension of the output of model.

  • labels_layer_align (Optional[str] (default: None)) – Name of the labels layer in output_labels_layer to align to if model retuns multi channel mask.

  • depth (tuple[int, int] | int (default: 100)) – The depth in y and x dimension. The depth parameter is passed to dask.array.map_overlap. If trim is set to False, it’s recommended to set the depth to a value greater than twice the estimated diameter of the cells/nulcei.

  • chunks (str | int | tuple[int, int] | None (default: 'auto')) – Chunk sizes for processing. Can be a string, integer or tuple of integers. If chunks is a tuple, they contain the chunk size that will be used in y and x dimension. Chunking in z or c dimension is not supported.

  • boundary (str (default: 'reflect')) – Boundary parameter passed to dask.array.map_overlap.

  • trim (bool (default: False)) – If set to True, overlapping regions will be processed using the squidpy algorithm. If set to False, the sparrow algorithm will be employed instead. For dense cell distributions, we recommend setting trim to False.

  • iou (bool (default: True)) – If set to True, will try to harmonize labels across chunks using a label adjacency graph with an iou threshold (see sparrow.image.segmentation.utils._link_labels). If set to False, conflicts will be resolved using an algorithm that only retains masks with the center in the chunk. Setting iou to False gives good results if there is reasonable agreement of the predicted labels accross adjacent chunks.

  • iou_depth (tuple[int, int] | int (default: 2)) – iou depth used for harmonizing labels across chunks. Note that if labels_layer_align is specified, iou_depth will also be used for harmonizing labels between different chunks.

  • iou_threshold (float (default: 0.7)) – iou threshold used for harmonizing labels across chunks. Note that if labels_layer_align is specified, iou_threshold will also be used for harmonizing labels between different chunks.

  • crd (Optional[tuple[int, int, int, int]] (default: None)) – The coordinates specifying the region of the image to be segmented. Defines the bounds (x_min, x_max, y_min, y_max).

  • to_coordinate_system (str (default: 'global')) – The coordinate system to which the crd is specified. Ignored if crd is None.

  • scale_factors (Optional[Sequence[Union[dict[str, int], int]]] (default: None)) – Scale factors to apply for multiscale.

  • overwrite (bool (default: False)) – If True, overwrites the existing layers if they exist. Otherwise, raises an error if the layers exist.

  • **kwargs (Any) – Additional keyword arguments passed to the provided model.

Return type:

SpatialData

Returns:

: Updated sdata object containing the segmentation results.

Raises:

TypeError – If the provided model is not a callable.

Contents