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.4-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dafc06329237e84c64408fc2af061ee1318550a22c7630d0192071cc456e56ef |
|
MD5 | ec194b065edc8947c880b153d903d89d |
|
BLAKE2b-256 | 4edb5f133aaf03aa70ee9ffe99b4feeaa550313d96718058e1811f0244680968 |
Hashes for toon-0.15.4-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c24b28d3b341442c01a4548c14dc982247d1edc60594ef54f2ee8643b12995d9 |
|
MD5 | 5a094038b074e74f87d7fa76c46e25fb |
|
BLAKE2b-256 | 1cb89ff1de9da0438e927e19570cef4cc8bc23701c3da6a0be15e47139802962 |
Hashes for toon-0.15.4-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3021c120350a4f841d90bdab4b75d62028b6aa662845e00b6b155fd9b8515498 |
|
MD5 | 182d707d6d468a2bdcc5b31099eefba9 |
|
BLAKE2b-256 | 5d3bd3724b908fa154f2cc2c09a95869bf023faee4e65352997f42c47a7fc268 |
Hashes for toon-0.15.4-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdd5eab3c2c95d2f6a7d1dba13523fbff42501e2d5371d29dea2e6c2689dc733 |
|
MD5 | b7e2eeac41120bcd15df440beb02d10a |
|
BLAKE2b-256 | c2f58f22eca1c932ab4dbecef2fee8c25ad113421584d9e375cc0247eb82b00b |
Hashes for toon-0.15.4-cp37-cp37m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7223a8a414c408abb8df52f4eea3e0cf7721f5ee6b6fac23a47f3e2e5ff5ffb8 |
|
MD5 | 2da0f5b7c55badf93fe2dd2f9316921c |
|
BLAKE2b-256 | 795362be5b477075d08786d6cf461ee1498f599b939ba28e2d95b4c2863df569 |
Hashes for toon-0.15.4-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69831aefb93658ff0e39b20e2e79254661060c3b27117e53bb98f03f1c7d0a31 |
|
MD5 | c6b37bc049763127712e8b242d6680c0 |
|
BLAKE2b-256 | 3d1ae07e4be56598502b6d968bafba4a32b640dc48724dbe1a1afc2ddfea1d80 |
Hashes for toon-0.15.4-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb60beb76b74561f2e7055b90b69142046381fc96908d96c5ad91ae481ffaf93 |
|
MD5 | 809c68b6fa1356a2146abdbfb10e792f |
|
BLAKE2b-256 | 3e1b075616db7d9610faaa0beadadc72846f6cef8414cc93f42eebfbd1ce0478 |
Hashes for toon-0.15.4-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 931e06e160fbbace234c0ae14c958bad849545fb44114c07696c59668b2dd752 |
|
MD5 | c78a25274892c046d9b0f37982cf1315 |
|
BLAKE2b-256 | e5a6b3a117323ac8cbeb33914afa05416f1c6f3b9bb62bb1cb270227a86cc22c |
Hashes for toon-0.15.4-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7268d61927caea75458ce4757ad88547b13b9a88c49b25360ab4ce2881d009fc |
|
MD5 | 409d5b429779f862862df0148f2fc2ee |
|
BLAKE2b-256 | b5ae3fe162c0d8a83cfb7e7c239e58109d2e1c92948453158457d8cc6742223f |
Hashes for toon-0.15.4-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec6f13e4f2cc81e15be6c55e49f406795cdb1b9e38c320fe0802200fcf494a30 |
|
MD5 | 24acaf0a0960927d085877d3c749d081 |
|
BLAKE2b-256 | e289476e55cd3a1f247f63bf24c9ab17eae0dbc16bc8cee7e2b9ff9fd93f8ed9 |
Hashes for toon-0.15.4-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca615288dabd0ae2d34afa69cf4130777893700ce6b7c3f13b350f64aa212b0d |
|
MD5 | d8bd4ab329aa9a225c6cc2b1d0c7bef9 |
|
BLAKE2b-256 | cd7a019e86ab98e5e55ff0f479e89ccc5575cf2119386dea5aac123a144daa81 |
Hashes for toon-0.15.4-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb1e783c7874240971aa28aa386a429ba460d4dbac46aaaf9a07652cae5c14fd |
|
MD5 | 66a4005d1d35693916a3e1ecdca04a59 |
|
BLAKE2b-256 | 29ecd0550421c785a47efa40ca43e862f1bbb13437028fec9adb264697337be8 |