Skip to content

Commit 41c7d44

Browse files
committed
updated README
1 parent 212426f commit 41c7d44

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@
44
[![MIT License](https://img.shields.io/github/license/fnndsc/pl-dicom_filter)](https://github.com/FNNDSC/pl-dicom_filter/blob/main/LICENSE)
55
[![ci](https://github.com/FNNDSC/pl-dicom_filter/actions/workflows/ci.yml/badge.svg)](https://github.com/FNNDSC/pl-dicom_filter/actions/workflows/ci.yml)
66

7-
`pl-dicom_filter` is a [_ChRIS_](https://chrisproject.org/)
8-
_ds_ plugin which takes in DICOM files in its input directory and filters DICOMs that
9-
matches a specified criteria into its output directory.
7+
`pl-dicom_filter` is a [_ChRIS_](https://chrisproject.org/) _ds_ plugin which takes in DICOM files in its input directory and filters DICOMs based on specified criteria into its output directory.
8+
9+
---
1010

1111
## Abstract
1212

13-
A ChRIS plugin to filter dicoms using filters on dicom tags.
13+
A ChRIS plugin to filter DICOM files using filters on DICOM tags, image count thresholds, and text similarity, with optional PHI handling.
14+
15+
---
1416

1517
## Installation
1618

17-
`pl-dicom_filter` is a _[ChRIS](https://chrisproject.org/) plugin_, meaning it can
18-
run from either within _ChRIS_ or the command-line.
19+
`pl-dicom_filter` is a _[ChRIS](https://chrisproject.org/) plugin_, meaning it can run either within _ChRIS_ or from the command line using container technologies such as [Apptainer](https://apptainer.org/).
20+
21+
---
1922

2023
## Local Usage
2124

@@ -31,6 +34,18 @@ To print its available options, run:
3134
```shell
3235
apptainer exec docker://fnndsc/pl-dicom_filter dicom_filter --help
3336
```
37+
| Argument | Default | Description |
38+
| ----------------------------- | -------- | ---------------------------------------------------------------- |
39+
| `-d`, `--dicomFilter` | `""` | Comma-separated DICOM tags with values to filter files |
40+
| `-f`, `--fileFilter` | `"dcm"` | Input file filter glob pattern |
41+
| `-m`, `--minImgCount` | `1` | Minimum number of images in a series; smaller series are dropped |
42+
| `-o`, `--outputType` | `"dcm"` | Output file type/extension |
43+
| `-t`, `--textFilter` | `"txt"` | Input text file filter (for additional filtering) |
44+
| `-i`, `--inspectTags` | `None` | Comma-separated DICOM tags to inspect; optional |
45+
| `-p`, `--phiMode` | `"skip"` | PHI handling mode: `detect`, `allow`, or `skip` |
46+
| `-s`, `--similarityThreshold` | `0.95` | Minimum similarity threshold between two text entries |
47+
| `-V`, `--version` || Show plugin version |
48+
3449

3550
## Examples
3651

0 commit comments

Comments
 (0)