Skip to content

Releases: MagneticParticleImaging/MDF

Release 2.1.0

27 Sep 13:13
Compare
Choose a tag to compare

We are pleased to present the 2.1.0 release of the Magnetic Particle Imaging Data Format (MDF) specifications.

  • Added the possibility to store compressed calibration data using a sparsity transformation.
  • The data field in the measurement group has been modified and the fields isSparsityTransformed, sparsityTransformation and subsamplingIndices have been introduced.

Release 2.0.1

16 Sep 06:14
Compare
Choose a tag to compare

We are pleased to present the 2.0.1 release of the Magnetic Particle Imaging Data Format (MDF) specifications.

  • Added optional time field to study group to be able to document the creation time of the study.
  • Lexicographical reordering of all fields within each group to improve readability.

Release 2.0.0

12 Jan 09:02
Compare
Choose a tag to compare

We are pleased to present the 2.0.0 release of the Magnetic Particle Imaging Data Format (MDF) specifications.

For related issues please see milestone Version 2.0.0. The following changes have been made:

  • Version 2 of the MDF is a major update breaking backwards compatibility with v1.x. The major update was necessary due to several shortcomings in the v1.x.
  • The naming of parameters was made more consistent. Furthermore, some parameters moved from one group into another.
  • Defined a complex datatype using a HDF5 compound type. In v1.x it was not possible to store background data. This functionality has been added in v2.
  • We simplified the measurement group and made it much more expressive. In v1.x it was not entirely clear, which processing steps have been applied to the measurement data in the stored dataset. The measurement group now contains several flags that precisely document the state of the stored data. Using this it is now possible to also store calibration data in the measurement group. The calibration group in turn only stores meta- data about a calibration experiment while the actual data is store in the measurement group.
  • Updated Affiliations in the MDF specification.
  • Improved the general descriptions of fields and groups.
  • In v1.x the MDF allowed many fields to have varying dimensions depending on the context. As of version 2.0.0 only one field offers this freedom. This change should make implementations handling MDF files less complex.
  • Number has been introduced as a generic type.
  • Added a table listing all variable names used in the descriptions of parameters.
  • Added a section describing the possibility to add user defined parameters to MDF files.
  • Added a description for optional and non-optional groups and conditional, optional, and non-optional datasets.
  • Added a short section on the code examples on the Github repository.
  • Support for triangle wave forms has been added.
  • Support for multiple excitation frequencies on a drive-field channel has been added.
  • Added the dimension A to all fields of the tracer group to be able to describe settings where multiple tracers are used or tracers are administered multiple times.
  • Added the possibility to store the tracer concentration also for non iron based tracer materials by adding the /tracer/solute field and redefining the field tracer/concentration.
  • Improved documentation for the storage of ADC transfer functions. It is also possible now to store the measurement data as integer data and use a dataConversionFactor to describe the mapping to a physical representation (e.g. Volt)
  • Added support for receive coil to ADC transfer functions.
  • Added support for mean magnetic moment to receive coil voltage transfer functions.
  • Split the /study group into the /experiment group and the study group. This allows to provide more fine grained information on study and experiment.
  • Added possibility to mark the overscan region.
  • Added new section changelog to the MDF documentation to record the development of the MDF.
  • Updated README.md and MDF.bib in the github repository. Updated code examples in the github repository.
  • Added a section on the MDF reference implementation MPIFiles.jl.
  • Since sanity checks will be covered by this package, the description on sanity checks has been removed.

Release 1.0.5

08 Jun 14:29
Compare
Choose a tag to compare

We are pleased to present the 1.0.5 release of the Magnetic Particle Imaging Data Format (MDF) specifications.

This update contains:

  • Fix of #38: Added the possibility to store different channels of reconstructed data.
  • Fix of #37: Added support for receive channels with different characteristics (e.g. bandwidth).
  • Fix of #36: Made dataset /acquisition/receiver/frequencies optional.
  • Fix of #35: Extended the description on the data types, which are used to store data.
  • Added references for Julia and HDF5 to the specifications

Release 1.0.4

11 Mar 12:42
Compare
Choose a tag to compare

We are pleased to present the 1.0.4 release of the Magnetic Particle Imaging Data Format (MDF) specifications.

This update contains:

  • Clarify that HDF5 datasets are used to store MPI parameters

Release 1.0.3

24 Feb 10:06
Compare
Choose a tag to compare

We are pleased to present the 1.0.3 release of the MDF:Magnetic Particle Imaging Data Format specifications.

This update contains:

  • Updated Affiliations in the MDF specification
  • Included data download into the Python and Matlab example code
  • Changes in the Python and Matlab example code to be better comparable to the Julia example code

Release 1.0.2

22 Feb 16:31
Compare
Choose a tag to compare

We are pleased to present the 1.0.2 release of the MDF:Magnetic Particle Imaging Data Format specifications.

This update contains:

  • Mention arXiv paper and bibtex file for reference

Release 1.0.1

10 Feb 08:57
Compare
Choose a tag to compare

We are pleased to present the 1.0.1 release of the MDF:Magnetic Particle Imaging Data Format specifications.

This update contains:

  • A sanity check within the Julia code shipped alongside the specifications
  • An update to the specification documenting the availability of a sanity check
  • Updated MDF files on https://www.tuhh.de/ibi/research/mpi-data-format.html
  • Updated documentation to the Julia, Matlab and Python reconstruction scripts
  • Improved Julia reconstruction script, automatically downloading the required MDF files

Release 1.0.0

01 Feb 10:53
Compare
Choose a tag to compare

We are pleased to present the 1.0.0 initial release of the MDF:Magnetic Particle Imaging Data Format specifications.