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).
- The
Player
can also be used as a mixin, in which case theobj
argument can be omitted fromplayer.add()
(see the demos/ folder for examples). - 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.2-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6c625279f651b583b83c44bb609782dc9fc317b000d723772ff9b5393f6f4b5 |
|
MD5 | 8461e9d66aedfff7e3e6761e55b1fd64 |
|
BLAKE2b-256 | 25676f26ba7bd352f7e70440f9d2d94374e59e95531e06b1f1b20f88e50fb25b |
Hashes for toon-0.15.2-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c84e176e9a64077e908e0dead25021b4ea7fd38bb719b32b3cd109a22b0bfc4 |
|
MD5 | d9a2c9f31ac467495161d66f41522792 |
|
BLAKE2b-256 | c432b194d59573056071f86691d0072cb36a74d17cb11bb84443998fa6f026a3 |
Hashes for toon-0.15.2-cp38-cp38-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 895e33fc50f9414fa6270993e9ffe6710a9e2dff61a07031113d3db85255d7b7 |
|
MD5 | fec0cfdba13c14bff6989764cfa2fa63 |
|
BLAKE2b-256 | dbe52057bcf584ffa1107383938824a0e6587259d78d081d0f35630bf348aa4b |
Hashes for toon-0.15.2-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20bfd52f5e72989a66d23b4efb2ed9372e76329e220ab77da639ca760ff538e9 |
|
MD5 | fc87c7887370b3e2642fe6cc202a30db |
|
BLAKE2b-256 | 17ed4fd531c65bfb8aeab780e037e48140fb00bfb8aeb0a215e5b714ba12a915 |
Hashes for toon-0.15.2-cp37-cp37m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 948a154b4d69cb53d55af40e3451ec68f602b8f26ad3d8d7b301b4d88c44542a |
|
MD5 | 73962a926f39ce250cd50caf7757c2ba |
|
BLAKE2b-256 | 4e1068bf646cde206b275cacab79de13223653cdd49c55771b364b82fe715a4c |
Hashes for toon-0.15.2-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 152513e3bdcabcc0da62fde08b2d0d8e29d35d09d94dac5dff9476aea57a952a |
|
MD5 | e6dbcaf3b6d6be059f4701cdaa911361 |
|
BLAKE2b-256 | 25fea0d30cb5abb667fe4523133408187e0a81251f68146f04a657b89521d113 |
Hashes for toon-0.15.2-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c7b0f3bc55623c4c680ab6a4e8d27a8e575767296259e6258421c44d1eae312 |
|
MD5 | 4289df715d329a6ecf37d0b9f6274221 |
|
BLAKE2b-256 | b6d1db67d5d774642c1561968d0255ef978ca88a0443258300d51d58f24418c6 |
Hashes for toon-0.15.2-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f81b371284bee2f1036d9612503eed443022bc0539040ca01295de7e05891842 |
|
MD5 | 880431552fb8aa2643028387ea2f61ed |
|
BLAKE2b-256 | 7b5b05a307484726783b467b7dddf8d8f68824de04d43ac08adb9343e41ba4b3 |
Hashes for toon-0.15.2-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac59a2cf6aa6ddb89b91a9ef5d547d79dd995032f91ed95ae2aa83fb27b67792 |
|
MD5 | 414c191358476bb94f7a907e94302f61 |
|
BLAKE2b-256 | 32c304b8cdaea36ebda8a695330769f7b361125127866fc18b92537577641ee4 |
Hashes for toon-0.15.2-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 419eb34f1cece5f7f6e13411039b26dc804e6d96f79ba9f66f69153fe30eb993 |
|
MD5 | cba88b058ce10eddd7cae8ffc52da5b8 |
|
BLAKE2b-256 | a2c2fbb6c50ee4edfdc6889836801cfa68087e7f3e9d68bb83d6254044c01503 |
Hashes for toon-0.15.2-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01c9a3fd0586f05f56196fac0962a4e70c1867e23490679ce8b9bd5315d6ab58 |
|
MD5 | 7ccbb66da5f49559c3b1d547bf7465bf |
|
BLAKE2b-256 | 6ee900b3f4f2a998bdd2b831cc0d283082799b846e03b5898a59db3d3cb71b90 |
Hashes for toon-0.15.2-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 614e4535b61d5b4cbb3d8ebc951570b625f28eb262742ab62b36793c7342bf03 |
|
MD5 | efd5bea49938b7590cc6c30bbfa5bce2 |
|
BLAKE2b-256 | 266c024c23670d9576169af76353af3f90b4f03f95b068aa8b82427ecf63a534 |