Namespace: dicom

Source: src/dicom/dicomParser.js, line 4

Classes

DataReader
DataWriter
DicomElementsWrapper
DicomParser
DicomWriter
Tag

Members

(static) dictionary

DICOM tag dictionary 2022a. Generated using xml standard conversion from https://github.com/ivmartel/dcmStdToJs v0.1.0. Conversion changes:

(vr) 'See Note' -> 'NONE', 'OB or OW' -> 'ox', 'US or SS' -> 'xs'
added 'GenericGroupLength' element to each group Local changes:
tag numbers with 'xx' were replaced with '00', 'xxx' with '001' and 'xxxx' with '0004'

Source: src/dicom/dictionary.js, line 16

(static) requiredDicomSegTags

List of DICOM Seg required tags.

Source: src/image/maskFactory.js, line 83

Methods

(static) DefaultTextDecoder()

Default text decoder

Source: src/dicom/dicomParser.js, line 107

(static) DefaultTextEncoder()

Default text encoder.

Source: src/dicom/dicomWriter.js, line 203

(static) checkTag(rootElement, tagDefinition)

Check that a DICOM tag definition is present in a parsed element.

Parameters:

Name	Type	Description
`rootElement`	object	The root dicom element.
`tagDefinition`	object	The tag definition as {name, tag, type, enum}.

Source: src/image/maskFactory.js, line 38

(static) checkTags(tags, requiredTags, withLog) → {boolean}

Check a list of input tags against a required list.

Parameters:

Name	Type	Description
`tags`	object	The tags to check.
`requiredTags`	Array	Array of tag names.
`withLog`	boolean	Flag to log errors or not.

Source: tests/dicom/dicomGenerator.js, line 27

Returns:

True if all required tags are present in the input.

Type:: boolean

(static) checkUnknownVR(element)

Fix for broken DICOM elements: Replace "UN" with correct VR if the element exists in dictionary

Parameters:

Name	Type	Description
`element`	object	The DICOM element.

Source: src/dicom/dicomWriter.js, line 845

(static) cleanString(inputStr) → {string}

Clean string: trim and remove ending.

Parameters:

Name	Type	Description
`inputStr`	string	The string to clean.

Source: src/dicom/dicomParser.js, line 37

Returns:

The cleaned string.

Type:: string

(static) equalPosPat(pos1, pos2) → {boolean}

Check two position patients for equality.

Parameters:

Name	Type	Description
`pos1`	*	The first position patient.
`pos2`	*	The second position patient.

Source: src/image/maskFactory.js, line 12

Returns:

True is equal.

Type:: boolean

(static) flattenArrayOfTypedArrays(initialArray) → {object}

Helper method to flatten an array of typed arrays to 2D typed array

Parameters:

Name	Type	Description
`initialArray`	Array	array of typed arrays

Source: src/dicom/dicomWriter.js, line 181

Returns:

a typed array containing all values

Type:: object

(static) flipArrayEndianness(array)

Flip an array's endianness. Inspired from DataStream.js.

Parameters:

Name	Type	Description
`array`	object	The array to flip (modified).

Source: src/dicom/dataReader.js, line 20

(static) generatePixelDataFromJSONTags(tags, pixGeneratorName, sliceNumber, images, numberOfSlices) → {object}

Get the DICOM pixel data from a DICOM tags object.

Parameters:

Name	Type	Description
`tags`	object	The DICOM tags object.
`pixGeneratorName`	string	The name of a pixel generator.
`sliceNumber`	number	The slice number.
`images`	Array	The images to pass to the generator.
`numberOfSlices`	number	The result number of slices.

Source: tests/dicom/dicomGenerator.js, line 55

Returns:

The DICOM pixel data element.

Type:: object

(static) getBpeForVrType(vrType) → {number}

Get the number of bytes per element for a given VR type.

Parameters:

Name	Type	Description
`vrType`	string	The VR type as defined in the dictionary.

Source: src/dicom/dicomWriter.js, line 877

Returns:

The bytes per element.

Type:: number

