Skip to content

Commit 96ce2ba

Browse files
committed
docs(readDICOMTags): Add API usage
1 parent 3d3df6b commit 96ce2ba

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/content/api/browser_io.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,17 @@ If the files are known to be from a single, sorted series, the last argument can
6969

7070
The used `webWorkerPool` is returned to enable resource cleanup by calling `.terminateWorkers()`.
7171

72+
## readDICOMTags(fileList, tags=[]) -> { tags, webWorkerPool }
73+
74+
Read tags from several DICOM [Files](https://developer.mozilla.org/en-US/docs/Web/API/File)'s or [Blobs](https://developer.mozilla.org/en-US/docs/Web/API/Blob)'s stored in an [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or [FileList](https://developer.mozilla.org/en-US/docs/Web/API/FileList).
75+
76+
Tags should be of the form `"GGGG|EEEE"`, where `GGGG` is the group ID in hex and `EEEE` is the element ID in hex. As an example, "0010|0010" is the PatientID.
77+
Hexadecimal strings are treated case-insensitively.
78+
79+
Returns a tags property that contains an object with keys being the tags and the values being the tags' values.
80+
81+
The used `webWorkerPool` is returned to enable resource cleanup by calling `.terminateWorkers()`.
82+
7283
## writeImageArrayBuffer(webWorker, useCompression, image, fileName, mimeType) -> { webWorker, [arrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) }
7384

7485
Write an image to a an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer).

0 commit comments

Comments
 (0)