mouse.record module

Overview

The mouse-record program is designed for the ease of recording and singling out desired behavior of rodents, namely the events of interest in reward-stimulus studies. Using these events as triggers (e.g., the press of a lever), the program records the user-specified time before and after a desired event. The generated H264 video files are saved into the desired directory.

API

class mouse.record.Trigger(port=27)[source]

Bases: object

Responsible for setting event trigger and waiting for updates.

Notes

Relies on GPIO ports on the RaspberryPi for event notification.

port

int

GPIO port of trigger.

wait()[source]

Function sets initiation of trigger event.

mouse.record.main(*argv)[source]

Simple main function that performs event center recording.

Parameters:argv (str) – Arguments are stored as a list

Notes

These are the parameters of the arguments.

  • folder(str): File directory
  • x(int): Time to recording before (seconds)
  • y(int): Time to record after (seconds)