Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smikitky/vscode-dicom-dump
A vscode extension that dumps DICOM tags
https://github.com/smikitky/vscode-dicom-dump
dicom vscode-extension
Last synced: 4 months ago
JSON representation
A vscode extension that dumps DICOM tags
- Host: GitHub
- URL: https://github.com/smikitky/vscode-dicom-dump
- Owner: smikitky
- License: mit
- Created: 2018-07-05T14:56:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-11T18:09:19.000Z (over 3 years ago)
- Last Synced: 2024-10-03T13:22:17.674Z (4 months ago)
- Topics: dicom, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=smikitky.vscode-dicom
- Size: 1.11 MB
- Stars: 20
- Watchers: 2
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# DICOM Dump for Visual Studio Code
A [Visual Studio Code][vsc] (vscode) extension that dumps [DICOM][dicom] tag contents. DICOM is a standard file format for medical images.
[vsc]: https://code.visualstudio.com/
[dicom]: https://www.dicomstandard.org/
## Usage
Open a context menu on a DICOM file and select "DICOM: Dump DICOM tags".
## Features
- Dumps all DICOM tags in human-readable format (except binary data).
- Understands value representation (VR) of most standard DICOM tags.
- Provides a hover for some hard-to-remember DICOM keywords and UIDs.
- Basic support for character encodings.
- 100% JavaScript. Does not require any external binary dependencies like DCMTK.
## Configuration
- `dicom.alwaysShowMenu` (default = `false`) controls the visibility of the
dump menus. When set to true, the menus will show up regardless of the
file extension. When set to false, the menus will show up when the
extension of the file is `*.dcm` or `*.dicom`.
- `dicom.showPrivateTags` (default = `false`) controls the
visibility of DICOM private tags. Set this to `true` to dump everything.
Note that many private tags have 'UN' (unknown) VR type, which means
this extension does not know how to stringify them.
- `dicom.dictionary` (default = `{}`) modifies or adds entries to
the standard DICOM dictionary. Example:
```json
{
"dicom.dictionary": {
"01F51247": { "vr": "US", "name": "myPrivateNumericalTag" },
"01F51248": { "vr": "LO", "name": "myPrivateTextTag", "forceVr": true }
}
}
```
`forceVr: true` will forcibly overwrite the VR type even if
another type is explicitly specified in the DICOM file.
This may allow you to sniff the contents of some private tags.
- `dicom.searches` (default = `[]`) provides a quick link to your favorite
DICOM search engine when the mouse hovers on a tag string. Example:
```json
{
"dicom.searches": [
{
"title": "Search {GGGG},{EEEE} on Google",
"url": "https://www.google.com/search?q=DICOM%20{GGGG},{EEEE}"
}
]
}
```
Four keywords (`{GGGG}`, `{gggg}`, `{EEEE}` and `{eeee}`) will be replaced.
## Troubleshooting
**My DICOM file does not load at all!**: Can you open that file with [dicom-parser's online demo][demo]? If not, probably your DICOM file is not standard-compliant, and there is little I can do. Some DICOM implementations are tolerant enough to open mildly broken files. Just because you can view your file with <insert your favorite viewer here> does not mean the file is not corrupted. If you could open the file with the demo above and are still getting an error from this extension, feel free to report as a bug.
[demo]: https://github.com/cornerstonejs/dicomParser
**The "Dump DICOM tags" context menu doesn't show up!**: By default, the menus will be displayed only when the file extension is `*.dcm` or `*.dicom`. Please check the `dicom.alwaysShowMenu` option.
**Patient/institution names are garbled!**: Currently the character encoding support is limited and buggy, and it's partially due to the fact that DICOM uses rare character encodings not supported by iconv-lite. Also note that some DICOM implementations store multibyte strings with a totally wrong encoding (e.g., Japanse SJIS). I'd rather not support all sorts of malformed files "in the wild", but reasonable suggestions and PRs are welcome.
## Known Issues / Limitations
**USE AT YOUR OWN RISK. DO NOT USE THIS FOR CLINICAL PURPOSES.**
- Cannot display the image (pixel/voxel data) itself.
- It's not possible to modify DICOM files.
## Bugs / PRs
Plase use GitHub's issue system.
## Acknowledgement
This extension is based on the following awesome packages.
- [dicom-parser][parser]
- [dicom-data-dictionary][dictionary]
[parser]: https://www.npmjs.com/package/dicom-parser
[dictionary]: https://www.npmjs.com/package/dicom-data-dictionary