napari_prism.pl.mask_tma

Contents

napari_prism.pl.mask_tma#

napari_prism.pl.mask_tma(sdata, label_name, image_name=None, channel_label=None, channel_cmap='gray', figsize=None, dpi=None, coordinate_system='global', show=True, **kwargs)#

Displays a labels element from the SpatialData object, such as the generated TMA masks.

Parameters:

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

  • label_name (str) – The name of the label to display.

  • image_name (Optional[str] (default: None)) – The name of the image to display.

  • channel_label (Optional[str] (default: None)) – The label of the channel to display.

  • channel_cmap (str | None (default: 'gray')) – The colormap to use for the channel.

  • figsize (Optional[tuple[int, int]] (default: None)) – The size of the figure.

  • dpi (Optional[int] (default: None)) – The DPI of the figure.

  • coordinate_system (str (default: 'global')) – The coordinate system to use for rendering.

  • show (bool (default: True)) – Whether to show the plot or return it.

  • **kwargs – Passed to spatialdata.pl.render_labels.

Return type:

None | SpatialData

Returns:

None if show is True, otherwise returns the rendered SpatialData object.

Contents