Skip to content

Commit 0e79303

Browse files
committed
Documentation update
1 parent 3520c24 commit 0e79303

File tree

3 files changed

+2
-45
lines changed

3 files changed

+2
-45
lines changed

DICOM-ANON/.gitkeep

Whitespace-only changes.

DICOM/.gitkeep

Whitespace-only changes.

README.md

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -22,54 +22,16 @@ A DICOM tag reference can be found [here](https://dicom.innolitics.com/ciods/cr-
2222

2323
### Requirements
2424

25-
Since we run this tool on MacOS, it requires docker (see below)
25+
Since we run this tool on MacOS, it requires docker (see below) and the 'make' command from HomeBrew or MacOS command line tools: `xcode-select --install`
2626

2727
### Installation
2828

29-
First ensure you have the [Oracle JDK v.8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) installed.
30-
3129
Create a clone of this repository on your workstation:
3230
```
3331
git clone --recurse-submodules https://github.com/susom/mirc-ctp.git
3432
```
3533

36-
If you do not have the `ant` program installed, install it with [HomeBrew](https://brew.sh/) (which will need to be installed if you haven't done so already)
37-
38-
```
39-
$ brew install ant
40-
```
41-
42-
Compile the included DicomAnonymizerTool by typing `ant` at the command prompt:
43-
44-
```
45-
$ ant
46-
Buildfile: /Users/jdoe/Projects/mirc-ctp/build.xml
47-
48-
clean:
49-
50-
init:
51-
[echo] Time now 15:56:40 PST
52-
[echo] ant.java.version = 1.8
53-
[mkdir] Created dir: /Users/jdoe/Projects/mirc-ctp/DicomAnonymizerTool/build
54-
...
55-
56-
```
57-
58-
You should now have a directory called `DAT` which contains the `DicomAnonymizerTool`. You can try running it:
59-
60-
```
61-
$ java -jar DAT/DAT.jar
62-
Usage: java -jar DAT {parameters}
63-
where:
64-
-in {input} specifies the file or directory to be anonymized
65-
If {input} is a directory, all files in it and its subdirectories are processed.
66-
-out {output} specifies the file or directory in which to store the anonymized file or files.
67-
...
68-
```
69-
70-
Now the application needs to be placed in a Docker image. To create the image:
71-
72-
`docker build -f Dockerfile --pull -t mirc-ctp .`
34+
Type `make` and the Docker image should build.
7335

7436
You can now place some test DICOM studies in the directory `DICOM` and run the shell script which will anonymize the studies (all to the same anonymous MRN and Accession Number) and place them in `DICOM-ANON`
7537

@@ -87,8 +49,3 @@ Elapsed time: 0.634
8749

8850
You can now open the DICOM files in `DICOM-ANON` to make sure they work with your intended application.
8951

90-
### Pixel filtering and MacOS
91-
92-
In order to read DICOM encoded with the JPEG Lossless syntax, you need to have the Java Advanced Imaging ImageIO libraries.
93-
Unfortunately, these are not available for Mac. To get around this limitation, this application executes within Docker.
94-
A Dockerfile is included in this distribution.

0 commit comments

Comments
 (0)