No project description provided
Project description
LiberTEM-dectris-rs
This is a Python package for efficiently receiving data from DECTRIS detectors with the zeromq interface. The low-level, high-frequency operations are performed in a background thread implemented in rust, and multiple frames are batched together for further processing in Python.
Usage
import numpy as np
import libertem_dectris
from libertem_live.detectors.dectris.DEigerClient import DEigerClient
# trigger acquisition via the REST API, needs `libertem-live`
nimages = 256 * 256
ec = DEigerClient('localhost', 8910) # hostname and port of the DCU REST API
ec.setDetectorConfig('ntrigger', 1)
ec.setDetectorConfig('nimages', 1)
ec.setDetectorConfig('trigger_mode', 'exte')
ec.setDetectorConfig('ntrigger', nimages)
result = ec.sendDetectorCommand('arm')
sequence_id = result['sequence id']
conn = libertem_dectris.DectrisConnection(
uri="tcp://localhost:9999",
handle_path="/tmp/dectris_shm",
frame_stack_size=32,
num_slots=2000,
bytes_per_frame=512*512,
huge=False,
)
# as we have armed the detector above, we know the sequence number
# that we should expect:
# (in other cases, can also call
# `conn.start_passive` and `conn.wait_for_arm` to passively wait for
# the detector to be armed)
conn.start(sequence_id)
# any other process can use a `CamClient` to use data
# stored in the SHM:
cam_client = libertem_dectris.CamClient(conn.get_socket_path())
try:
while True:
# get at most `max_size` frames as a stack
# (might get less at the end of the acquisition)
stack_handle = conn.get_next_stack(max_size=32)
# if the receiver is idle, stack_handle will be None here:
if stack_handle is None:
break
# the expected shape and data type:
frame_shape = tuple(reversed(stack_handle.get_shape()))
dtype = np.dtype(stack_handle.get_pixel_type()).newbyteorder(
stack_handle.get_endianess()
)
# pre-allocate some memory for the pixel data:
# (would be pulled out of the loop in real code)
buf = np.zeros((len(stack_handle),) + frame_shape, dtype=dtype)
# decompress into the pre-allocated buffer
cam_client.decompress_frame_stack(stack_handle, out=buf)
# free up the shared memory slot for this frame stack:
cam_client.done(stack_handle)
# we can still use the decompressed data:
buf.sum()
finally:
conn.close() # clean up background thread etc.
cam_client.close()
Changelog
v0.2.3
- Add
env_logger
: set environment variableLIBERTEM_DECTRIS_LOG_LEVEL
to e.g.'INFO'
to enable logging - Improved error handling: raise an exception instead of panicing on serialization errors
- Ignore messages with mismatching series ID
- Add explicit checks for the correct
header_detail
levels - Move code into monorepo
v0.2.2
- Vendor
bitshuffle
and addFrame.decompress_into
method, PR #10
v0.2.1
- Catch frame ID mismatch, PR #9
v0.2.0
- Added
libertem_dectris.headers
submodule that exports header classes - Added ways to create
libertem_dectris.Frame
andlibertem_dectris.FrameStack
objects from Python, mostly useful for testing - Added binding to random port for the simulator
- Properly parametrize with zmq endpoint URI
- Fix many clippy complaints
v0.1.0
Initial release!
Development
This package is using pyo3 with
maturin to create the Python bindings. First, make sure
maturin
is installed in your Python environment:
(venv) $ pip install maturin
Then, after each change to the rust code, run maturin develop -r
to build and
install a new version of the wheel.
As we vendor bitshuffle
, make sure to clone with git clone --recursive ...
, or manually
take care of initializing and updating submodules.
Release
- update changelog above
- bump version in Cargo.toml if not already bumped, and push
- create a release from the GitHub UI, creating a new tag vX.Y.Z
- done!
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 libertem_dectris-0.2.4-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 295d6570e42c4ef6ed94084aee82eb53969f1cdaaa98695bfb2e49a143072c85 |
|
MD5 | ed2cfaf64f1dca516e711f5778b5b8c3 |
|
BLAKE2b-256 | e463478b7f8d603013a86fa45abe1770ad288cbd633fd5e0d76d0034cfd77585 |
Hashes for libertem_dectris-0.2.4-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 113dcc16393dd2ff14695d75f1b264efaa72949c10da984524261fa90391cb14 |
|
MD5 | 81b8d0ef24c7e909b3438b675490befa |
|
BLAKE2b-256 | 2c0bbb18c34449e373f5e2d8719ae0a985a997b19e33e62cf92e6dfb735b5ddd |
Hashes for libertem_dectris-0.2.4-cp37-abi3-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f07f1f29fbe54e45599fe179008a4eb86e835893d2723fdf7b62f7a16e2afb5 |
|
MD5 | 4b668d624c0a82c6b1db239444de2849 |
|
BLAKE2b-256 | 0a539a2e65c2bfc14a6509bfefd341d3c5df64ee52c997398557285cf4d1e855 |
Hashes for libertem_dectris-0.2.4-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e8bfc1c25c723ee8ff5e72859101e9cca285c575b56f17f40100c582e1b1543 |
|
MD5 | 44f806c3591b07fe607647c6aa26d421 |
|
BLAKE2b-256 | 1399679d8728ee089687e253b2145bc1c0c49ef51b73294603fce7a714bc3446 |