@itk-wasm/dicom

v7.2.3

Published

2 months ago

Read files and images related to DICOM file format.

Downloads

973

0High
0Medium
0Low

paulhax

thewtex

itk wasm webassembly

@itk-wasm/dicom

Read files and images related to DICOM file format.

💻 Live API Demo ✨

🕮 Documentation 📚

Installation

npm install @itk-wasm/dicom

Usage

Browser interface

Import:

import {
  applyPresentationStateToImage,
  readDicomEncapsulatedPdf,
  structuredReportToHtml,
  structuredReportToText,
  readDicomTags,
  readImageDicomFileSeries,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "@itk-wasm/dicom"

applyPresentationStateToImage

Apply a presentation state to a given DICOM image and render output as bitmap, or dicom file.

async function applyPresentationStateToImage(
  imageIn: File | BinaryFile,
  presentationStateFile: File | BinaryFile,
  options: ApplyPresentationStateToImageOptions = {}
) : Promise<ApplyPresentationStateToImageResult>

ApplyPresentationStateToImageOptions interface:

ApplyPresentationStateToImageResult interface:

readDicomEncapsulatedPdf

Extract PDF file from DICOM encapsulated PDF.

async function readDicomEncapsulatedPdf(
  dicomFile: File | BinaryFile,
  options: ReadDicomEncapsulatedPdfOptions = {}
) : Promise<ReadDicomEncapsulatedPdfResult>

ReadDicomEncapsulatedPdfOptions interface:

ReadDicomEncapsulatedPdfResult interface:

structuredReportToHtml

Render DICOM SR file and data set to HTML/XHTML

async function structuredReportToHtml(
  dicomFile: File | BinaryFile,
  options: StructuredReportToHtmlOptions = {}
) : Promise<StructuredReportToHtmlResult>

StructuredReportToHtmlOptions interface:

| Property | | :-------------------: | :--------- | readFileOnly | | readDataset | | readXferAuto | | readXferDetect | | readXferLittle | | readXferBig | | readXferImplicit | | processingDetails | | unknownRelationship | | invalidItemValue | (e.g. violation of VR or VM definition) | ignoreConstraints | | ignoreItemErrors | (e.g. missing value type specific attributes) | skipInvalidItems | | disableVrChecker | | charsetRequire | | charsetAssume | | charsetCheckAll | (default: only PN, LO, LT, SH, ST, UC and UT) | convertToUtf8 | by Specific Character Set (0008,0005) to UTF-8 | urlPrefix | | html32 | | html40 | | xhtml11 | | addDocumentType | | cssReference | | cssFile | expandInline | | neverExpandInline | | alwaysExpandInline | | renderFullData | | sectionTitleInline | | documentTypeTitle | | patientInfoTitle | | noDocumentHeader | | renderInlineCodes | | conceptNameCodes | | numericUnitCodes | | codeValueUnit | | codeMeaningUnit | | renderAllCodes | | codeDetailsTooltip | | webWorker | noCopy | Type | Description | ----------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------- | boolean | read file format only | boolean | read data set without file meta information | boolean | use TS recognition (default) | boolean | ignore TS specified in the file meta header | boolean | read with explicit VR little endian TS | boolean | read with explicit VR big endian TS | boolean | read with implicit VR little endian TS | boolean | show currently processed content item | boolean | accept unknown/missing relationship type | boolean | accept invalid content item value | boolean | ignore relationship content constraints | boolean | do not abort on content item errors, just warn | boolean | skip invalid content items (incl. sub-tree) | boolean | disable check for VR-conformant string values | boolean | require declaration of ext. charset (default) | string | [c]harset: string, assume charset c if no extended charset declared | boolean | check all data elements with string values | boolean | convert all element values that are affected | string | URL: string. Append specificed URL prefix to hyperlinks of referenced composite objects in the document. | boolean | use only HTML version 3.2 compatible features | boolean | allow all HTML version 4.01 features (default) | boolean | comply with XHTML version 1.1 specification | boolean | add reference to SGML document type definition | string | URL: string. Add reference to specified CSS to document | | string | File | TextFile | [f]ilename: string. Embed content of specified CSS into document | boolean | expand short content items inline (default) | boolean | never expand content items inline | boolean | always expand content items inline | boolean | render full data of content items | boolean | render section titles inline, not separately | boolean | use document type as document title (default) | boolean | use patient information as document title | boolean | do not render general document information | boolean | render codes in continuous text blocks | boolean | render code of concept names | boolean | render code of numeric measurement units | boolean | use code value as measurement unit (default) | boolean | use code meaning as measurement unit | boolean | render all codes (implies +Ci, +Cn and +Cu) | boolean | render code details as a tooltip (implies +Cc) | | null or Worker or boolean | WebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to false to run in the current thread / worker. | boolean | When SharedArrayBuffer's are not available, do not copy inputs. |

StructuredReportToHtmlResult interface:

structuredReportToText

Read a DICOM structured report file and generate a plain text representation

async function structuredReportToText(
  dicomFile: File | BinaryFile,
  options: StructuredReportToTextOptions = {}
) : Promise<StructuredReportToTextResult>

StructuredReportToTextOptions interface:

StructuredReportToTextResult interface:

readDicomTags

Read the tags from a DICOM file

async function readDicomTags(
  dicomFile: File | BinaryFile,
  options: ReadDicomTagsOptions = {}
) : Promise<ReadDicomTagsResult>

ReadDicomTagsOptions interface:

ReadDicomTagsResult interface:

readImageDicomFileSeries

Read a DICOM image series and return the associated image volume

async function readImageDicomFileSeries(
  options: ReadImageDicomFileSeriesOptions = { inputImages: [] as BinaryFile[] | File[] | string[], }
) : Promise<ReadImageDicomFileSeriesResult>

| Parameter | Type | Description | | :-------: | :--: | :---------- |

ReadImageDicomFileSeriesOptions interface:

ReadImageDicomFileSeriesResult interface:

setPipelinesBaseUrl

Set base URL for WebAssembly assets when vendored.

function setPipelinesBaseUrl(
  baseUrl: string | URL
) : void

getPipelinesBaseUrl

Get base URL for WebAssembly assets when vendored.

function getPipelinesBaseUrl() : string | URL

Node interface

Import:

import {
  applyPresentationStateToImageNode,
  readDicomEncapsulatedPdfNode,
  structuredReportToHtmlNode,
  structuredReportToTextNode,
  readDicomTagsNode,
  readImageDicomFileSeriesNode,
} from "@itk-wasm/dicom"

applyPresentationStateToImageNode

Apply a presentation state to a given DICOM image and render output as bitmap, or dicom file.

async function applyPresentationStateToImageNode(
  imageIn: string,
  presentationStateFile: string,
  options: ApplyPresentationStateToImageNodeOptions = {}
) : Promise<ApplyPresentationStateToImageNodeResult>

ApplyPresentationStateToImageNodeOptions interface:

ApplyPresentationStateToImageNodeResult interface:

readDicomEncapsulatedPdfNode

Extract PDF file from DICOM encapsulated PDF.

async function readDicomEncapsulatedPdfNode(
  dicomFile: string,
  options: ReadDicomEncapsulatedPdfNodeOptions = {}
) : Promise<ReadDicomEncapsulatedPdfNodeResult>

ReadDicomEncapsulatedPdfNodeOptions interface:

ReadDicomEncapsulatedPdfNodeResult interface:

structuredReportToHtmlNode

Render DICOM SR file and data set to HTML/XHTML

async function structuredReportToHtmlNode(
  dicomFile: string,
  options: StructuredReportToHtmlNodeOptions = {}
) : Promise<StructuredReportToHtmlNodeResult>

StructuredReportToHtmlNodeOptions interface:

StructuredReportToHtmlNodeResult interface:

structuredReportToTextNode

Read a DICOM structured report file and generate a plain text representation

async function structuredReportToTextNode(
  dicomFile: string,
  options: StructuredReportToTextNodeOptions = {}
) : Promise<StructuredReportToTextNodeResult>

StructuredReportToTextNodeOptions interface:

StructuredReportToTextNodeResult interface:

readDicomTagsNode

Read the tags from a DICOM file

async function readDicomTagsNode(
  dicomFile: string,
  options: ReadDicomTagsNodeOptions = {}
) : Promise<ReadDicomTagsNodeResult>

ReadDicomTagsNodeOptions interface:

ReadDicomTagsNodeResult interface:

readImageDicomFileSeriesNode

Read a DICOM image series and return the associated image volume

async function readImageDicomFileSeriesNode(
  options: ReadImageDicomFileSeriesNodeOptions = { inputImages: [] as string[], }
) : Promise<ReadImageDicomFileSeriesNodeResult>

| Parameter | Type | Description | | :-------: | :--: | :---------- |

ReadImageDicomFileSeriesNodeOptions interface:

ReadImageDicomFileSeriesNodeResult interface:

Acknowledgments

@itk-wasm/dicom stands on the shoulders of the following giants:

The versions of libraries are the following:

Development of this library was supported by NCI Imaging Data Commons, and has been funded in whole or in part with Federal funds from the National Cancer Institute, National Institutes of Health, under Task Order No. HHSN26110071 under Contract No. HHSN261201500003l.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@itk-wasm/dicom

Installation

Usage

Browser interface

applyPresentationStateToImage

readDicomEncapsulatedPdf

structuredReportToHtml

structuredReportToText

readDicomTags

readImageDicomFileSeries

setPipelinesBaseUrl

getPipelinesBaseUrl

Node interface

applyPresentationStateToImageNode

readDicomEncapsulatedPdfNode

structuredReportToHtmlNode

structuredReportToTextNode

readDicomTagsNode

readImageDicomFileSeriesNode

Acknowledgments