Skip to content

Commit

Permalink
[DOCS] Enhance Docstring in checker.py for Better Context and Clarity.
Browse files Browse the repository at this point in the history
…Closes #21.
  • Loading branch information
FMCalisto committed Sep 9, 2024
1 parent 74c47fb commit 7839a94
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
12 changes: 11 additions & 1 deletion src/checker.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
#!/usr/bin/env python

"""
checker.py: Compare two DICOM files and save paths to CSV.
checker.py:
This script compares anonymized and non-anonymized DICOM files to identify matching files based on the `InstanceNumber` metadata. It traverses specified directories, reads DICOM files, and checks for matches. The paths of the matching DICOM files are then saved to a CSV file for further analysis or verification.
Key Functions:
- Identify and validate DICOM files in the anonymized and non-anonymized directories.
- Compare DICOM files based on `InstanceNumber` to find matching pairs.
- Save the paths of matched DICOM files to a CSV file for traceability.
Intended Use Case:
- This script is intended for use in environments where maintaining a connection between anonymized and non-anonymized medical imaging data is crucial. It is particularly useful in scenarios requiring validation of anonymization processes or in studies involving the comparison of anonymized data against the original datasets, such as in the MIMBCD-UI initiative.
"""

__author__ = "Francisco Maria Calisto"
Expand Down
1 change: 0 additions & 1 deletion src/compare.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
Intended Use Case:
- This script is intended for environments where maintaining patient privacy through anonymization is crucial while ensuring that medical imaging files are correctly matched and organized based on their metadata. It is particularly relevant in scenarios involving large datasets of breast imaging (e.g., mammograms).
"""

__author__ = "Francisco Maria Calisto"
Expand Down

0 comments on commit 7839a94

Please sign in to comment.