@@ -21,7 +21,7 @@ DICOM standard.
21
21
22
22
* Disclaimer:*
23
23
No guarantees are given for the correctness of the results.
24
- This is alpha -stage software and mostly thought as a proof of concept.
24
+ This is beta -stage software which is mostly developed as a proof of concept.
25
25
Also check the limitations for ` validate_iods ` described below.
26
26
27
27
* Note:*
@@ -40,18 +40,18 @@ pip install dicom-validator
40
40
41
41
## Usage
42
42
```
43
- validate_iods.py [-h] [--standard-path STANDARD_PATH]
44
- [--revision REVISION] [--force-read] [--recreate-json]
45
- [--verbose]
46
- dicomfiles [dicomfiles ...]
47
-
48
- dump_dcm_info.py [-h] [--standard-path STANDARD_PATH]
49
- [--revision REVISION] [--max-value-len MAX_VALUE_LEN]
50
- [--show-tags [SHOW_TAGS [SHOW_TAGS ...]]]
51
- [--show-image-data] [--recreate-json]
52
- dicomfiles [dicomfiles ...]
43
+ validate_iods [-h] [--standard-path STANDARD_PATH]
44
+ [--revision REVISION] [--force-read] [--recreate-json]
45
+ [--suppress-vr-warnings] [--verbose]
46
+ dicomfiles [dicomfiles ...]
47
+
48
+ dump_dcm_info [-h] [--standard-path STANDARD_PATH]
49
+ [--revision REVISION] [--max-value-len MAX_VALUE_LEN]
50
+ [--show-tags [SHOW_TAGS [SHOW_TAGS ...]]]
51
+ [--show-image-data] [--recreate-json]
52
+ dicomfiles [dicomfiles ...]
53
53
```
54
- Use the ` --help ` option for each script do get usage info.
54
+ Use the ` --help ` option for each script do get more specific usage info.
55
55
56
56
## Access to the DICOM standard
57
57
@@ -128,17 +128,24 @@ Process finished with exit code 6
128
128
As mentioned, if the evaluation of conditions fails, the related module or
129
129
tag is considered optional, which may hide some non-conformity.
130
130
Condition evaluation may fail if:
131
- - the needed information is not contained in the DICOM file (e.g. verbose
132
- descriptions like "if the Patient is an animal")
131
+ - the needed information is not directly contained in the DICOM file (e.g. verbose
132
+ descriptions like "if the Patient is an animal", "if the image has been calibrated" etc. )
133
133
- the information is related to other DICOM files (e.g. referenced images)
134
134
- the parsing failed because the condition is too complicated, unexpected,
135
135
or due to a bug (please write an issue if you encounter such a problem)
136
136
137
137
#### Retired tags
138
- Also note that only the given standard is used to evaluate the files. If
138
+ Only the given standard is used to evaluate the files. If
139
139
the DICOM file has been written using an older standard, it may conform to
140
140
that standard, but not to the newest one. Tags that are retired in the
141
141
version of the standard used for parsing are not considered at all.
142
+ You can always check against an older standard by using the ` --revision ` option.
143
+
144
+ #### Enumerated values and defined terms
145
+ Most enumerated values are checked against, but some are ignored due to parsing issues.
146
+ Support for more cases may be added in the future.
147
+ Defined terms are _ not_ checked, because they are allowed to be user-defined, which means
148
+ that any value may be valid.
142
149
143
150
#### Unsupported cases (support may be added in future versions)
144
151
- SOP classes not in the table in PS3.3 such as Presentation States are not
@@ -188,7 +195,9 @@ c:\dev\DICOM Data\SR\image12.dcm
188
195
189
196
## Build executable on Windows
190
197
191
- Here is a sample workflow:
198
+ A self-contained Windows executable is contained in the release artifacts.
199
+
200
+ Here is a sample workflow to build such an executable yourself:
192
201
``` powershell
193
202
# Clone the repository
194
203
git clone git@github.com:pydicom/dicom-validator.git
@@ -204,3 +213,7 @@ pip install -r requirements-dev.txt
204
213
# Build executables. They will be placed in the `dist` subfolder.
205
214
pyinstaller dicom-validator.spec -y
206
215
```
216
+
217
+ ## Contributing
218
+ Contributions are very welcome. If you submit a pull request for a bugfix
219
+ or a new feature, please make sure to also write respective tests.
0 commit comments