napari_prism.pl.image

napari_prism.pl.image(sdata, image_name, channel_label='DAPI', channel_cmap='gray', alpha=1.0, figsize=None, dpi=None, coordinate_system='global', show=True)

Displays an Image element from the SpatialData object.

Parameters:

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

• image_name (str) – The name of the image to display.

• channel_label (str (default: 'DAPI')) – The label of the channel to display.

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

• alpha (float (default: 1.0)) – The alpha value for the image.

• 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.

Return type:

None | SpatialData

Returns:

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