(static) getCode(element) → {object}

Get a code object from a dicom element.

Parameters:

Name	Type	Description
`element`	object	The dicom element.

Source: src/image/maskFactory.js, line 250

Returns:

A code object.

Type:: object

(static) getComparePosPat(orientation) → {function}

Get a position patient compare function accroding to an input orientation.

Parameters:

Name	Type	Description
`orientation`	dwv.math.Matrix33	The orientation matrix.

Source: src/image/maskFactory.js, line 23

Returns:

The position compare function.

Type:: function

(static) getDataElementPrefixByteSize(vr, isImplicit) → {number}

Get the number of bytes occupied by a data element prefix, i.e. without its value.

Parameters:

Name	Type	Description
`vr`	string	The Value Representation of the element.
`isImplicit`	boolean	Does the data use implicit VR?

Source: src/dicom/dicomParser.js, line 500

Returns:

The size of the element prefix. WARNING: this is valid for tags with a VR, if not sure use the 'isTagWithVR' function first. Reference:

| Tag | VR | VL | Value | | 4 | 2 | 2 | X | -> regular explicit: 8 + X | 4 | 2+2 | 4 | X | -> 32bit VL: 12 + X

| Tag | VL | Value | | 4 | 4 | X | -> implicit (32bit VL): 8 + X

| Tag | Len | Value | | 4 | 4 | X | -> item: 8 + X

Type:: number

(static) getDefaultDicomSegJson() → {object}

Get the default DICOM seg tags as an object.

Source: src/image/maskFactory.js, line 169

Returns:

The default tags.

Type:: object

(static) getDicomElement(tagName) → {object}

Get a DICOM element from its tag name (value set separatly).

Parameters:

Name	Type	Description
`tagName`	string	The string tag name.

Source: src/dicom/dicomWriter.js, line 863

Returns:

The DICOM element.

Type:: object

(static) getDimensionOrganization(rootElement) → {object}

Check the dimension organization from a dicom element.

Parameters:

Name	Type	Description
`rootElement`	object	The root dicom element.

Source: src/image/maskFactory.js, line 184

Returns:

The dimension organizations and indices.

Type:: object

(static) getDwvUIDPrefix() → {string}

Get the dwv UID prefix. Issued by Medical Connections Ltd (www.medicalconnections.co.uk) on 25/10/2017.

Source: src/dicom/dicomWriter.js, line 12

Returns:

The dwv UID prefix.

Type:: string

(static) getElementsFromJSONTags(jsonTags) → {object}

Get the DICOM elements from a DICOM json tags object. The json is a simplified version of the oficial DICOM json with tag names instead of keys and direct values (no value property) for simple tags.

Parameters:

Name	Type	Description
`jsonTags`	object	The DICOM json tags object.

Source: src/dicom/dicomWriter.js, line 1087

Returns:

The DICOM elements.

Type:: object

(static) getFileListFromDicomDir(data) → {Array|undefined}

Get the file list from a DICOMDIR

Parameters:

Name	Type	Description
`data`	object	The buffer data of the DICOMDIR

Source: src/dicom/dicomElementsWrapper.js, line 607

Returns:

The file list as an array ordered by STUDY > SERIES > IMAGES.

Type:: Array | undefined

(static) getFileMetaInformationGroupLengthTag() → {object}

Get the FileMetaInformationGroupLength Tag.

Source: src/dicom/dicomTag.js, line 202

Returns:

The tag.

Type:: object

(static) getImageDataData(image) → {object}

Extract the image data from an image.

Parameters:

Name	Type	Description
`image`	Image	The image to get the data from.

Source: tests/dicom/dicomGenerator.js, line 164

Returns:

The image data buffer.

Type:: object

(static) getItemDelimitationItemTag() → {dwv.dicom.Tag}

Get the ItemDelimitationItem Tag.

Source: src/dicom/dicomTag.js, line 240

Returns:

The tag.

Type:: dwv.dicom.Tag

(static) getItemTag() → {dwv.dicom.Tag}

Get the Item Tag.

