ASAM MDF measurement data file parser
Project description
asammdf is a fast parser and editor for ASAM (Association for Standardization of Automation and Measuring Systems) MDF (Measurement Data Format) files.
asammdf supports MDF versions 2 (.dat), 3 (.mdf) and 4 (.mf4).
asammdf works on Python >= 3.8
Status
Continuous Integration | Coveralls | Codacy | ReadTheDocs |
---|---|---|---|
PyPI | conda-forge |
---|---|
Project goals
The main goals for this library are:
- to be faster than the other Python based mdf libraries
- to have clean and easy to understand code base
- to have minimal 3-rd party dependencies
Features
-
create new mdf files from scratch
-
append new channels
-
read unsorted MDF v3 and v4 files
-
read CAN and LIN bus logging files
-
extract CAN and LIN signals from anonymous bus logging measurements
-
filter a subset of channels from original mdf file
-
cut measurement to specified time interval
-
convert to different mdf version
-
export to HDF5, Matlab (v7.3), CSV and parquet
-
merge multiple files sharing the same internal structure
-
read and save mdf version 4.10 files containing zipped data blocks
-
space optimizations for saved files (no duplicated blocks)
-
split large data blocks (configurable size) for mdf version 4
-
full support (read, append, save) for the following map types (multidimensional array channels):
-
mdf version 3 channels with CDBLOCK
-
mdf version 4 structure channel composition
-
mdf version 4 channel arrays with CNTemplate storage and one of the array types:
- 0 - array
- 1 - scaling axis
- 2 - look-up
-
-
add and extract attachments for mdf version 4
-
handle large files (for example merging two fileas, each with 14000 channels and 5GB size, on a RaspberryPi)
-
extract channel data, master channel and extra channel information as Signal objects for unified operations with v3 and v4 files
-
time domain operation using the Signal class
- Pandas data frames are good if all the channels have the same time based
- a measurement will usually have channels from different sources at different rates
- the Signal class facilitates operations with such channels
-
graphical interface to visualize channels and perform operations with the files
Major features not implemented (yet)
-
for version 3
- functionality related to sample reduction block: the samples reduction blocks are simply ignored
-
for version 4
- experimental support for MDF v4.20 column oriented storage
- functionality related to sample reduction block: the samples reduction blocks are simply ignored
- handling of channel hierarchy: channel hierarchy is ignored
- full handling of bus logging measurements: currently only CAN and LIN bus logging are implemented with the ability to get signals defined in the attached CAN/LIN database (.arxml or .dbc). Signals can also be extracted from an anonymous bus logging measurement by providing a CAN or LIN database (.dbc or .arxml)
- handling of unfinished measurements (mdf 4): finalization is attempted when the file is loaded, however the not all the finalization steps are supported
- full support for remaining mdf 4 channel arrays types
- xml schema for MDBLOCK: most metadata stored in the comment blocks will not be available
- full handling of event blocks: events are transferred to the new files (in case of calling methods that return new MDF objects) but no new events can be created
- channels with default X axis: the default X axis is ignored and the channel group's master channel is used
- attachment encryption/decryption using user provided encryption/decryption functions; this is not part of the MDF v4 spec and is only supported by this library
Usage
from asammdf import MDF
mdf = MDF('sample.mdf')
speed = mdf.get('WheelSpeed')
speed.plot()
important_signals = ['WheelSpeed', 'VehicleSpeed', 'VehicleAcceleration']
# get short measurement with a subset of channels from 10s to 12s
short = mdf.filter(important_signals).cut(start=10, stop=12)
# convert to version 4.10 and save to disk
short.convert('4.10').save('important signals.mf4')
# plot some channels from a huge file
efficient = MDF('huge.mf4')
for signal in efficient.select(['Sensor1', 'Voltage3']):
signal.plot()
Check the examples folder for extended usage demo, or the documentation http://asammdf.readthedocs.io/en/master/examples.html
https://canlogger.csselectronics.com/canedge-getting-started/log-file-tools/asammdf-api/
Documentation
http://asammdf.readthedocs.io/en/master
And a nicely written tutorial on the CSS Electronics site
Contributing & Support
Please have a look over the contributing guidelines
If you enjoy this library please consider making a donation to the numpy project or to danielhrisca using liberapay <a href="https://liberapay.com/danielhrisca/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>
Contributors
Thanks to all who contributed with commits to asammdf:
Installation
asammdf is available on
- github: https://github.com/danielhrisca/asammdf/
- PyPI: https://pypi.org/project/asammdf/
- conda-forge: https://anaconda.org/conda-forge/asammdf
pip install asammdf
# for the GUI
pip install asammdf[gui]
# or for anaconda
conda install -c conda-forge asammdf
In case a wheel is not present for you OS/Python versions and you lack the proper compiler setup to compile the c-extension code, then you can simply copy-paste the package code to your site-packages. In this way the python fallback code will be used instead of the compiled c-extension code.
Dependencies
asammdf uses the following libraries
- numpy : the heart that makes all tick
- numexpr : for algebraic and rational channel conversions
- wheel : for installation in virtual environments
- pandas : for DataFrame export
- canmatrix : to handle CAN/LIN bus logging measurements
- natsort
- lxml : for canmatrix arxml support
- lz4 : to speed up the disk IO performance
- python-dateutil : measurement start time handling
optional dependencies needed for exports
- h5py : for HDF5 export
- hdf5storage : for Matlab v7.3 .mat export
- fastparquet : for parquet export
- scipy: for Matlab v4 and v5 .mat export
other optional dependencies
- PySide6 : for GUI tool
- pyqtgraph : for GUI tool and Signal plotting
- matplotlib : as fallback for Signal plotting
- cChardet : to detect non-standard Unicode encodings
- chardet : to detect non-standard Unicode encodings
- pyqtlet2 : for the GPS window
- isal : for faster zlib compression/decompression
- fsspec : access files stored in the cloud
Benchmarks
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 asammdf-7.3.6-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d3bd906b8b4f168ecf796cf75e40dd5f965c97a07fcd7ea425512c42fc47666 |
|
MD5 | 9a26d40f9a420e0e1f444b2d922dc98a |
|
BLAKE2b-256 | 8b8e59074fe7c3386f522e612bd44f3db9a0366f453db3216d9007df8380fa36 |
Hashes for asammdf-7.3.6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b29ce5204f66a67761f4c7960cd04b169bcee8ce1d4764d2a51f5851348e70e |
|
MD5 | 42debddefadf7d54ad7fbc20ccd81dd2 |
|
BLAKE2b-256 | a47fba9bb910ab21399e7ed1f07bb5f9867f42b59ad564c4c4a179959469ed81 |
Hashes for asammdf-7.3.6-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a69956050c1d0144565b3966c98a5eac0b43185a072df45c2f8df1b3c08d6e7d |
|
MD5 | adb2d87328bd443edbfc5ee3667dde36 |
|
BLAKE2b-256 | 3b13530cca4ba15f039a6b3fb5d7603f42eac2e6da047d1b497b8d7ab0de628a |
Hashes for asammdf-7.3.6-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08145414c4769e546aaaf2ebe6f29853e52c6b19e8ed103faa01a32099aa2ab2 |
|
MD5 | 9573b7500756f68c7531e4c66f34f6a5 |
|
BLAKE2b-256 | 614ae7ea8390657b830c9403935aa9699d9f9045aac8906294fa91852276faed |
Hashes for asammdf-7.3.6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80c82585ef8839c2b18da2679dc8ee1563745cc6cdc4166f36a1e909ebbc6805 |
|
MD5 | c0e928616675a67c1522dffb2525b1ee |
|
BLAKE2b-256 | 28bed45294d75bb4a025221ed91b1034632294573eb80c15b973334d8d6700e1 |
Hashes for asammdf-7.3.6-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fde5836ab8ce27ee9c77aea7fe5190fb49fc977dab6d05ff87d86c5b714b4872 |
|
MD5 | e12faa8f4b544ad73f92d93ebebd3fa7 |
|
BLAKE2b-256 | 6666cebe88318e0dd979c4e36889866c3d2a50b41442364bab098e772f1e2721 |
Hashes for asammdf-7.3.6-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f749478098099a7f3b2b27ac67306808d05c352389d2a39ae7d361842482174b |
|
MD5 | f95821a3110e4fcfdb4a74f58954c4e3 |
|
BLAKE2b-256 | fce2528badc63b1ce57a98927ef8744716e422cf5fcfa3e90bb1953246c92cde |
Hashes for asammdf-7.3.6-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db99f5f6b6c4d55f1308c712b67bc916df534ae40813519073ce909cdb357277 |
|
MD5 | 23f38c29a94c74c261a86b4ac7f5948f |
|
BLAKE2b-256 | 2b5501a3b452b7a7402a2cfc63c86fe5613826181ac9342dc087e9f4659ba36c |
Hashes for asammdf-7.3.6-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6524c764fcbd62834694ae004cf560559be1d135b96fdedfd1e02c49fc303173 |
|
MD5 | 537171cc05ffdb62046caa8b30ee25b7 |
|
BLAKE2b-256 | a11074c55a3d703f26ddbe4ecaf2d6d5641c6844e87e5f9715776f5e0b9924a1 |
Hashes for asammdf-7.3.6-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da5d86efe3ec008c0b657df021fa4d3330948139fbc9e3bbed57fac5bca34f1e |
|
MD5 | bc244498671ba149c9062fdd0df20a46 |
|
BLAKE2b-256 | a41e3ec15335ad393b2ea1eb0bf8c8422d47fd4e062f81eed39e390f320ba8b5 |
Hashes for asammdf-7.3.6-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00f7b5b3e8fc94d54bca914ac46ea768b772d639b9fbdd2019018568de046f68 |
|
MD5 | 44fad669ba2151748ff4b9fb0344b418 |
|
BLAKE2b-256 | 1b41f07daccabcdff15828ca2e6771be84742538a167723d86f11b01c9a21df6 |
Hashes for asammdf-7.3.6-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfe554c62cf7c922da029f3283cf14a33e87e4a977eb463ef88c296035465621 |
|
MD5 | c89fb8b85b9b97d0e57d18280b13bee1 |
|
BLAKE2b-256 | beb670bac3f156ad869ab4e488d81f6db86e44df1110f7fcd962b30657747d02 |