neuralib.suite2p.signals.DFFSignal

class neuralib.suite2p.signals.DFFSignal

Bases: NamedTuple

Container for dF/F signal processing.

Dimension parameters:

N = number of neurons

F = number of frame

For single cell (F,) OR multiple cells (N, F)

__init__()

Methods

__init__()
count(value, /)	Return number of occurrences of value.
index(value[, start, stop])	Return first index of value.

Attributes

baseline_fluctuation	get the fluctuation of the fneu signal.
dff	dff after f0 normalization.
dff_baseline	baseline of dff, supposed to be 0
f	Fluorescence intensity.
f0	Background Fluorescence.
fcorr	Fluorescence corrected by fneu that used for dff calculation.
fneu	Neuropil intensity.
s2p	Suite2PResult

s2p: Suite2PResult

Suite2PResult

f: ndarray

Fluorescence intensity. Array[float, F | [N,F]]

fneu: ndarray

Neuropil intensity. Array[float, F | [N,F]]

fcorr: ndarray

Fluorescence corrected by fneu that used for dff calculation. Array[float, F | [N,F]]

f0: ndarray

Background Fluorescence. Array[float, F | [N,F]]

dff: ndarray

dff after f0 normalization. Array[float, F | [N,F]]

static __new__(_cls, s2p, f, fneu, fcorr, f0, dff)

Create new instance of DFFSignal(s2p, f, fneu, fcorr, f0, dff)

Parameters:

• s2p (Suite2PResult)

• f (ndarray)

• fneu (ndarray)

• fcorr (ndarray)

• f0 (ndarray)

• dff (ndarray)

property dff_baseline: ndarray

baseline of dff, supposed to be 0

property baseline_fluctuation: ndarray

get the fluctuation of the fneu signal. Array[float, F | [N,F]]

Perhaps not fully corrected with physiological reason. used to get the baseline std (i.e., trial reliability metric)