Source: src/dicom/dicomTag.js, line 221

Returns:

The tag.

Type:: dwv.dicom.Tag

(static) getOrientationName(orientation) → {string}

Get the name of an image orientation patient.

Parameters:

Name	Type	Description
`orientation`	Array	The image orientation patient.

Source: src/dicom/dicomParser.js, line 161

Returns:

The orientation name: axial, coronal or sagittal.

Type:: string

(static) getPixelDataTag() → {dwv.dicom.Tag}

Get the PixelData Tag.

Source: src/dicom/dicomTag.js, line 278

Returns:

The tag.

Type:: dwv.dicom.Tag

(static) getReverseOrientation(ori) → {string}

Get patient orientation label in the reverse direction.

Parameters:

Name	Type	Description
`ori`	string	Patient Orientation value.

Source: src/dicom/dicomParser.js, line 129

Returns:

Reverse Orientation Label.

Type:: string

(static) getSegment(element) → {object}

Get a segment object from a dicom element.

Parameters:

Name	Type	Description
`element`	object	The dicom element.

Source: src/image/maskFactory.js, line 286

Returns:

A segment object.

Type:: object

(static) getSegmentFrameInfo(groupItem) → {object}

Get a frame information object from a dicom element.

Parameters:

Name	Type	Description
`groupItem`	object	The dicom element.

Source: src/image/maskFactory.js, line 451

Returns:

A frame information object.

Type:: object

(static) getSequenceDelimitationItemTag() → {dwv.dicom.Tag}

Get the SequenceDelimitationItem Tag.

Source: src/dicom/dicomTag.js, line 259

Returns:

The tag.

Type:: dwv.dicom.Tag

(static) getSpacingFromMeasure(measure) → {dwv.image.Spacing}

Get a spacing object from a dicom measure element.

Parameters:

Name	Type	Description
`measure`	object	The dicom element.

Source: src/image/maskFactory.js, line 425

Returns:

A spacing object.

Type:: dwv.image.Spacing

(static) getSyntaxDecompressionName(syntax) → {string}

Tell if a given syntax needs decompression.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 267

Returns:

The name of the decompression algorithm.

Type:: string

(static) getTagFromDictionary(tagName) → {object|null}

Get a tag from the dictionary using a tag string name.

Parameters:

Name	Type	Description
`tagName`	string	The tag string name.

Source: src/dicom/dicomTag.js, line 298

Returns:

The tag object or null if not found.

Type:: object | null

(static) getTagFromKey(key) → {object}

Split a group-element key used to store DICOM elements.

Parameters:

Name	Type	Description
`key`	string	The key in form "x00280102" as generated by tag::getKey.

Source: src/dicom/dicomTag.js, line 113

Returns:

The DICOM tag.

Type:: object

(static) getTransferSyntaxName(syntax) → {string}

Get the transfer syntax name. Reference: UID Values.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax.

Source: src/dicom/dicomParser.js, line 311

Returns:

The name of the transfer syntax.

Type:: string

(static) getTransferSyntaxUIDTag() → {object}

Get the TransferSyntaxUID Tag.

Source: src/dicom/dicomTag.js, line 193

Returns:

The tag.

Type:: object

(static) getTypedArray(bitsAllocated, pixelRepresentation, size) → {Array}

Get the appropriate TypedArray in function of arguments.

Parameters:

Name	Type	Description
`bitsAllocated`	number	The number of bites used to store the data: [8, 16, 32].
`pixelRepresentation`	number	The pixel representation, 0:unsigned;1:signed.
`size`	dwv.image.Size	The size of the new array.

Source: src/dicom/dicomParser.js, line 434

Returns:

The good typed array.

Type:: Array

(static) getUID(tagName) → {string}

Get a UID for a DICOM tag. Note: Use https://github.com/uuidjs/uuid?

Parameters:

Name	Type	Description
`tagName`	string	The input tag.

