Pseudonymisation Tool#

Experimental command line DICOM tools.

If you wish to utilise standard anonymisation, please instead use pymedphys dicom anonymise as opposed to pymedphys experimental dicom pseudonymise.

usage: pymedphys experimental dicom pseudonymise [-h] [-o OUTPUT_PATH] [-d]
                                                 [-f] [-c]
                                                 [-k [KEYWORD [KEYWORD ...]]]
                                                 [-p] [-u | -i]
                                                 input_path

Positional Arguments#

input_path

Input file or directory path. If a directory is supplied, all DICOM files within the directory and its subdirectories will be pseudonymised

Named Arguments#

-o, --output_path

Output file or directory path.

-d, --delete_original_files

Use this flag to delete the original, non-pseudonymised files in the processed directory. Each original file will only be deleted if pseudonymisation completed successfully for that file.

Default: False

-f, --preserve_filenames

Use this flag to preserve the original filenames in the pseudonymised DICOM filenames. Note that ‘_Anonymised.dcm’ will still be appended. Use with caution, since DICOM filenames may contain identifying information

Default: False

-c, --clear_values

Use this flag to simply clear the values of all of the identifying elements in the pseudonymised DICOM files, as opposed to replacing them with ‘dummy’ values.

Default: False

-k, --keywords_to_leave_unchanged

A space-separated list of DICOM keywords (e.g. ‘PatientName’) to exclude from pseudonymisation and error checking.

-p, --keep_private_tags

Use this flag to preserve private tags in the pseudonymised DICOM files.

Default: False

-u, --delete_unknown_tags

Use this flag to delete any unrecognised tags from the pseudonymised DICOM files.

Default: False

-i, --ignore_unknown_tags

Use this flag to ignore any unrecognised tags in the pseudonymised DICOM files.

Default: False