dwv.dicom. DicomParser

new DicomParser()

DicomParser class.

Example
// XMLHttpRequest onload callback
var onload = function (event) {
  // setup the dicom parser
  var dicomParser = new dwv.dicom.DicomParser();
  // parse the buffer
  dicomParser.parse(event.target.response);
  // get the wrapped dicom tags
  // (raw tags are available via 'getRawDicomElements')
  var tags = dicomParser.getDicomElements();
  // display the modality
  var div = document.getElementById('dwv');
  div.appendChild(document.createTextNode(
    'Modality: ' + tags.getFromName('Modality')
  ));
};
// DICOM file request
var request = new XMLHttpRequest();
var url = 'https://raw.githubusercontent.com/ivmartel/dwv/master/tests/data/bbmri-53323851.dcm';
request.open('GET', url);
request.responseType = 'arraybuffer';
request.onload = onload;
request.send();

Members

dicomElements :Array

The list of DICOM elements.

Type:
  • Array

Methods

decodeSpecialString(buffer) → {string}

Decode an input string buffer using the 'special' text decoder.

Parameters:
NameTypeDescription
bufferUint8Array

The buffer to decode.

Returns:

The decoded string.

Type: 
string

decodeString(buffer) → {string}

Decode an input string buffer using the default text decoder.

Parameters:
NameTypeDescription
bufferUint8Array

The buffer to decode.

Returns:

The decoded string.

Type: 
string

getDefaultCharacterSet() → {string}

Get the default character set.

Returns:

The default character set.

Type: 
string

getDicomElements() → {object}

Get the DICOM data elements.

Returns:

The DICOM elements.

Type: 
object

getRawDicomElements() → {object}

Get the raw DICOM data elements.

Returns:

The raw DICOM elements.

Type: 
object

interpret(elements, reader, pixelRepresentation, bitsAllocated)

Interpret the data of a list of elements.

Parameters:
NameTypeDescription
elementsArray

A list of data elements.

readerdwv.dicom.DataReader

The raw data reader.

pixelRepresentationnumber

PixelRepresentation 0->unsigned, 1->signed.

bitsAllocatednumber

Bits allocated.

interpretElement(element, reader, pixelRepresentation, bitsAllocated) → {object}

Interpret the data of an element.

Parameters:
NameTypeDescription
elementobject

The data element.

readerdwv.dicom.DataReader

The raw data reader.

pixelRepresentationnumber

PixelRepresentation 0->unsigned, 1->signed (needed for pixel data or VR=xs).

bitsAllocatednumber

Bits allocated (needed for pixel data).

Returns:

The interpreted data.

Type: 
object

parse(buffer)

Parse the complete DICOM file (given as input to the class). Fills in the member object 'dicomElements'.

Parameters:
NameTypeDescription
bufferobject

The input array buffer.

readDataElement(reader, offset, implicit) → {object}

Read a DICOM data element. Reference: DICOM VRs.

Parameters:
NameTypeDescription
readerdwv.dicom.DataReader

The raw data reader.

offsetnumber

The offset where to start to read.

implicitboolean

Is the DICOM VR implicit?

Returns:

An object containing the element 'tag', 'vl', 'vr', 'data' and 'endOffset'.

Type: 
object

readItemDataElement(reader, offset, implicit) → {object}

Read an item data element.

Parameters:
NameTypeDescription
readerdwv.dicom.DataReader

The raw data reader.

offsetnumber

The offset where to start to read.

implicitboolean

Is the DICOM VR implicit?

Returns:

The item data as a list of data elements.

Type: 
object

readPixelItemDataElement(reader, offset, implicit) → {Array}

Read the pixel item data element. Ref: Single frame fragments.

Parameters:
NameTypeDescription
readerdwv.dicom.DataReader

The raw data reader.

offsetnumber

The offset where to start to read.

implicitboolean

Is the DICOM VR implicit?

Returns:

The item data as an array of data elements.

Type: 
Array

readTag(reader, offset) → {object}

Read a DICOM tag.

Parameters:
NameTypeDescription
readerdwv.dicom.DataReader

The raw data reader.

offsetnumber

The offset where to start to read.

Returns:

An object containing the tag and the end offset.

Type: 
object

setDecoderCharacterSet(characterSet)

Set the text decoder character set.

Parameters:
NameTypeDescription
characterSetstring

The input character set.

setDefaultCharacterSet(characterSet)

Set the default character set.

Parameters:
NameTypeDescription
characterSetstring

The input character set.