Source: src/dicom/dicomWriter.js, line 29
See: http://dicom.nema.org/dicom/2013/output/chtml/part05/chapter_9.html
http://dicomiseasy.blogspot.com/2011/12/chapter-4-dicom-objects-in-chapter-3.html
https://stackoverflow.com/questions/46304306/how-to-generate-unique-dicom-uid

Returns:

The corresponding UID.

Type:: string

(static) getUtfLabel(charSetTerm) → {string}

Get the utfLabel (used by the TextDecoder) from a character set term References:

Parameters:

Name	Type	Description
`charSetTerm`	string	The DICOM character set.

Source: src/dicom/dicomParser.js, line 60

Returns:

The corresponding UTF label.

Type:: string

(static) getVrPad(vr) → {boolean}

Get the VR specific padding value.

Parameters:

Name	Type	Description
`vr`	string	The element VR.

Source: src/dicom/dicomWriter.js, line 114

Returns:

The value used to pad.

Type:: boolean

(static) guessTransferSyntax(firstDataElement) → {object}

Guess the transfer syntax from the first data element. See https://github.com/ivmartel/dwv/issues/188 (Allow to load DICOM with no DICM preamble) for more details.

Parameters:

Name	Type	Description
`firstDataElement`	object	The first data element of the DICOM header.

Source: src/dicom/dicomParser.js, line 371

Returns:

The transfer syntax data element.

Type:: object

(static) hasDicomPrefix(buffer) → {boolean}

Check that an input buffer includes the DICOM prefix 'DICM' after the 128 bytes preamble. Ref: DICOM File Meta

Parameters:

Name	Type	Description
`buffer`	ArrayBuffer	The buffer to check.

Source: src/dicom/dicomParser.js, line 23

Returns:

True if the buffer includes the prefix.

Type:: boolean

(static) is32bitVLVR(vr) → {boolean}

Does this Value Representation (VR) have a 32bit Value Length (VL). Ref: Data Element explicit.

Parameters:

Name	Type	Description
`vr`	string	The data Value Representation (VR).

Source: src/dicom/dicomParser.js, line 473

Returns:

True if this VR has a 32-bit VL.

Type:: boolean

(static) isBigEndianTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a big endian syntax.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 192

Returns:

True if a big endian syntax.

Type:: boolean

(static) isEqualSegment(seg1, seg2) → {boolean}

Check if two segment objects are equal.

Parameters:

Name	Type	Description
`seg1`	object	The first segment.
`seg2`	object	The second segment.

Source: src/image/maskFactory.js, line 350

Returns:

True if both segment are equal.

Type:: boolean

(static) isEven(number) → {boolean}

Return true if the input number is even.

Parameters:

Name	Type	Description
`number`	number	The number to check.

Source: src/dicom/dicomWriter.js, line 68

Returns:

True is the number is even.

Type:: boolean

(static) isFileMetaInformationGroupLengthTag(tag) → {boolean}

Is the input tag the FileMetaInformationGroupLength Tag.

Parameters:

Name	Type	Description
`tag`	dwv.dicom.Tag	The tag to test.

Source: src/dicom/dicomTag.js, line 212

Returns:

True if the asked tag.

Type:: boolean

(static) isImplicitTransferSyntax(syntax) → {boolean}

Tell if a given syntax is an implicit one (element with no VR).

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 182

Returns:

True if an implicit syntax.

Type:: boolean

(static) isItemDelimitationItemTag(tag) → {boolean}

Is the input tag the ItemDelimitationItem Tag.

Parameters:

Name	Type	Description
`tag`	dwv.dicom.Tag	The tag to test.

Source: src/dicom/dicomTag.js, line 250

Returns:

True if the asked tag.

Type:: boolean

(static) isItemTag(tag) → {boolean}

Is the input tag the Item Tag.

Parameters:

Name	Type	Description
`tag`	dwv.dicom.Tag	The tag to test.

Source: src/dicom/dicomTag.js, line 231

Returns:

True if the asked tag.

Type:: boolean

(static) isJpeg2000TransferSyntax(syntax) → {boolean}

Tell if a given syntax is a JPEG 2000 one.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 247

Returns:

True if a jpeg 2000 syntax.

