Tools for neuroscience experiments
Project description
toon
Description
Additional tools for neuroscience experiments, including:
- A framework for polling input devices on a separate process.
- A framework for keyframe-based animation.
- High-resolution clocks.
Everything should work on Windows/Mac/Linux.
Install
Current release:
pip install toon
Development version:
pip install -i https://test.pypi.org/simple/ toon --pre
Or for the latest commit (requires compilation-- C++11 (and if using MSVC, >= 2015 for proper std::chrono
implementation)):
pip install git+https://github.com/aforren1/toon
See the demos/ folder for usage examples (note: some require additional packages).
Overview
Input
toon
provides a framework for polling from input devices, including common peripherals like mice and keyboards, with the flexibility to handle less-common devices like eyetrackers, motion trackers, and custom devices (see toon/input/
for examples). The goal is to make it easier to use a wide variety of devices, including those with sampling rates >1kHz, with minimal performance impact on the main process.
We use the built-in multiprocessing
module to control a separate process that hosts the device, and, in concert with numpy
, to move data to the main process via shared memory. It seems that under typical conditions, we can expect single read()
operations to take less than 500 microseconds (and more often < 100 us). See demos/bench_plot.py for an example of measuring user-side read performance.
Typical use looks like this:
from toon.input import MpDevice
from mydevice.mouse import Mouse
from timeit import default_timer
device = MpDevice(Mouse())
with device:
t1 = default_timer() + 10
while default_timer() < t1:
res = device.read()
# alternatively, unpack immediately
# time, data = device.read()
if res:
time, data = res # unpack (or access via res.time, res.data)
# N-D array of data (0th dim is time)
print(data)
# 1D array of times
print(time)
Creating a custom device is relatively straightforward, though there are a few boxes to check.
from ctypes import c_double
class MyDevice(BaseDevice):
# optional: give a hint for the buffer size (we'll allocate 1 sec worth of this)
sampling_frequency = 500
# this can either be introduced at the class level, or during __init__
shape = (3, 3)
# ctype can be a python type, numpy dtype, or ctype
# including ctypes.Structures
ctype = c_double
# optional. Do not start device communication here, wait until `enter`
def __init__(self):
pass
## Use `enter` and `exit`, rather than `__enter__` and `__exit__`
# optional: configure the device, start communicating
def enter(self):
pass
# optional: clean up resources, close device
def exit(self):
pass
# required
def read(self):
# See demos/ for examples of sharing a time source between the processes
time = self.clock()
# store new data with a timestamp
data = get_data()
return time, data
This device can then be passed to a toon.input.MpDevice
, which preallocates the shared memory and handles other details.
A few things to be aware of for data returned by MpDevice
:
- If there's no data for a given
read
,None
is returned. - The returned data is a copy of the local copy of the data. If you don't need copies, set
use_views=True
when instantiating theMpDevice
. - If receiving batches of data when reading from the device, you can return a list of (time, data) tuples.
- You can optionally use
device.start()
/device.stop()
instead of a context manager. - You can check for remote errors at any point using
device.check_error()
, though this automatically happens after entering the context manager and when reading. - In addition to python types/dtypes/ctypes, devices can return
ctypes.Structure
s (see input tests or the example_devices folder for examples).
Animation
This is still a work in progress, though I think it has some utility as-is. It's a port of the animation component in the Magnum framework, though lacking some of the features (e.g. Track extrapolation, proper handling of time scaling).
Example:
from math import sin, pi
from time import sleep
from timeit import default_timer
import matplotlib.pyplot as plt
from toon.anim import Track, Player
# see toon/anim/easing.py for all available easings
from toon.anim.easing import LINEAR, ELASTIC_IN
class Circle(object):
x = 0
y = 0
circle = Circle()
# list of (time, value)
keyframes = [(0.2, -0.5), (0.5, 0), (3, 0.5)]
x_track = Track(keyframes, easing=LINEAR)
# we can reuse keyframes
y_track = Track(keyframes, easing=ELASTIC_IN)
player = Player(repeats=3)
# directly modify an attribute
player.add(x_track, 'x', obj=circle)
def y_cb(val, obj):
obj.y = val
# modify via callback
player.add(y_track, y_cb, obj=circle)
t0 = default_timer()
player.start(t0)
vals = []
times = []
while player.is_playing:
t = default_timer()
player.advance(t)
times.append(t)
vals.append([circle.x, circle.y])
# sleep(1/60)
plt.plot(times, vals)
plt.show()
Other notes:
- Non-numeric attributes, like color strings, can also be modified in this framework (easing is ignored).
- Multiple objects can be modified simultaneously by feeding a list of objects into
player.add()
.
Utilities
The util
module includes high-resolution clocks/timers via std::chrono::steady_clock
. The class is called MonoClock
, and an instantiation called mono_clock
is created upon import. Usage:
from toon.util import mono_clock, MonoClock
clk = mono_clock # re-use pre-instantiated clock
clk2 = MonoClock(relative=False) # time relative to whenever the system's clock started
t0 = clk.get_time()
Another utility currently included is a priority
function, which tries to improve the determinism of the calling script. This is derived from Psychtoolbox's Priority
(doc here). General usage is:
from toon.util import priority
if not priority(1):
raise RuntimeError('Failed to raise priority.')
# ...do stuff...
priority(0)
The input should be a 0 (no priority/cancel), 1 (higher priority), or 2 (realtime). If the requested level is rejected, the function will return False
. The exact implementational details depend on the host operating system. All implementations disable garbage collection.
Windows
- Uses
SetPriorityClass
andSetThreadPriority
/AvSetMmMaxThreadCharacteristics
. level = 2
only seems to work if running Python as administrator.
MacOS
- Only disables/enables garbage collection; I don't have a Mac to test on.
Linux
- Sets the scheduler policy and parameters
sched_setscheduler
. - If
level == 2
, locks the calling process's virtual address space into RAM viamlockall
. - Any
level > 0
seems to fail unless the user is either superuser, or has the right capability. I've used setcap:sudo setcap cap_sys_nice=eip <path to python>
(disable by passingsudo setcap cap_sys_nice= <path>
). For memory locking, I've used Psychtoolbox's 99-psychtoolboxlimits.conf and added myself to the psychtoolbox group.
Your mileage may vary on whether these actually improve latency/determinism. When in doubt, measure! Read the warnings here.
Notes about checking whether parts are working:
Windows
- In the task manager under details, right-clicking on python and mousing over "Set priority" will show the current priority level. I haven't figured out how to verify the Avrt threading parts are working.
Linux
- Check
mlockall
withcat /proc/{python pid}/status | grep VmLck
- Check priority with
top -c -p $(pgrep -d',' -f python)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for toon-0.15.3-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37044b6d4190a2671b250a47f77838575bba93018f1d2f271c6bdf0777fece6a |
|
MD5 | cd783300db011070ec54493ade6fd0a8 |
|
BLAKE2b-256 | afb8aac96451ea00a9350ce09a45dabff8a3d5b1865cadcfb1f88d9c5de37560 |
Hashes for toon-0.15.3-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf9806002d27ea83e62b693f69b2e84eba9e290fa9f2f9e9da86577332eb9adb |
|
MD5 | 3c2faee4bc3cbeb7ac54158b54841cc6 |
|
BLAKE2b-256 | 3e6c147e7ad7a1f3e184a4722b06c2d708f2cc2598b824737471dd6dc0b2e2fe |
Hashes for toon-0.15.3-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d0847fc20a2ec106ccad7f91e2d08b1cff198f71fe65cf897445a92ce1e8818 |
|
MD5 | 107ce3d6b56a7ef329091bc3782b7cd8 |
|
BLAKE2b-256 | 78f23f49dbe0042cee29cf9ebe02cd188147120492662f15d89b82985d4dce7e |
Hashes for toon-0.15.3-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76302ed044264226e6a95777f7b6d89d646639ece460e5dfa402369dbc6c6a4e |
|
MD5 | 33703dca92d8fba38afcb2917d134530 |
|
BLAKE2b-256 | 73ae2b22263c124ab237055db8537cc30791dd4f716038bbfc3fd62e7f72a4c5 |
Hashes for toon-0.15.3-cp37-cp37m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de4ef54f8df6dd00851932e91bd2b49f46a259e29015a552bb03c4dd8c5fa3cb |
|
MD5 | fca88e9235d268eb24aad00cb802b25c |
|
BLAKE2b-256 | 740b08b6882afc405f476a980bc4c85a44803466fb4e02942d77ebbfa8e29860 |
Hashes for toon-0.15.3-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d7ee4129b10088badc1941cd1bb10a9a80c60bf09d1e663097bb9352a6a633c |
|
MD5 | a374eaf7d94c4ca9d98cb3b151febd27 |
|
BLAKE2b-256 | 5999ec286854d3357be286d6b231bbf70f5e5f74c7ba3cd079bed97ff0a4f3f9 |
Hashes for toon-0.15.3-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e1af0c8856d9349798df39d713076beab18a3843a7c6a38b59c7cc631087036 |
|
MD5 | ab1fe6da21ea16a6c7abadd38ef321d0 |
|
BLAKE2b-256 | 98f1ca1c59c8641ea49251fd9686a36c07632161003dc09d9fa48d8a730cfbc8 |
Hashes for toon-0.15.3-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f173b5748b0ebbfc4dea861e21c8c9842f24f40d487de68cd880be8468e6391 |
|
MD5 | 82581cb16c918032e3f670d03c4ae78b |
|
BLAKE2b-256 | d6568920573c4ee0406c6e80384051a5a60e09f7696c02cf96eec9874dfd5f4b |
Hashes for toon-0.15.3-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b36442050d6a42799ed88433bfbe3a4c64068d020d2ab5e622f0a2ccdb0abbd |
|
MD5 | 2aadceced83e4161c714a3c5656114df |
|
BLAKE2b-256 | 0b469fc2fa30e1e667c7c2c359ba574cae8a179251b93019fcbbfdb2b98c6df7 |
Hashes for toon-0.15.3-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb478cdf62c4258e7b496870cc1e0fc0eed6a7827e93ff15062e638932cbb2ca |
|
MD5 | 8bf5b080a1471380ca44781b679a6334 |
|
BLAKE2b-256 | c3f0e8675fb1e713104ecb88ffadc1bf88e83bce718a774c719f50d6ce5b97bb |
Hashes for toon-0.15.3-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5270242ecef8c536429adb1c3f911aa97eaed52266ea2a5ef465f7af6e7083c4 |
|
MD5 | a1dd8dcb985531243ecb6fcf7ad635c7 |
|
BLAKE2b-256 | e80c7fb9425aef5352ea9d2967484010c7d2ebe544ebe49cd0a821e963eb40c7 |
Hashes for toon-0.15.3-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a65940a359c95c42472074d3b417010356e11cc82c98b7d5add9226c95484831 |
|
MD5 | 50e765e0e0ea3d52b0525f48fc90e6a7 |
|
BLAKE2b-256 | 9156fa9a2af0ae4a60ca82cb010e5449ee7b6ae0cc01ba9cb6664df9baca40d8 |