Skip to main content

A Python/C++ library for the analysis of Differential Dynamic Microscopy experiments

Project description

FastDDM

Python GitHub Actions PyPI Version Read the Docs License: GPL v3

FastDDM is a Python package for the analysis of microscopy image sequences using Differential Dynamic Microscopy on CPU and GPU. The features implemented are targeted at the experimental soft matter research community dealing with inert and active/biological samples.

Resources

Example scripts

These examples demonstrate some of the Python API.

Calculation of the image structure function and its azimuthal average:

import fastddm as fddm

file_names = [...]  # define here your list of image file names 
images = fddm.read_images(file_names)

pixel_size = 0.3    # um
frame_rate = 50     # frames per second
    
# compute image structure function and set experimental parameters
dqt = fddm.ddm(img_seq, range(1, len(img_seq)))
dqt.pixel_size = pixel_size
dqt.set_frame_rate(frame_rate)

# compute the azimuthal average
aa = fddm.azimuthal_average(dqt, bins=dqt.shape[-1] - 1, range=(0.0, dqt.ky[-1]))

Contributing to FastDDM

Contributions are welcome via pull requests after agreeing to the Contributors' Agreement. Please, refer to the Developers' section in the documentation.

Please, report bugs and suggest features via the issue tracker.

Citing FastDDM

Please, cite this publication in every work that uses FastDDM:

E. Lattuada, F. Krautgasser, F. Giavazzi, and R. Cerbino.
The Hitchhiker’s Guide to Differential Dynamic Microscopy.
(In preparation.)

License

FastDDM is available under the GNU GPL-3.0 license.

Acknowledgements

  • The fftw-3.3.10 and pybind11 2.10.0 libraries are included in the source tree.
  • This project was funded by the Austrian Science Fund (FWF), Grant Number M 3250-N.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastddm-0.3.10.tar.gz (42.6 MB view hashes)

Uploaded Source

Built Distributions

fastddm-0.3.10-cp312-cp312-win_amd64.whl (651.5 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

fastddm-0.3.10-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

fastddm-0.3.10-cp312-cp312-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

fastddm-0.3.10-cp312-cp312-macosx_10_9_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

fastddm-0.3.10-cp311-cp311-win_amd64.whl (651.4 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

fastddm-0.3.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

fastddm-0.3.10-cp311-cp311-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

fastddm-0.3.10-cp311-cp311-macosx_10_9_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

fastddm-0.3.10-cp310-cp310-win_amd64.whl (648.9 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

fastddm-0.3.10-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

fastddm-0.3.10-cp310-cp310-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

fastddm-0.3.10-cp310-cp310-macosx_10_9_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

fastddm-0.3.10-cp39-cp39-win_amd64.whl (649.3 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

fastddm-0.3.10-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

fastddm-0.3.10-cp39-cp39-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

fastddm-0.3.10-cp39-cp39-macosx_10_9_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

fastddm-0.3.10-cp38-cp38-win_amd64.whl (649.2 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

fastddm-0.3.10-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

fastddm-0.3.10-cp38-cp38-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

fastddm-0.3.10-cp38-cp38-macosx_10_9_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page