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.5-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7cf229f39281bb0d72ebaabc963649e8e7e735f81b59d47d5b40ad4dd23dd62 |
|
MD5 | 86582845b3b23f0d9c53c12add162014 |
|
BLAKE2b-256 | 1b127a15271f4ef1dc7549c6285c338397a2ebd34d2797eaf28ef2fa623f577f |
Hashes for toon-0.15.5-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4648277da06c618f4060b38965896dabb429c937d6077442b54ab5f92246dcc2 |
|
MD5 | 3ff725ba35da6d1e89b3447713cbcbaa |
|
BLAKE2b-256 | 591f92df5b5fb3b3f635729113f0298fbd5c147d5030d869cae85d35e4a24386 |
Hashes for toon-0.15.5-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2ceb0edbd4a7543d68ff0f6c89d3a948601b4a7302179e024780ea33dbed3d3 |
|
MD5 | d309fa661dfaae1a34e409c5e9431aec |
|
BLAKE2b-256 | 2ce26dbf3de8edcea61ca66ea11ae3894ed6816d7886d2ff23e92e8bbfe5f030 |
Hashes for toon-0.15.5-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b572471023a9bb48b212f638e05510cc98b6ecc105a8b9eb4f60075213df0ee |
|
MD5 | e7d1cf3c10d09b4f7ac11c77f56d905f |
|
BLAKE2b-256 | ae7092da85c0d9a5354cff4a1ab51e63976da15d3d8dcb6c84c65c49f40b98f8 |
Hashes for toon-0.15.5-cp37-cp37m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d5bca4819623da32ea8006b202d60371d25438e33801620c3eafc12f5e54559 |
|
MD5 | 7165e69d7783cccee26b643ebe6f3362 |
|
BLAKE2b-256 | 498cebd9752a986fffbaa63ee286876364f8b81bc8596fcbb10e55e14e8323b6 |
Hashes for toon-0.15.5-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9071ba3322214171c9d6b0ca5505d11a9de97b8bf31057bc4e7d6e24557cf64 |
|
MD5 | 4400374e05b69cb93b6de7f89e1bc4f5 |
|
BLAKE2b-256 | 0d1000482b8266442a15cb80efc86b3f3ecf0bfc4ce82dd26af6f6b64de115d7 |
Hashes for toon-0.15.5-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7220fc90ea266ddb6f2134416fb3a1f93272477aa4ffef03fc5f59ebb77016eb |
|
MD5 | d4dc40d6a7cb5b03b05a0b7268404e26 |
|
BLAKE2b-256 | e576e2c14d994d0bffdfc83ae3ad68016735068a2e3a686e2ee29e4bccb94cf4 |
Hashes for toon-0.15.5-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c395742c84bd8814df363f1bd0e3f68a8aa206c825b67ef852194b9dec54630 |
|
MD5 | ee564b7ab1ab0df29e66d4836d421046 |
|
BLAKE2b-256 | e07e87b090d377cb7534bc47601471c3940c36ba675e25534df44758e1233503 |
Hashes for toon-0.15.5-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19a10ee41444918e6904badb77f38bee3e25a20dd86aae3802f1ba024b29dde1 |
|
MD5 | 6ab881d18c9f47323e59123de6e85dbb |
|
BLAKE2b-256 | 040be68a16d6efaa1704d29168ebed89650cc048466dd2bdbaf9fcdc05371d7c |
Hashes for toon-0.15.5-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9488daff97de5b217af2939d1450a50d3e6d84abbdf5dae82393ea50a94a43a5 |
|
MD5 | eda8b9cf83963cdf7d64557d2a844489 |
|
BLAKE2b-256 | 9412df04b41ec33bff9a9f374bc6c09903e919cffbe4b77fac1a4e2f83e74f2c |
Hashes for toon-0.15.5-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e037a9827f69c3ebb3b95b235b727c83252e02a533f8e7c94a1211eb26bcc5e |
|
MD5 | 170912f77bf88fba271f954d88cd31b3 |
|
BLAKE2b-256 | 2b94d3c0eb8ff2ec66067f340f32b47670ff4c7a457698831dd412e2b2f20563 |
Hashes for toon-0.15.5-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba550a042202c6111844ae205bb884d06f59500b37e4ea3c90793d9724a4fcf2 |
|
MD5 | 512a45777f7879862714bc98bb5856b6 |
|
BLAKE2b-256 | 9b987a7168f87a7d00f8d13e510dfde2eb0d0e03566ba32d938dd34731c9da07 |