Skip to content

Commit

Permalink
BUG: Fix example in README
Browse files Browse the repository at this point in the history
  • Loading branch information
pchoisel committed Aug 5, 2024
1 parent 87606ce commit 3cd5853
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 7 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.python-version
.vscode
Data
env
__pycache__
.vscode
build
*.egg-info
dist
env
.python-version
dist
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
Python package to anonymize DICOM files.
The anonymization answer to the standard . More information about dicom fields for anonymization can be found [here](https://dicom.nema.org/medical/dicom/current/output/html/part15.html#table_E.1-1).

The default behaviour of this package is to anonymize DICOM fields referenced in [dicomfields](dicomanonymizer/dicomfields.py).
The default behaviour of this package is to anonymize DICOM fields referenced in the 2023e DICOM standard. These fields are referenced in [dicomfields](dicomanonymizer/dicom_anonymization_databases/dicomfields_2023.py).
Another standard can be selected, see *Change the DICOM anonymization standard*.

Dicom fields are separated into different groups. Each groups will be anonymized in a different way.

Expand Down Expand Up @@ -204,6 +205,8 @@ def main():
)
args = parser.parse_args()
deletePrivateTags = False
input_dicom_path = args.input
output_dicom_path = args.output
Expand Down Expand Up @@ -315,3 +318,17 @@ You can also add `extra_anonymization_rules` as above:
** VR: Value Representation
Work originally done by Edern Haumont
# Change the DICOM anonymization standard
You can customize the DICOM standard that will be used to anonymize the dataset by giving an argument `base_rules_gen` to the function `anonymize_dicom_file` or `anonymize_dataset`.
The value should be a function returning a dict of anonymization rules. Use the function `initialize_actions` to create such dict from a anonymization database from the folder `dicomanonymizer/dicom_anonymization_databases`.
Example:
```python
from dicomanonymizer.simpledicomanonymizer import anonymize_dataset, initialize_actions
anonymize_dataset(
dataset, base_rules_gen=lambda: initialize_actions("dicomfields_2024b")
)
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tags anonymized in DICOM standard
# Documentation for groups meaning can be found in default associated actions.
# http://dicom.nema.org/dicom/2023/output/chtml/part15/chapter_E.html#table_E.1-1
# https://dicom.nema.org/medical/dicom/2023e/output/chtml/part15/chapter_E.html#table_E.1-1

# Replaced tags
D_TAGS = [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tags anonymized in DICOM standard
# Documentation for groups meaning can be found in default associated actions.
# https://dicom.nema.org/medical/dicom/current/output/chtml/part15/chapter_e.html
# https://dicom.nema.org/medical/dicom/2024b/output/chtml/part15/chapter_E.html#table_E.1-1

# Replaced tags
D_TAGS = [
Expand Down

0 comments on commit 3cd5853

Please sign in to comment.