Type:: boolean

(static) isJpegBaselineTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a JPEG baseline one.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 202

Returns:

True if a jpeg baseline syntax.

Type:: boolean

(static) isJpegLosslessTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a JPEG Lossless one.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 226

Returns:

True if a jpeg lossless syntax.

Type:: boolean

(static) isJpegRetiredTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a retired JPEG one.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 213

Returns:

True if a retired jpeg syntax.

Type:: boolean

(static) isJpeglsTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a JPEG-LS one.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 237

Returns:

True if a jpeg-ls syntax.

Type:: boolean

(static) isNativeLittleEndian()

Is the Native endianness Little Endian.

Source: src/dicom/dataReader.js, line 10

(static) isPixelDataTag(tag) → {boolean}

Is the input tag the PixelData Tag.

Parameters:

Name	Type	Description
`tag`	dwv.dicom.Tag	The tag to test.

Source: src/dicom/dicomTag.js, line 288

Returns:

True if the asked tag.

Type:: boolean

(static) isReadSupportedTransferSyntax(syntax) → {boolean}

Tell if a given syntax is supported for reading.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 287

Returns:

True if a supported syntax.

Type:: boolean

(static) isRleTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a RLE (Run-length encoding) one.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax to test.

Source: src/dicom/dicomParser.js, line 257

Returns:

True if a RLE syntax.

Type:: boolean

(static) isSequenceDelimitationItemTag(tag) → {boolean}

Is the input tag the SequenceDelimitationItem Tag.

Parameters:

Name	Type	Description
`tag`	dwv.dicom.Tag	The tag to test.

Source: src/dicom/dicomTag.js, line 269

Returns:

True if the asked tag.

Type:: boolean

(static) isSimilarSegment(seg1, seg2) → {boolean}

Check if two segment objects are similar: either the number or the displayValue are equal.

Parameters:

Name	Type	Description
`seg1`	object	The first segment.
`seg2`	object	The second segment.

Source: src/image/maskFactory.js, line 394

Returns:

True if both segment are similar.

Type:: boolean

(static) isStringVr(vr) → {boolean}

Is the input VR a string VR.

Parameters:

Name	Type	Description
`vr`	string	The element VR.

Source: src/dicom/dicomWriter.js, line 91

Returns:

True if the VR is a string one.

Type:: boolean

(static) isTypedArrayVr(vr) → {boolean}

Is the input VR a VR that stores data in a typed array. TODO: include ox and xs?

Parameters:

Name	Type	Description
`vr`	string	The element VR.

Source: src/dicom/dicomWriter.js, line 79

Returns:

True if the VR is a typed array one.

Type:: boolean

(static) isVrToPad(vr) → {boolean}

Is the input VR a VR that could need padding. see http://dicom.nema.org/dicom/2013/output/chtml/part05/sect_6.2.html

Parameters:

Name	Type	Description
`vr`	string	The element VR.

Source: src/dicom/dicomWriter.js, line 104

Returns:

True if the VR needs padding.

Type:: boolean

(static) padOBValue(value) → {Array|Uint8Array}

Pad an input OB value.

Parameters:

Name	Type	Description
`value`	Array \| Uint8Array	The input value.

Source: src/dicom/dicomWriter.js, line 146

Returns:

The padded input.

Type:: Array | Uint8Array

(static) tagCompareFunction(a, b) → {number}

Tag compare function.

Parameters:

Name	Type	Description
`a`	dwv.dicom.Tag	The first tag.
`b`	dwv.dicom.Tag	The second tag.

Source: src/dicom/dicomTag.js, line 65

Returns:

The result of the tag comparison, positive for b before a, negative for a before b and zero to keep same order.

Type:: number

(static) uint8ArrayPush(arr, value) → {Uint8Array}

Push a value at the end of an input Uint8Array.

Parameters:

Name	Type	Description
`arr`	Uint8Array	The input array.
`value`	number	The value to push.

Source: src/dicom/dicomWriter.js, line 133

Returns:

The new array.

Type:: Uint8Array