TwixMRIAnonymizer

Getting started • Usage • Roadmap • Credits

Twix MRI Anonymizer is a lightweight Python anonymization-tool for Siemens MRI raw data format twix.

Twix data contains multiple headers. while the dicom header, often saved as ['hdr'] is easily anonymizable, the much larger header ['hdr_string'] is often overlooked, but contains all the same information as the general header, as well as a detailed overview of the scan settings.

If anonymization is performed only on the first header, all the information contained in the latter will be pasted back into ['hdr'] when saving the "anonymized" file. This brings up the necessity and chances of the following code, which scans the ['hdr_string'] for all informations which need to be anonymized and additionaly can save useful metadata for further tasks.

While the main focus lies on the anonymization of MRI twix files, this tool also allows researchers to extract important metadata, such as sequence name, TR/TI and acceleration factor, for a large amount of data and saved in a csv overview.

Getting started

1. Clone repository:

   git clone https://github.com/TIO-IKIM/TwixMRIAnonymizer.git
   

2. Create a conda environment with Python version 3.11.2 and install the necessary dependencies:

   conda env -n anonymizer python=3.11.2 -f requirements.txt
   

   In case of installation issues with conda, use pip install -r requirements.txt to install the dependecies.

3. Activate your new environment:

   conda activate anonymizer
   

4. Run the script with the corresponding cli parameter, e.g.:

   python3 anonymization.py --i your/input/path --o your/output/path
   

Alternative pip installation from inside the repository folder:

   pip install -e .

Usage

Anonymization CLI

usage: anonymize.py [-h] [--i I] [--o O] [--f] [--meta_only]

options:
  -h, --help   show this help message and exit
  --i I        The path to the TWIX file or directory containing TWIX files to be anonymized.
  --o O        The path to save the anonymized files.
  --f          If set, force overwrite existing files. Defaults to False
  --meta_only  If set, only save the metadata, but do not write anonymized file. Defaults to False

Roadmap

Pip Package

Script will be wrapped into a package and published on pip.

Credits

Parts of the code of TwixAnonymizer is based on the great package Suspect by Ben Rowland, et al. for MRS processing.