Skip to main content

This is a small python package to create a Electromyogram (EMG) Intensity plots for facial muscles with facial structure.

Project description

electromyogram

Teaser

This Python package provides a convenient way to create an Electromyogram (EMG) Intensity plot specifically designed for facial muscles with facial structure. With this tool, you can visualize and analyze the intensity of EMG data collected from various facial muscles.

A small demo is hosted here, together with the tool face-projection for a projection onto the face.

Why use sEMG Intensity Plot?

  • Easy to use: The package provides a straightforward interface, making it accessible for users of all levels of expertise.
  • Visualize muscle activity: The EMG Intensity plot allows you to visualize the intensity of muscle activity over the face, providing insights into patterns and variations.
  • Designed explicitly for facial muscles: The tool focuses on facial muscles, enabling you to study and understand muscle activity in the face, which can be particularly useful in fields like facial expression analysis, neuroscience, and rehabilitation.
  • FACS: Visualize the Facial Action Coding System at the correct anatomical locations for a more intuitive understanding of the data.
  • Potential for extension: While the current focus is on facial muscles, this tool could potentially be extended to analyze other muscle groups.
  • Beyond muscles: The tool can also be used to plot additional facial information, such as oxygen saturation, but this is not officially supported yet.

Installation

The package is available on PyPI and can be installed with pip:

pip install electromyogram

If you want to install it locally to add changes, please close the repository and install it with pip in development mode. We assume you already created a virtual environment and activated it :)

git clone <link to this repository>
cd electromyogram
pip install -e .

Quickstart

This tool is intended to simplify the creation of only the spatial intensity map for surface EMG data. All the required preprocessing of the data is not part of this package and is likely project-specific. We assume that the data is given in a dictionary (or pandas table) and the keys are the sensor locations.

Then, the correct physical interpolation between the sensors is done, and the result is a 2D array of the interpolated values on the canonical face model. You can then apply different color maps to the interpolation to create the final plot. We provide detailed examples in examples/.

import electromyogram as emg

# we assume that the data is given in a dictionary and the keys are the sensor locations
data_values = dict(...)

scheme = emg.Fridlund()  # or emg.Kuramoto()
# create the interpolation
powermap = emg.interpolate(scheme, data_values, shape=(1024, 1024))
powermap = emg.colorize(powermap, cmap='viridis')

For the colorization, the users can use any color map from matplotlib or pallettable (e.g., pallettable.scientific.sequential.Imola_20) Colors

Surface EMG Schematics

We currently support the two following schematics for acquiring the EMG data. If you want to have your own, please open an issue or create a pull request, and we will be happy to add it.

Fridlund and Cappacio, 1986 Kuramoto et al., 2019 Ekman and Friesen - FACS
Locations Locations Locations

If you want to define your custom scheme, create a new class inherited from emg.Schematic and implement the locations member. If you support the mirroring of the face, implement the pairs_L and pairs_R members. Then, use it in the interpolate function, and you are good to go.

Todos

  • Handle if not all values are given for a better schematic
  • Add result images
  • Add a function to draw triangulation onto the 2D canvas
  • Add a function to draw sensor locations onto the 2D canvas
  • Add the option to remove the area outside the canonical face model
  • Make a better interface for the channel names (mapping to defined terms)
  • Add function to create the according colorbar for matplotlib in the correct size

License

MIT License

Citation

If you use our work, please cite us:

under publication, please wait a bit :)

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

electromyogram-1.1.1.tar.gz (4.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

electromyogram-1.1.1-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

Details for the file electromyogram-1.1.1.tar.gz.

File metadata

  • Download URL: electromyogram-1.1.1.tar.gz
  • Upload date:
  • Size: 4.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for electromyogram-1.1.1.tar.gz
Algorithm Hash digest
SHA256 83090c80b12144f11d6f5b6b29f7c26c002945092df380011d635b118bd3fda4
MD5 3146e775063b2b9dc2ab6405c0cc4340
BLAKE2b-256 bfec72d0f2df66c1a8c5f6320e90dbe71cb573493c87e394a691ccf493efac40

See more details on using hashes here.

File details

Details for the file electromyogram-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: electromyogram-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 21.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for electromyogram-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e730613fb87f3e211f05e55f85c25897c73bfe97462948fc06b100c15104e1c8
MD5 137ff91bf938db46cf25689fce626275
BLAKE2b-256 e9f72db0f781450663c8a362ce56ce1f6eb3eab8b82ea452b67745a965a78a2b

See more details on using hashes here.

Supported by

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