neuralib.suite2p.plot.get_soma_pixel

neuralib.suite2p.plot.get_soma_pixel(s2p, neuron_ids=None, *, color_diff=True, include_overlap_pixel=True)[source]

Get the image mask of the registered neuronal soma shape. The mask value equals to the neuron’s id + 1.

Parameters:

  • s2p (Suite2PResult) – Suite2PResult

  • neuron_ids (ndarray | None) – index ROIs array or bool mask array. Array[int|bool, N]

  • color_diff (bool) – whether show color difference across neurons

  • include_overlap_pixel (bool) – if taking overlap area into account

Returns:

2d imaging array, shape: (xpix, ypix)

Return type:

ndarray