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.4-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6aee75ee3b11498a9ab8086703739455be66f4d4dd0b1ca333e0760348c3185 |
|
MD5 | 735b50346188f399a2c6de07e1d70057 |
|
BLAKE2b-256 | 4c92d32f579d95adff87b03cac2029bba79cc66f02ea42ed0e2254f0b49908d3 |
Hashes for asammdf-7.3.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76222d1ddc5ba52e68646505a994ae6ecd65a0c36bc3e1df986fab76e5411508 |
|
MD5 | 64c0585b953c7a2107842b9b4bdff203 |
|
BLAKE2b-256 | 83cc8bf7699c065c8b729e31d47450622b6941b47de5609a5f42a2124644cbac |
Hashes for asammdf-7.3.4-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e23956694ca48650a1e55411abca36bd6db9a94afb9e56082937ca17a75b8ff2 |
|
MD5 | 2487d44c8b4f59a546f87816c2ba8e72 |
|
BLAKE2b-256 | 1d3143768a3bc707c7030209e8ca73decf45cf44272e4e3e19424c8437a69769 |
Hashes for asammdf-7.3.4-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 521da351677bc486eae1efb33ee313fd160df20a42373b43a1d2e8a38b8ce067 |
|
MD5 | 183310eb5c2cd836126753ea34ad478d |
|
BLAKE2b-256 | 5d13c233d547688d94409517744627a1e30888553dbc3c04dae8cfdc2413cac6 |
Hashes for asammdf-7.3.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75d98bb78b22629d68854351ba9d67fba2ed35dabff504ad89c1b30477364545 |
|
MD5 | afda824d55001a1f576cd7017687b006 |
|
BLAKE2b-256 | 1fe9bc6778597c1ad16a14723fdd7ff407911a4ca06c3d94a016555c6f02bbe7 |
Hashes for asammdf-7.3.4-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b346cecea1fbb7aa2d55c21e42aabf24679210d28f2699b5be00cbaa782b642 |
|
MD5 | 03e4c64555048ceef29b43d8456db4c5 |
|
BLAKE2b-256 | 420e3ef045fe1e1584b72fc88adc1269ec478cc4c499595e728ab28fcb06e94d |
Hashes for asammdf-7.3.4-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6970c1465a07049cdbd2b6dd92cabb1f2e140e76d13face7c44783b45a0059c |
|
MD5 | edba72ab246776d4401a426ace98dc40 |
|
BLAKE2b-256 | 07d9328aa54c0569bda9e9d1471536964545bc53e50867a845b00e26e61937b6 |
Hashes for asammdf-7.3.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c230393b3a855579428f93accad44e82d9aff48dc4b5b5b10d8481c4e19d11f |
|
MD5 | 32b8adb468cf1b2ecc7db2c624c32f20 |
|
BLAKE2b-256 | 475bd7cadf64b13625723e09875cfc6aebe6ee05d1631e1d819eb26353d633c0 |
Hashes for asammdf-7.3.4-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36a229d6048bead1fedc963ca7e30d14b165800ed8612665640fde9d11f1a02c |
|
MD5 | e478a21b62311e5b4dfdcb0749001686 |
|
BLAKE2b-256 | 1faaa5c0296e1782335e36e2cf0fdb8c9e171439bdc75a8f21d11f0c614588dc |
Hashes for asammdf-7.3.4-cp38-cp38-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8975e1e8b47ebb5d7c72d9e0cf35943d2f6767062bc9b53ff40c0b57e07e4f8 |
|
MD5 | 761ba04fdf7591256bd6c689b9212b81 |
|
BLAKE2b-256 | 8beb2be941e8f2c82942a3b42e2dc36b17c88cab6fe5fc6b4504f53494deaa3f |
Hashes for asammdf-7.3.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff1f85f49d4d7d7ae7ce30a8b7747b1e70390c177ad73262bbf619d35865348e |
|
MD5 | 24fb0f287559330c10007c7ff04f990f |
|
BLAKE2b-256 | 44f672ed8016720427a523a40e92cd7024165176596ec12d4a9a8b8ac890a896 |
Hashes for asammdf-7.3.4-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34f1b5ceeb82e698bdfe963e4c8552be0ff55b7943965661a9570abde1a2d1ac |
|
MD5 | 72b4b2aa2ecb43b588540e6cdf3a4c2e |
|
BLAKE2b-256 | 409e1662a6cf2bbf2d54aa40bae507f4f127bfd26b26ce0e451b981bff1c2d98 |