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.7-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c92e2d59a8bfdaac1a27fd82a29df20099c4067e58c9bdb3df74e91003c214d3 |
|
MD5 | 4321ebe30e49b7b364bff15e8387e008 |
|
BLAKE2b-256 | e354ab6075d29888b50076e53ad514e83530b9c2ad3f9930945d70e831df7ab7 |
Hashes for toon-0.15.7-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8e2a5539a9a78b50516b573821d143c4211ac4b6441eb265841735c78a66b19 |
|
MD5 | 9a53433300b137a8ffe625996fda6530 |
|
BLAKE2b-256 | cbe5da07fefec8ae0325ea1adfcd4f1b2a0bcacafcff77321cab7dad0da29dab |
Hashes for toon-0.15.7-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b3dd5c89dc2ebb6fbd7fae3d53beeafb7d458cb77724d5b5fe1b1569cc7eb96 |
|
MD5 | 74a62b69de18bb1ccc36228157a40fa3 |
|
BLAKE2b-256 | a06f5aff8a1c4ce50958046cac69c631e244c4b584c4d7723efbafdcd05bdc70 |
Hashes for toon-0.15.7-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f5470cb599b3cc693d324207a379ddb81713aae63711846d7822b17881ca9e6 |
|
MD5 | 552a1f74cbdfbd099aff2e9266c8d8f7 |
|
BLAKE2b-256 | 9761f81b5a23bfcac7de23fc9da609db13365ca2d157b47c1d0f6c25aa819104 |
Hashes for toon-0.15.7-cp37-cp37m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f25f1559ac4c0256f1e1b35fa7b06599e00357259f29ff1bce5b543f1fed9d9 |
|
MD5 | f82bd0780bce2841d28b44b33c62f908 |
|
BLAKE2b-256 | ba2f73bdf873d8c41c97b320a3e7754707a3569881bf7651bf674696782cfb59 |
Hashes for toon-0.15.7-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82d1b3aa2f913e901124f6a9e9d7b9e669a995596aeef26c9c371d276f670eb0 |
|
MD5 | dd4936480cab5eec769bacddb5c4c769 |
|
BLAKE2b-256 | ab0275891fb3a0e3a653cec86da4a372355e1a3e891fb0c275cb2ec27f421601 |
Hashes for toon-0.15.7-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93ecc398a91bc607ab86fe7f88665ff2e5d5f98339a2ab0f457085d4b88ed9ad |
|
MD5 | 6915ae7f1b7046b8e58b62e3c11b5d0e |
|
BLAKE2b-256 | 70e9f8ad681a981a8a836c9a1a3f0766d669ff627b11fdf05e07d9b8937dffe0 |
Hashes for toon-0.15.7-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7008b4543cbdb998d340972b1a55fe65a57d50f80f69f89b26f2ca36ea24fb2 |
|
MD5 | 0ba55b416bca1177cb52667a39e4dcb2 |
|
BLAKE2b-256 | 55d7a35cd4d32acbb9dd05e74ffa13af169a17feab44b10b5accfc0bd2fb315a |
Hashes for toon-0.15.7-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36ac0d22a266288db86bba1a785fb919d51585e921367e67e691a289c374a9e4 |
|
MD5 | 49f289c28190f766309aee56bb634adf |
|
BLAKE2b-256 | 1e789cdd83868942881abaf36aced585a5048ad15545920978c165bd0152dc58 |
Hashes for toon-0.15.7-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7ad029194b0dc70eb6d72931768dcafe8f295251582cee313255ebe4484c076 |
|
MD5 | e061c56480b61de472650df790494e43 |
|
BLAKE2b-256 | d9ee32176efdcbcd55c4397f9c351b364447a1287faf9000f617e181a25aed69 |
Hashes for toon-0.15.7-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3be879a5beaf1910437f0e76f8448d9a7170850525f944fcc0aa81e7457a113 |
|
MD5 | b372f8c4b3b3613a219c8efc4eccb936 |
|
BLAKE2b-256 | e9eaeaf29ab070e1693bbd90549ec0e41b19eba900644dcb81ca0ead8e77b1e3 |
Hashes for toon-0.15.7-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 195b0f83d30d0ca4558d40d19cec7e6c645630ce2f33d7949e554847727de6cb |
|
MD5 | 978644e8070ca584e68cce45dc61c75f |
|
BLAKE2b-256 | 9000aeebdb3bd0adc914a01abab856c07fc2107f9ec67e3c44c6370d8c2c948e |