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.6-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21ea6d15c0134122c318fdb5bcd4144b7626aef34dfc5fe59806b9e7ef0a9d6b |
|
MD5 | 3b6cb4f8585dc47b4e610a30e353235f |
|
BLAKE2b-256 | ff4763921f2ea45f8ed791891d18efff2aa6d0ce356098611ce46ea3dacf39cc |
Hashes for toon-0.15.6-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa0738a0ee96912c6cc38ec7321fb5029c4c8071ad299e4248a46649ec916a4f |
|
MD5 | 2aced9245d4dce3857862d5488037250 |
|
BLAKE2b-256 | 839ea3795af7c000e03f950374a6fa7759c04a827aaf00d79dc56cb140e104e9 |
Hashes for toon-0.15.6-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6198d2084e550f6eda3b2ecdd913ee98e59522f6d376ff960f088e1e4b6cb468 |
|
MD5 | abf565238af0faf0ccebfd554f43f5f3 |
|
BLAKE2b-256 | 1489b69befd8ac5cf5b38a6f71fce7b421090deef558edb4a9ea087a4b65c609 |
Hashes for toon-0.15.6-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | daaccb27dfb7fdd0e2126659dd3fb0cdc052042bfd0da7c473bcd5522bca1db9 |
|
MD5 | 529917be52828bfec5c89329e1b103a9 |
|
BLAKE2b-256 | d00d2aae938af3ad3788690dae07396f00d282fe9fb3d712214cfbbd85ce34fa |
Hashes for toon-0.15.6-cp37-cp37m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8d5c1add12bd045140e0b07d87d2f12bf62143aecf934954abb87097c9f07c0 |
|
MD5 | 9c01313aca5a59c846ca0a9046b57381 |
|
BLAKE2b-256 | 8ea38eca2ef1560a7af089accb58dea11b3e9c9eb6fc206acda860cd5c3a6447 |
Hashes for toon-0.15.6-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a54125e4ea1ff3790768d01a55259854d83456f8bf83227d84341eac8f67a9c |
|
MD5 | 89b63f6fbda3a0e4cac0474f5b91543f |
|
BLAKE2b-256 | ed9ad0ce5c855593c889327ef49432b7f0b1ae2f2b6a542f1f2ccf56389b2dc8 |
Hashes for toon-0.15.6-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d70ccc2250c9b901658745f4795f4b336c6810e0766528f7a8f2fb4e699cd84 |
|
MD5 | 837964ced6b53749f8b959934f612a66 |
|
BLAKE2b-256 | 2c017bb869486e52b23a5718af49b00670499fd0929e47494d07d1845304bd3b |
Hashes for toon-0.15.6-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee94a4c6816267d27656c29c1cf7dd8d9708ce24e335f07a30973ed186fdc1d3 |
|
MD5 | dfd5c399c30feb85850451a6af156e71 |
|
BLAKE2b-256 | 8662b0513db059e767c613c8b64036f89d60802a30125a08ed47806243866bba |
Hashes for toon-0.15.6-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89eec978da752188c5dedd3fc1d46a3b81b9d5ea95044cbf544c90ec8531fd1e |
|
MD5 | 6ad45e8762b15aeff916caaaf0d0c995 |
|
BLAKE2b-256 | 1ed100c82b7af0cf3625af9feea9366db3b1da0d37f90b71defd8dfe32068b25 |
Hashes for toon-0.15.6-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 789e867b563bfaa5a788298d6225bd3a4f9fcbee513089240860101b3662eec9 |
|
MD5 | 548f380a0814536b234a033e2f723fb4 |
|
BLAKE2b-256 | 0238576afd83b5a9da80a0e0a90ce480d23ebc73768f9dae022715bdd124a72b |
Hashes for toon-0.15.6-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 830ad9f7f30646abf7dec189148b85946a15f409f7b9bdeaa244f858e7c914e8 |
|
MD5 | 587797c8cffb4a61a50e8a485e84a4dd |
|
BLAKE2b-256 | dc3051b3a44a1140e1b1f534f98b3a358c8c2d78d5147c2b25f747818edc8973 |
Hashes for toon-0.15.6-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 390164ec62ce6325098ab90116d42022cf53fe93247db514a1cac81d16e26753 |
|
MD5 | 20915a692cf90009c83ab347fdf2e018 |
|
BLAKE2b-256 | b684ab29998d37b4dbb166d9652abd6b335a1ad65aad10d526f9762ec8ff53cf |