gridcells.core.arena
- Defining arenas¶
The arena
module provides class definitions of arenas. These
can subsequently be used as input to process spiking data and generate spatial
firing fields/autocorrelations.
These types of arenas are currently defined:¶
Arena |
An abstract class for arenas. |
CircularArena (radius, discretisation) |
A circular arena. |
RectangularArena (size, discretisation) |
A rectangular arena. |
SquareArena (size, discretisation) |
A square arena. |
-
class
gridcells.core.arena.
Arena
[source]¶ Bases:
object
An abstract class for arenas.
This class is an interface for obtaining discretisations of the arenas and masks when the shape is not rectangular.
-
class
gridcells.core.arena.
CircularArena
(radius, discretisation)[source]¶ Bases:
gridcells.core.arena.SquareArena
A circular arena.
-
sz
¶ Return the size of the arena. Equivalent to
getSize()
.
-
-
class
gridcells.core.arena.
RectangularArena
(size, discretisation)[source]¶ Bases:
gridcells.core.arena.Arena
A rectangular arena.
Use
RectangularArena
when you need to work with rectangular arenas.Note
The origin (0, 0) of the coordinate system in all the arenas is in the bottom-left corner of the arena.
-
sz
¶ Return the size of the arena. Equivalent to
getSize()
.
-
-
class
gridcells.core.arena.
SquareArena
(size, discretisation)[source]¶ Bases:
gridcells.core.arena.RectangularArena
A square arena.
-
sz
¶ Return the size of the arena. Equivalent to
getSize()
.
-