neuralib.locomotion.spatial.SpatialInfoResult

class neuralib.locomotion.spatial.SpatialInfoResult

Bases: NamedTuple

Result of spatial information calculation.

Dimension parameters:

B = number of spatial bins

__init__()

Methods

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

Attributes

activity	Mean activity per bin (smoothed).
occupancy	Time spent per bin (smoothed).
position	Bin edges.
spatial_info	Spatial information score in bits/event (Skaggs et al., 1996)

position: ndarray

Bin edges. Array[float, B+1]

occupancy: ndarray

Time spent per bin (smoothed). Array[float, B]

activity: ndarray

Mean activity per bin (smoothed). Array[float, B]

spatial_info: float

Spatial information score in bits/event (Skaggs et al., 1996)

static __new__(_cls, position, occupancy, activity, spatial_info)

Create new instance of SpatialInfoResult(position, occupancy, activity, spatial_info)

Parameters:

• position (ndarray)

• occupancy (ndarray)

• activity (ndarray)

• spatial_info (float)