Adds DICOM Encapsulated PDF section to README.md including example image

GSTT-CSC · Jun 7, 2023 · 639f510 · 639f510
1 parent a0bd301
commit 639f510
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,8 @@ The TotalSegmentator MAP consists of three operators:
 2. `totalsegmentator_operator.py` – runs TotalSegmentator
 3. `rtstructwriter_operator.py` – converts the output segmentations from NIfTI to DICOM RT Struct format, using 
 [rt-utils](https://github.com/qurit/rt-utils/tree/main/rt_utils)
+4. `clinrev_pdf_operator.py` – creates a DICOM encapsulated PDF showing three views of the input CT dataset overlaid 
+with the segmentations generated by TotalSegmentator
 
 ## Developer Guidelines
 
@@ -127,6 +129,14 @@ Note: two containers are present under GitHub Packages:
 The `map` version is for general usage and deployment. The `map-init` version is for developers who wish to build the 
 MAP from scratch as part of the two-step build process described above.
 
+## DICOM Encapsulated PDF
+AIDE Clinical Review is a user interface within AIDE for assessing the quality of AI results. It can display DICOM 
+Encapsulated PDFs. The screenshot below is an example PDF generated by `clinrev_pdf_operator.py`:
+
+<p align="center">
+  <img src="docs/images/clinical-review-pdf-example.png" alt="Logo" width="80%">
+</p>
+
 ## Running on AIDE
 To run TotalSegmentator on AIDE, two files from the `app/workflows` directory are required, namely:
 - `totalsegmentator.json` – AIDE Clinical Workflow file.

diff --git a/docs/images/clinical-review-pdf-example.png b/docs/images/clinical-review-pdf-example.png