Global

// custom tool
class AlertTool {
  mousedown() {alert('AlertTool mousedown');}
  init() {}
  activate() {}
}
// pass it to dwv tool list
dwv.toolList['Alert'] = AlertTool;
// create the dwv app
const app = new dwv.App();
// initialise
const viewConfig0 = new dwv.ViewConfig('layerGroup0');
const viewConfigs = {'*': [viewConfig0]};
const options = new dwv.AppOptions(viewConfigs);
options.tools = {Alert: {}};
app.init(options);
// activate tool
app.addEventListener('load', function () {
  app.setTool('Alert');
});
// load dicom data
app.loadURLs([
  'https://raw.githubusercontent.com/ivmartel/dwv/master/tests/data/bbmri-53323851.dcm'
]);

(constant) toolOptions :Object.<string, Object.<string, any>>

List of client provided tool options to be added to the default ones.

Type:

Object.<string, Object.<string, any>>

Source: src/tools/index.js, line 118

Example

// custom factory
class LoveFactory {
  getName() {return 'love';}
  static supports(mathShape) {return mathShape instanceof ROI;}
  getNPoints() {return 1;}
  getTimeout() {return 0;}
  setAnnotationMathShape(annotation, points) {
    const px = points[0].getX();
    const py = points[0].getY();
    annotation.mathShape = new dwv.ROI([
      new dwv.Point2D(px+15,py), new dwv.Point2D(px+10,py-10),
      new dwv.Point2D(px,py), new dwv.Point2D(px-10,py-10),
      new dwv.Point2D(px-15,py), new dwv.Point2D(px,py+20)
    ]);
    annotation.getFactory = function () {return new LoveFactory();}
  }
  createShapeGroup(annotation, style) {
    const roi = annotation.mathShape;
    // konva line
    const arr = [];
    for (let i = 0; i < roi.getLength(); ++i) {
      arr.push(roi.getPoint(i).getX());
      arr.push(roi.getPoint(i).getY());
    }
    const shape = new Konva.Line({
      name: 'shape', points: arr,
      stroke: 'red', strokeWidth: 2,
      closed: true
    });
    // konva group
    const group = new Konva.Group();
    group.name('love-group');
    group.visible(true);
    group.id(annotation.id);
    group.add(shape);
    return group;
  }
}
// pass it to dwv option list
dwv.toolOptions['draw'] = {LoveFactory};
// create the dwv app
const app = new dwv.App();
// initialise
const viewConfig0 = new dwv.ViewConfig('layerGroup0');
const viewConfigs = {'*': [viewConfig0]};
const options = new dwv.AppOptions(viewConfigs);
options.tools = {Draw: {options: ['Love']}};
app.init(options);
// activate tool
app.addEventListener('load', function () {
  app.setTool('Draw');
  app.setToolFeatures({shapeName: 'Love'});
});
// load dicom data
app.loadURLs([
  'https://raw.githubusercontent.com/ivmartel/dwv/master/tests/data/bbmri-53323851.dcm'
]);

(constant) transferSyntaxKeywords :Object.<string, string>

Transfer syntaxes indexed by keyword.

Type:

Object.<string, string>

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

(constant) transferSyntaxes :Object.<string, string>

Transfer syntaxes.

See https://dicom.nema.org/medical/dicom/2022a/output/chtml/part06/chapter_A.html#table_A-1.

Type:

Object.<string, string>

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

(constant) viewEventNames :Array.<string>

List of view event names.

Type:

Array.<string>

Source: src/image/view.js, line 35

(constant) vr32bitVL :Object.<string, boolean>

List of Value Representation (VR) with 32bit Value Length (VL).

Added locally used 'ox'. See http://dicom.nema.org/medical/dicom/2022a/output/chtml/part05/chapter_7.html#table_7.1-1.

Type:

Object.<string, boolean>

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

(constant) vrCharSetString :Object.<string, boolean>

List of string VR with extended or replaced default character repertoire defined in Specific Character Set (0008,0005).

See https://dicom.nema.org/medical/dicom/2022a/output/chtml/part05/chapter_6.html#sect_6.1.2.2.

Type:

Object.<string, boolean>

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

(constant) vrTypes :Object.<string, string>

VR equivalent javascript types.

See https://dicom.nema.org/medical/dicom/2022a/output/chtml/part05/sect_6.2.html#table_6.2-1.

Type:

Object.<string, string>

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

(constant) writerActions :Object.<string, function()>

Possible writer actions.

Type:

Object.<string, function()>

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

Methods

addLayerGroup(id)

Append a layer div in the root 'dwv' one.

Parameters:

Name	Type	Description
`id`	string	The id of the layer.

Source: tests/pacs/viewer.js, line 477

addLayerGroups(number)

Add Layer Groups.

Parameters:

Name	Type	Description
`number`	number	The number of layer groups.

Source: tests/pacs/viewer.js, line 490

addTagsToDictionary(group, tags)

Add tags to the dictionary.

Parameters:

Name	Type	Description
`group`	string	The group key.
`tags`	Object.<string, Array.<string>>	The tags to add as an object indexed by element key with values as: [VR, multiplicity, TagName] (all strings).

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

areOrthogonal(line0, line1) → {boolean}

Check if two lines are orthogonal.

Parameters:

Name	Type	Description
`line0`	Line	The first line.
`line1`	Line	The second line.

Source: src/math/line.js, line 224

Returns:

True if both lines are orthogonal.

Type:: boolean

arrayContains(arr0, arr1) → {boolean}

Check if the first input array contains all the elements of the second input array.

Parameters:

Name	Type	Description
`arr0`	Array.<string>	The test array.
`arr1`	Array.<string>	The elements to check in the first array.

Source: src/utils/array.js, line 78

Returns:

True if all the elements of arr1 are included in arr0.

Type:: boolean

arrayEquals(arr0, arr1) → {boolean}

Check for array equality.

Parameters:

Name	Type	Description
`arr0`	Array	First array.
`arr1`	Array	Second array.

Source: src/utils/array.js, line 126

Returns:

True if both array are defined and contain same values.

Type:: boolean

arraySortEquals(arr0, arr1) → {boolean}

Check for array equality after sorting.

Parameters:

Name	Type	Description
`arr0`	Array	First array.
`arr1`	Array	Second array.

Source: src/utils/array.js, line 107

Returns:

True if both array are defined and contain same values.

Type:: boolean

b64urlToArrayBuffer(str) → {ArrayBuffer}

Convert a base64 url to an ArrayBuffer. Something like: 'data:application/dicom;base64,SGVsbG8sIFdvcmxkIQ==' The function is independent from the mime type.

Parameters:

Name	Type	Description
`str`	string	Base64 url string.

Source: tests/dicom/utils.js, line 9

Returns:

The corresponding buffer.

Type:: ArrayBuffer

boundNodePosition(node, min, max) → {boolean}

Bound a node position.

Parameters:

Name	Type	Description
`node`	Konva.Node	The node to bound the position.
`min`	Point2D	The minimum position.
`max`	Point2D	The maximum position.

Source: src/tools/drawBounds.js, line 147

Returns:

True if the position was corrected.

Type:: boolean

buildLut(func) → {Array.<number>}

Build a LUT of size lut_range_max.

Parameters:

Name	Type	Description
`func`	function	The i to lut function.

Source: src/image/luts.js, line 13

Returns:

The LUT.

Type:: Array.<number>

buildMultipart(parts, boundary) → {Uint8Array}

Build a multipart message.

Ref:

Parameters:

Name	Type	Description
`parts`	Array	The message parts as an array of object containing content headers and messages as the data property (as returned by parse).
`boundary`	string	The message boundary.

Source: src/utils/array.js, line 317

Returns:

The full multipart message.

Type:: Uint8Array

canCreateCanvas(width, height) → {boolean}

Test if a canvas with the input size can be created.

Ref:

Parameters:

Name	Type	Description
`width`	number	The canvas width.
`height`	number	The canvas height.

Source: src/gui/generic.js, line 127

Returns:

True is the canvas can be created.

Type:: boolean

capitaliseFirstLetter(string) → {string}

Capitalise the first letter of a string.

Parameters:

Name	Type	Description
`string`	string	The string to capitalise the first letter.

Source: src/utils/string.js, line 10

Returns:

The new string.

Type:: string

checkAndFixUnknownVR(element, isLittleEndianopt)

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

Parameters:

Name	Type	Attributes	Description
`element`	DataElement		The DICOM element.
`isLittleEndian`	boolean	<optional>	Flag to tell if the data is little or big endian (default: true).

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

checkIterator(assert, getIter, theoValues, name)

Check iter.

Parameters:

Name	Type	Description
`assert`	object	The qunit assert.
`getIter`	function	Function to get the iter at a given position.
`theoValues`	Array	Theoretical values.
`name`	string	String to identify test.

Source: tests/image/iterator.test.js, line 189

checkLoad(assert, id, data, nData, nDataOk)

Check the events of memory load.

Parameters:

Name	Type	Description
`assert`	object	The Qunit assert object.
`id`	string	An id for the test.
`data`	Array	The data to load as a string array.
`nData`	number	The theoretical number of data.
`nDataOk`	number	The theoretical number of data with no error.

Source: tests/io/memoryLoader.test.js, line 29

checkResponseEvent(event, reqName) → {boolean}

Check a response event and print error if any.

Parameters:

Name	Type	Description
`event`	object	The load event.
`reqName`	string	The request name.

Source: tests/pacs/dcmweb.js, line 75

Returns:

True if response is ok.

Type:: boolean

checkSelected(parser) → {boolean}

Check if a parser is checked.

Parameters:

Name	Type	Description
`parser`	object	The parser to check.

Source: tests/bench/bench.js, line 114

Returns:

True isf selected.

Type:: boolean

checkTag(element, name, valuesopt) → {string}

Check an input tag.

Parameters:

Name	Type	Attributes	Description
`element`	object		The element to check.
`name`	string		The element name.
`values`	Array	<optional>	The expected values.

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

Returns:

A warning if the element is not as expected.

Type:: string

checkTag(dataElements, tagDefinition)

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

Parameters:

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

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

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 30

Returns:

True if all required tags are present in the input.

Type:: boolean

cielabToCiexyz(triplet) → {Scalar3D}

Convert CIE LAB to CIE XYZ (standard illuminant D65, 2degree 1931).

Ref: https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIELAB_to_CIEXYZ.

Parameters:

Name	Type	Description
`triplet`	object	CIE LAB triplet as {l,a,b}.

Source: src/utils/colour.js, line 201

Returns:

CIE XYZ triplet as {x,y,z}.

Type:: Scalar3D

cielabToSrgb(triplet) → {RGB}

Convert CIE LAB to sRGB (standard illuminant D65).

Parameters:

Name	Type	Description
`triplet`	object	CIE LAB triplet as {l,a,b}.

Source: src/utils/colour.js, line 350

Returns:

'sRGB' triplet as {r,g,b}.

Type:: RGB

ciexyzToCielab(triplet) → {object}

Convert CIE XYZ to CIE LAB (standard illuminant D65, 2degree 1931).

Ref: https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIEXYZ_to_CIELAB.

Parameters:

Name	Type	Description
`triplet`	Scalar3D	CIE XYZ triplet as {x,y,z}.

Source: src/utils/colour.js, line 239

Returns:

CIE LAB triplet as {l,a,b}.

Type:: object

ciexyzToSrgb(triplet) → {RGB}

Convert CIE XYZ to sRGB.

Ref: https://en.wikipedia.org/wiki/SRGB#From_CIE_XYZ_to_sRGB.

Parameters:

Name	Type	Description
`triplet`	Scalar3D	CIE XYZ triplet as {x,y,z}.

Source: src/utils/colour.js, line 278

Returns:

'sRGB' triplet as {r,g,b}.

Type:: RGB

cleanString(inputStr) → {string}

Clean string: remove zero-width space ending and trim. Warning: no tests are done on the input, will fail if null or undefined or not string. Exported for tests only.

Parameters:

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

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

Returns:

The cleaned string.

Type:: string

colourNameToHex(name) → {string}

Get the hex code of a string colour for a colour used in pre dwv v0.17.

Parameters:

Name	Type	Description
`name`	string	The name of a colour.

Source: src/utils/colour.js, line 370

Returns:

The hex representing the colour.

Type:: string

colourRange(colours, end) → {object}

Get a colour iterator. The input array defines the colours and their start index.

Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Parameters:

Name	Type	Description
`colours`	Array	An array of {index, colour} pairs.
`end`	number	The end of the range (excluded).

Source: src/image/iterator.js, line 641

Returns:

An iterator folowing the iterator and iterable protocol.

Type:: object

compare(jsonTags, dicomElements, name, comparator)

Compare JSON tags and DICOM elements.

Parameters:

Name	Type	Description
`jsonTags`	object	The JSON tags.
`dicomElements`	object	The DICOM elements.
`name`	string	The name of the test.
`comparator`	object	An object with an equal function (such as Qunit assert).

Source: tests/dicom/dicomWriter.test.js, line 275

compareImageAndBuffer(image, size, buffer, rsi) → {object}

Compare an image and a buffer.

Parameters:

Name	Type	Description
`image`	object	The input image.
`size`	object	The size of the input buffer.
`buffer`	Array	The input buffer.
`rsi`	object	The rescale slope of the input buffer.

Source: tests/image/image.test.js, line 28

Returns:

Statistics of the value and rescaled value differences.

Type:: object

comparePosPat(a, b) → {number}

Compare two pos pat keys.

Parameters:

Name	Type	Description
`a`	string	The key of the first item.
`b`	string	The key of the second item.

Source: tests/pacs/viewer.js, line 843

Returns:

Negative if a<b, positive if a>b.

Type:: number

computeGradX(greyscale) → {Array}

Compute the X gradient.

Parameters:

Name	Type	Description
`greyscale`	object	The values.

Source: src/math/scissors.js, line 174

Returns:

The gradient.

Type:: Array

computeGradY(greyscale) → {Array}

Compute the Y gradient.

Parameters:

Name	Type	Description
`greyscale`	object	The values.

Source: src/math/scissors.js, line 198

Returns:

The gradient.

Type:: Array

computeGradient(greyscale) → {object}

Compute gradient.

Parameters:

Name	Type	Description
`greyscale`	object	The input greyscale.

Source: src/math/scissors.js, line 83

Returns:

A gradient object.

Type:: object

computeGreyscale(data, width, height) → {object}

Compute grey scale.

Parameters:

Name	Type	Description
`data`	Array	The input data.
`width`	number	The width of the output.
`height`	number	The height of the output.

Source: src/math/scissors.js, line 14

Returns:

A greyscale object.

Type:: object

computeLaplace(greyscale) → {object}

Parameters:

Name	Type	Description
`greyscale`	object	The input greyscale.

Source: src/math/scissors.js, line 127

Returns:

A laplace object.

Type:: object

computeSides(dist, gradX, gradY, greyscale) → {object}

Compute the sides.

Parameters:

Name	Type	Description
`dist`	number	The distance.
`gradX`	Array	The X gradient.
`gradY`	Array	The Y gradient.
`greyscale`	object	The value.

Source: src/math/scissors.js, line 284

Returns:

The sides.

Type:: object

createAndPutHtml(data, id)

Create and append html.

Parameters:

Name	Type	Description
`data`	object	Data configuration object.
`id`	string	The html list element.

Source: tests/pacs/index.js, line 201

createDefaultReplaceFormat(length) → {string}

Create a default replace format from a given length. For example: '{v0}, {v1}'.

Parameters:

Name	Type	Description
`length`	number	The length of the format.

Source: src/gui/overlayData.js, line 28

Returns:

A replace format.

Type:: string

createImage(elements) → {Image}

Create an Image from DICOM elements.

Parameters:

Name	Type	Description
`elements`	Object.<string, DataElement>	The DICOM elements.

Source: src/image/image.js, line 52

Returns:

The Image object.

Type:: Image

createImage(colourMapName, colourMap)

Create the colour map image and add it to the document.

Parameters:

Name	Type	Description
`colourMapName`	string	The colour map name.
`colourMap`	object	The colour map values.

Source: tests/image/pages/colourmaps.js, line 27

createMaskImage(elements) → {Image}

Create a mask Image from DICOM elements.

Parameters:

Name	Type	Description
`elements`	Object.<string, DataElement>	The DICOM elements.

Source: src/image/image.js, line 67

Returns:

The mask Image object.

Type:: Image

createOverlayData(dicomElements, configs) → {Array}

Create overlay data array for a DICOM image.

Parameters:

Name	Type	Description
`dicomElements`	object	DICOM elements of the image.
`configs`	object	The overlay data configs.

Source: src/gui/overlayData.js, line 345

Returns:

Overlay data array.

Type:: Array

createOverlayDataForDom(info, configs) → {Array}

Create overlay data array for a DOM image.

Parameters:

Name	Type	Description
`info`	object	Meta data.
`configs`	object	The overlay data configs.

Source: src/gui/overlayData.js, line 418

Returns:

Overlay data array.

Type:: Array

createRoiBuffers(image, segments) → {object}

Create ROI buffers.

Parameters:

Name	Type	Description
`image`	Image	The mask image.
`segments`	Array.<MaskSegment>	The mask segments.

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

Returns:

The ROI buffers.

Type:: object

createRoiSliceBuffers(image, segments, sliceOffset) → {object}

Create ROI slice buffers.

Parameters:

Name	Type	Description
`image`	Image	The mask image.
`segments`	Array.<MaskSegment>	The mask segments.
`sliceOffset`	number	The slice offset.

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

Returns:

The ROI slice image buffers.

Type:: object

createView(elements, image) → {View}

Create a View from DICOM elements and image.

Parameters:

Name	Type	Description
`elements`	Object.<string, DataElement>	The DICOM elements.
`image`	Image	The associated image.

Source: src/image/view.js, line 51

Returns:

The View object.

Type:: View

dateToDateObj(date) → {Object}

Extract date values from a Date object.

Parameters:

Name	Type	Description
`date`	Date	The input date.

Source: src/dicom/dicomDate.js, line 123

Returns:

A 'date' object.

Type:: Object

dateToTimeObj(date) → {Object}

Extract time values from a Date object.

Parameters:

Name	Type	Description
`date`	Date	The input date.

Source: src/dicom/dicomDate.js, line 137

Returns:

A 'time' object.

Type:: Object

dcmdump(dicomElements) → {string}

Dump the DICOM tags to a string in the same way as the DCMTK dcmdump command (https://support.dcmtk.org/docs-dcmrt/dcmdump.html).

Parameters:

Name	Type	Description
`dicomElements`	Object.<string, DataElement>	The dicom elements.

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

Returns:

The dumped file.

Type:: string

decodeKeyValueUri(uri, replaceMode) → {Array.<string>}

Decode a Key/Value pair URI. If a key is repeated, the result be an array of base + each key.

Parameters:

Name Type Description

uri

string

The URI to decode.

replaceMode

string

The key replace mode. Can be:

key (default): keep the key
other than key: do not use the key 'file' is a special case where the '?' of the query is not kept.

Source: src/utils/uri.js, line 103

Returns:

The list of input file urls.

Type:: Array.<string>

decodeManifest(manifest, nslices) → {Array.<string>}

Decode an XML manifest.

Parameters:

Name	Type	Description
`manifest`	object	The manifest to decode.
`nslices`	number	The number of slices to load.

Source: src/utils/uri.js, line 222

Returns:

The decoded manifest.

Type:: Array.<string>

decodeQuery(query, callback, options)

Generic URI query decoder. Supports manifest: [dwv root]?input=encodeURIComponent('[manifest file]')&type=manifest. Or encoded URI with base and key value/pairs: [dwv root]?input=encodeURIComponent([root]?key0=value0&key1=value1).

Parameters:

Name	Type	Description
`query`	object	The query part to the input URI.
`callback`	function	The function to call with the decoded file urls.
`options`	object	Optional url request options.

Source: src/utils/uri.js, line 80

endsWith(str, search) → {boolean}

Check if a string ends with the input element.

Parameters:

Name	Type	Description
`str`	string	The input string.
`search`	string	The searched ending.

Source: src/utils/string.js, line 43

Returns:

True if the input string ends with the searched string.

Type:: boolean

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 52

Returns:

True is equal.

Type:: boolean

fileCheckTags(tags, image) → {boolean}

Check tags are coherent with image size.

Parameters:

Name	Type	Description
`tags`	object	The tags to check.
`image`	object	The associated image.

Source: tests/dicom/filePixGenerator.js, line 67

Returns:

True if the tags are ok.

Type:: boolean

fillGithubHostedWithExample(base, files)

Fill github hosted inputs with preset strings.

Parameters:

Name	Type	Description
`base`	string	The base url href.
`files`	string	The coma separated list of files.

Source: tests/pacs/index.js, line 291

findInArraySubset(arr, callbackFn, start, endopt) → {number|undefined}

Array find in a subset of the input array. Equivalent to: arr.slice(start, end).find(callbackFn).

Parameters:

Name	Type	Attributes	Description
`arr`	Uint8Array		The input array to search.
`callbackFn`	function		The find function.
`start`	number \| undefined		The array start index.
`end`	number \| undefined	<optional>	The array end index.

Source: src/utils/array.js, line 161

Returns:

The index where the element was found.

Type:: number | undefined

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 274

Returns:

A typed array containing all values.

Type:: object

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 16

gaussianBlur(buffer, out)

Gaussian blur an input buffer.

Parameters:

Name	Type	Description
`buffer`	Array	The input buffer.
`out`	Array	The result.

Source: src/math/scissors.js, line 329

generate()

Generate DICOM data.

Source: tests/dicom/pages/anonymiser.js, line 52

generateBinary(tags) → {object}

Simple BinaryPixGenerator.

Parameters:

Name	Type	Description
`tags`	object	The input tags.

Source: tests/dicom/dicomWriter.test.js, line 430

Returns:

The pixel buffer.

Type:: object

generateGradSquare(tags) → {object}

Simple GradSquarePixGenerator.

Parameters:

Name	Type	Description
`tags`	object	The input tags.

Source: tests/dicom/dicomWriter.test.js, line 324

Returns:

The pixel buffer.

Type:: object

generateImageDataMonochrome(array, iterator, alphaFunc, windowLut, colourMap)

Generate image data for 'MONOCHROME*' photometric interpretation.

Parameters:

Name	Type	Description
`array`	ImageData	The array to store the outut data.
`iterator`	object	Position iterator.
`alphaFunc`	function	The alpha function.
`windowLut`	WindowLut	The window/level LUT.
`colourMap`	ColourMap	The colour map.

Source: src/image/viewMonochrome.js, line 16

generateImageDataPaletteColor(array, iterator, alphaFunc, colourMap, is16BitsStored)

Generate image data for 'PALETTE COLOR' photometric interpretation.

Parameters:

Name	Type	Description
`array`	ImageData	The array to store the outut data.
`iterator`	object	Position iterator.
`alphaFunc`	function	The alpha function.
`colourMap`	ColourMap	The colour map.
`is16BitsStored`	boolean	Flag to know if the data is 16bits.

Source: src/image/viewPaletteColor.js, line 17

generateImageDataRgb(array, iterator, alphaFunc)

Generate image data for 'RGB' photometric interpretation.

Parameters:

Name	Type	Description
`array`	ImageData	The array to store the outut data.
`iterator`	object	Position iterator.
`alphaFunc`	function	The alpha function.

Source: src/image/viewRgb.js, line 8

generateImageDataYbrFull(array, iterator, alphaFunc)

Generate image data for 'YBR_FULL' photometric interpretation.

Parameters:

Name	Type	Description
`array`	ImageData	The array to store the outut data.
`iterator`	object	Position iterator.
`alphaFunc`	function	The alpha function.

Source: src/image/viewYbrFull.js, line 10

generateSlice(pixelGeneratorName, sliceNumber) → {Blob}

Parameters:

Name	Type	Description
`pixelGeneratorName`	string	The name of the pixel generator.
`sliceNumber`	number	The slice to generate.

Source: tests/dicom/pages/generator.js, line 135

Returns:

A blob with the slice DICOM data.

Type:: Blob

getAnchorIndex(id) → {number}

Get an anchor index from its id.

Parameters:

Name	Type	Description
`id`	string	The anchor id as 'anchor#'.

Source: src/tools/drawBounds.js, line 134

Returns:

The anchor index.

Type:: number

getAnchorShape(group, index) → {Konva.Ellipse|undefined}

Get a Konva.Ellipse anchor shape from a group.

Parameters:

Name	Type	Description
`group`	Konva.Group	The group to look into.
`index`	number	The anchor index.

Source: src/tools/drawBounds.js, line 62

Returns:

The anchor shape.

Type:: Konva.Ellipse | undefined

getAngle(line0, line1) → {number}

Get the angle between two lines in degree.

Parameters:

Name	Type	Description
`line0`	Line	The first line.
`line1`	Line	The second line.

Source: src/math/line.js, line 201

Returns:

The angle.

Type:: number

getAnnotationDivId(annotation, dataId) → {string}

Get the annotation divId.

Parameters:

Name	Type	Description
`annotation`	Annotation	The annotation.
`dataId`	string	The data ID.

Source: tests/pacs/viewer.ui.annot.js, line 26

Returns:

The divId.

Type:: string

getAnnotationGroupDivId(dataId) → {string}

Get the annotation group divId.

Parameters:

Name	Type	Description
`dataId`	string	The data ID.

Source: tests/pacs/viewer.ui.annot.js, line 15

Returns:

The divId.

Type:: string

getAppViewConfig(dataId) → {object}

Get the first view config for a data id.

Parameters:

Name	Type	Description
`dataId`	string	The data id.

Source: tests/pacs/viewer.js, line 526

Returns:

The view config.

Type:: object

getAppViewConfigOrientation(divId) → {object}

Get the orientation of the first view config for a div id.

Parameters:

Name	Type	Description
`divId`	string	The div id.

Source: tests/pacs/viewer.js, line 541

Returns:

The orientation.

Type:: object

getArrayFromStringId(inputStr) → {Array}

Get an array from an id string in the form of: '#0-1_#1-2' (result of toStringId).

Parameters:

Name	Type	Description
`inputStr`	string	The input string.

Source: src/utils/array.js, line 42

Returns:

The corresponding array (minimum size is 3D).

Type:: Array

getBasicStats(values) → {Statistics}

Get simple stats: minimum, maximum, mean and standard deviation of an array of values.

Parameters:

Name	Type	Description
`values`	Array.<number>	The array of values to extract stats from.

Source: src/math/stats.js, line 100

Returns:

Simple statistics (no median, p25 nor p75).

Type:: Statistics

getBasicStats(array) → {object}

Get basic stats for an array.

Parameters:

Name	Type	Description
`array`	Array	Input array.

Source: tests/pacs/viewer.rendertest.js, line 76

Returns:

Min, max, mean and standard deviation.

Type:: object

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 1339

Returns:

The bytes per element.

Type:: number

getBrightness(rgb) → {number}

Get the brightness of a RGB colour: calculates the luma (Y) of the YIQ colour space.

Ref: https://en.wikipedia.org/wiki/YIQ#From_RGB_to_YIQ.

Parameters:

Name	Type	Description
`rgb`	RGB	RGB triplet.

Source: src/utils/colour.js, line 117

Returns:

The brightness ([0,1]).

Type:: number

getCode(dataElements) → {DicomCode}

Get a code object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomCode.js, line 94

Returns:

A code object.

Type:: DicomCode

getCodeFromSimpleDicom(simpleElements) → {DicomCode}

Get a dicom code from simple dicom elements.

Parameters:

Name	Type	Description
`simpleElements`	Object.<string, DataElement>	DICOM simple elements.

Source: tests/dicom/dicomSegment.test.js, line 29

Returns:

The corresponding DICOM code.

Type:: DicomCode

getColourCode() → {DicomCode}

Get a colour DICOM code.

Source: src/dicom/dicomCode.js, line 342

Returns:

The code.

Type:: DicomCode

getCommonPrefix(values) → {string|undefined}

Get a common prefix from a list of strings.

Parameters:

Name	Type	Description
`values`	Array.<string>	The values to extract the prefix from.

Source: tests/pacs/dcmweb.js, line 394

Returns:

The common prefix.

Type:: string | undefined

getComparePosPat(orientation) → {compareFn}

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

Parameters:

Name	Type	Description
`orientation`	Matrix33	The orientation matrix.

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

Returns:

The position compare function.

Type:: compareFn

getConceptNameCode(name) → {DicomCode|undefined}

Get a concept name DICOM code.

Parameters:

Name	Type	Description
`name`	string	The measurment name as defined in a quantification object.

Source: src/dicom/dicomCode.js, line 374

Returns:

The code.

Type:: DicomCode | undefined

getConfigsHtmlList(configs) → {object}

Create list from configs.

Parameters:

Name	Type	Description
`configs`	Array	An array of data cofiguration.

Source: tests/dicom/pages/synthetic-data.js, line 70

Returns:

The html list element.

Type:: object

getCoronalMat33() → {Matrix33}

Create a 3x3 coronal (xzy) matrix.

Source: src/math/orientation.js, line 12

Returns:

The coronal matrix.

Type:: Matrix33

getCosinesFromOrientation(matrix) → {Array.<number>}

Get the direction cosines from an orientation matrix.

Parameters:

Name	Type	Description
`matrix`	Matrix33	The input matrix.

Source: src/math/orientation.js, line 222

Returns:

The image orientation patient cosines (6 values).

Type:: Array.<number>

getData() → {Array}

Get the selected data.

Source: tests/bench/bench.js, line 214

Returns:

The selected data.

Type:: Array

getDataElement(tagName) → {DataElement}

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 1326

Returns:

The DICOM element.

Type:: DataElement

getDataElementPrefixByteSize(vr, isImplicit) → {number}

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

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

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 429

Returns:

The size of the element prefix.

Type:: number

getDate(element) → {Object|undefined}

Get a 'date' object with {year, monthIndex, day} ready for the Date constructor from a DICOM element with vr=DA.

Parameters:

Name	Type	Description
`element`	DataElement	The DICOM element with date information.

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

Returns:

The 'date' object.

Type:: Object | undefined

getDateTime(element) → {Object|undefined}

Get a 'dateTime' object with {date, time} ready for the Date constructor from a DICOM element with vr=DT.

Parameters:

Name	Type	Description
`element`	DataElement	The DICOM element with date-time information.

Source: src/dicom/dicomDate.js, line 93

Returns:

The time object.

Type:: Object | undefined

getDeOrientedArray3D(array3D, orientation) → {Array.<number>}

Get the raw values of an oriented input 3D array.

Parameters:

Name	Type	Description
`array3D`	Array.<number>	The 3D array.
`orientation`	Matrix33	The orientation 3D matrix.

Source: src/image/geometry.js, line 570

Returns:

The values reordered to compensate the orientation.

Type:: Array.<number>

getDecayedDose(elements) → {object}

Get the decayed dose (Bq).

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements to check.

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

Returns:

The value and a warning if the elements are not as expected.

Type:: object

getDefaultAnchor(x, y, id, style) → {Konva.Ellipse}

Get the default anchor shape.

Parameters:

Name	Type	Description
`x`	number	The X position.
`y`	number	The Y position.
`id`	string	The shape id.
`style`	Style	The application style.

Source: src/tools/drawBounds.js, line 104

Returns:

The default anchor shape.

Type:: Konva.Ellipse

getDefaultAnonymisationRules() → {Object.<string, WriterRule>}

Get simple (non official) DICOM anonymisation rules.

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

Returns:

The rules.

Type:: Object.<string, WriterRule>

getDefaultDicomSegJson() → {object}

Get the default DICOM seg tags as an object.

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

Returns:

The default tags.

Type:: object

getDefaultImage(width, height, sliceIndex, imageBuffer, numberOfFrames, imageUid) → {object}

Get an image from an input context imageData.

Parameters:

Name	Type	Description
`width`	number	The width of the coresponding image.
`height`	number	The height of the coresponding image.
`sliceIndex`	number	The slice index of the imageData.
`imageBuffer`	object	The image buffer.
`numberOfFrames`	number	The final number of frames.
`imageUid`	string	The image UID.

Source: src/image/domReader.js, line 39

Returns:

The corresponding view.

Type:: object

getDicomCode(value, scheme) → {DicomCode|undefined}

Get a DICOM code from a value (~id).

Parameters:

Name	Type	Description
`value`	string	The code value.
`scheme`	string	The scheme designator.

Source: src/dicom/dicomCode.js, line 229

Returns:

The DICOM code.

Type:: DicomCode | undefined

getDicomCodeItem(code) → {Object.<string, any>}

Get a simple dicom element item from a code object.

Parameters:

Name	Type	Description
`code`	DicomCode	The code object.

Source: src/dicom/dicomCode.js, line 130

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomDate(dateObj) → {string}

Get a DICOM formated date string.

Parameters:

Name	Type	Description
`dateObj`	Object	The date to format.

Source: src/dicom/dicomDate.js, line 151

Returns:

The formated date.

Type:: string

getDicomDateTime(datetime) → {string}

Get a DICOM formated datetime string.

Parameters:

Name	Type	Description
`datetime`	Object	The datetime to format.

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

Returns:

The formated datetime.

Type:: string

getDicomImageReferenceItem(ref) → {Object.<string, any>}

Get a simple dicom element item from a reference object.

Parameters:

Name	Type	Description
`ref`	ImageReference	The reference object.

Source: src/dicom/dicomImageReference.js, line 87

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomMeasureItem(spacing) → {object}

Get a dicom item from a measure sequence.

Parameters:

Name	Type	Description
`spacing`	Spacing	The spacing object.

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

Returns:

The dicom item.

Type:: object

getDicomMeasuredValueItem(value) → {Object.<string, any>}

Get a simple dicom element item from a measured value object.

Parameters:

Name	Type	Description
`value`	MeasuredValue	The measured value object.

Source: src/dicom/dicomMeasuredValue.js, line 105

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomNumericMeasurementItem(measurement) → {Object.<string, any>}

Get a simple dicom element item from a measurement object.

Parameters:

Name	Type	Description
`measurement`	NumericMeasurement	The measurement object.

Source: src/dicom/dicomNumericMeasurement.js, line 83

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomPlaneOrientationItem(orientation) → {object}

Get a dicom element from a plane orientation sequence.

Parameters:

Name	Type	Description
`orientation`	Matrix33	The image orientation.

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

Returns:

The dicom element.

Type:: object

getDicomSRContentItem(content) → {Object.<string, any>}

Get a simple dicom element item from a content item object.

Parameters:

Name	Type	Description
`content`	DicomSRContent	The content item object.

Source: src/dicom/dicomSRContent.js, line 272

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomSegmentFrameInfoItem(frameInfo) → {Object.<string, any>}

Get a dicom item from a frame information object.

Parameters:

Name	Type	Description
`frameInfo`	object	The frame information object.

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

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomSegmentItem(segment) → {Object.<string, any>}

Get a dicom simple tag from a segment object.

Parameters:

Name	Type	Description
`segment`	MaskSegment	The segment object.

Source: src/dicom/dicomSegment.js, line 270

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomSopInstanceReferenceItem(ref) → {Object.<string, any>}

Get a simple dicom element item from a SOP reference object.

Parameters:

Name	Type	Description
`ref`	SopInstanceReference	The SOP reference object.

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

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomSpatialCoordinate3DItem(scoord) → {Object.<string, any>}

Get a simple dicom element item from a scoord3d object.

Parameters:

Name	Type	Description
`scoord`	SpatialCoordinate3D	The scoord3d object.

Source: src/dicom/dicomSpatialCoordinate3D.js, line 85

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomSpatialCoordinateItem(scoord) → {Object.<string, any>}

Get a simple dicom element item from a scoord object.

Parameters:

Name	Type	Description
`scoord`	SpatialCoordinate	The scoord object.

Source: src/dicom/dicomSpatialCoordinate.js, line 103

Returns:

The item as a list of (key, value) pairs.

Type:: Object.<string, any>

getDicomTime(dateObj) → {string}

Get a DICOM formated time string.

Parameters:

Name	Type	Description
`dateObj`	Object	The date to format.

Source: src/dicom/dicomDate.js, line 166

Returns:

The formated time.

Type:: string

getDimensionOrganization(dataElements) → {object}

Check the dimension organization from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The root dicom element.

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

Returns:

The dimension organizations and indices.

Type:: object

getDirIncr(dir) → {Array.<number>}

Get an increment vector for input directions.

Parameters:

Name	Type	Description
`dir`	Array.<number>	The directions.

Source: tests/dicom/squarePixGenerator.js, line 26

Returns:

The increment vector.

Type:: Array.<number>

getDivIds(dataViewConfig) → {Array}

Get the layer group div ids associated to a view config.

Parameters:

Name	Type	Description
`dataViewConfig`	Array	The data view config.

Source: tests/pacs/viewer.ui.datatable.js, line 15

Returns:

The list of div ids.

Type:: Array

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 37

Returns:

The dwv UID prefix.

Type:: string

getDwvUrl(uri) → {string}

Get the dwv url from a data input uri.

Parameters:

Name	Type	Description
`uri`	*	The dwv input uri.

Source: tests/pacs/index.js, line 164

Returns:

The full dwv url.

Type:: string

getDwvVersion() → {string}

Get the version of the library.

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

Returns:

The version of the library.

Type:: string

getElementAsString(tag, dicomElement, prefixopt) → {string}

Get a data element as a string.

Parameters:

Name	Type	Attributes	Description
`tag`	Tag		The DICOM tag.
`dicomElement`	object		The DICOM element.
`prefix`	string	<optional>	A string to prepend this one.

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

Returns:

The element as a string.

Type:: string

getElementValueAsString(tag, dicomElement, prettyopt) → {string}

Get a data element value as a string.

Parameters:

Name	Type	Attributes	Description
`tag`	Tag		The DICOM tag.
`dicomElement`	object		The DICOM element.
`pretty`	boolean	<optional>	When set to true, returns a 'pretified' content.

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

Returns:

A string representation of the DICOM element.

Type:: string

getElementsFromJSONTags(simpleTags) → {Object.<string, DataElement>}

Get the DICOM elements from a 'simple' DICOM tags object. The input object is a simplified version of the oficial DICOM json with tag names instead of keys and direct values (no value property) for simple tags. See synthetic test data (in tests/dicom) for examples.

Parameters:

Name	Type	Description
`simpleTags`	Object.<string, any>	The 'simple' DICOM tags object.

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

Returns:

The DICOM elements.

Type:: Object.<string, DataElement>

getEllipseIndices(center, radius, dir) → {Array.<Index>}

Get the indices that form a ellpise.

Parameters:

Name	Type	Description
`center`	Index	The ellipse center.
`radius`	Array.<number>	The 2 ellipse radiuses.
`dir`	Array.<number>	The 2 ellipse directions.

Source: src/math/ellipse.js, line 242

Returns:

The indices of the ellipse.

Type:: Array.<Index>

getEqualIndexCallback(i0) → {function}

Get an array find callback for an index.

Parameters:

Name	Type	Description
`i0`	Index	The index to find.

Source: tests/dicom/squarePixGenerator.js, line 14

Returns:

The find callback.

Type:: function

getEqualPoint3DFunction(point) → {function}

Get an array find callback for an equal input point.

Parameters:

Name	Type	Description
`point`	Point3D	The point to compare to.

Source: src/math/point.js, line 282

Returns:

A function that compares, using equals, its input point to the one given as input to this function.

Type:: function

getFileConfigsHtmlList(fileName)

Get the list of configs and display them with a download link.

Parameters:

Name	Type	Description
`fileName`	string	The input file name.

Source: tests/dicom/pages/synthetic-data.js, line 99

getFileExtension(filePath) → {string}

Get a file extension: anything after the last dot. File name starting with a dot are discarded. Extensions are expected to contain at least one letter.

Parameters:

Name	Type	Description
`filePath`	string	The file path containing the file name.

Source: src/utils/string.js, line 175

Returns:

The lower case file extension or null for none.

Type:: string

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 884

Returns:

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

Type:: Array | undefined

getFileMetaInformationGroupLengthTag() → {Tag}

Get the FileMetaInformationGroupLength Tag.

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

Returns:

The tag.

Type:: Tag

getFindArrayInArrayCallback(arr1) → {function}

Get a find in array callback.

Parameters:

Name	Type	Description
`arr1`	Uint8Array	The array to find.

Source: src/utils/array.js, line 189

Returns:

The find callback function.

Type:: function

getFlags(inputStr) → {Array.<string>}

Get flags from an input string. Flags are words surrounded with curly braces.

Parameters:

Name	Type	Description
`inputStr`	string	The input string.

Source: src/utils/string.js, line 89

Returns:

An array of found flags.

Type:: Array.<string>

getFullStats(values) → {Statistics}

Get full stats: minimum, maximum, mean, standard deviation, median, 25% and 75% percentile of an array of values.

Parameters:

Name	Type	Description
`values`	Array.<number>	The array of values to extract stats from.

Source: src/math/stats.js, line 136

Returns:

Complete statistics (includes median, p25 and p75).

Type:: Statistics

getIdentityMat33() → {Matrix33}

Create a 3x3 identity matrix.

Source: src/math/matrix.js, line 342

Returns:

The identity matrix.

Type:: Matrix33

getImage2DSize(elements) → {Array.<number>}

Extract the 2D size from dicom elements.

Parameters:

Name	Type	Description
`elements`	DataElements	The DICOM elements.

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

Returns:

The size.

Type:: Array.<number>

getImageReference(dataElements) → {ImageReference}

Get a reference object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomImageReference.js, line 62

Returns:

A reference object.

Type:: ImageReference

getImageRegionCode() → {DicomCode}

Get an image region DICOM code.

Source: src/dicom/dicomCode.js, line 261

Returns:

The code.

Type:: DicomCode

getItemDelimitationItemTag() → {Tag}

Get the ItemDelimitationItem Tag.

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

Returns:

The tag.

Type:: Tag

getItemTag() → {Tag}

Get the Item Tag.

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

Returns:

The tag.

Type:: Tag

getIteratorValues(iterator) → {Array}

Get a list of values for a given iterator.

Parameters:

Name	Type	Description
`iterator`	object	The iterator to use to loop through data.

Source: src/image/iterator.js, line 362

Returns:

The list of values.

Type:: Array

getLPSGroup(code) → {string|undefined}

Get the LPS 'group' (axial, coronal or sagittal) from a LPS code.

Parameters:

Name	Type	Description
`code`	string	The LPS code string.

Source: src/math/orientation.js, line 155

Returns:

The group.

Type:: string | undefined

getLayerDetailsFromEvent(event) → {object}

Get the layer details from a mouse event.

Parameters:

Name	Type	Description
`event`	object	The event to get the layer div id from. Expecting an event origininating from a canvas inside a layer HTML div with the 'layer' class and id generated with `getLayerDivId`.

Source: src/gui/layerGroup.js, line 55

Returns:

The layer details as {groupDivId, layerIndex, layerId}.

Type:: object

getLayerDetailsFromLayerDivId(idString) → {object}

Get the layer details from a div id.

Parameters:

Name	Type	Description
`idString`	string	The layer div id.

Source: src/gui/layerGroup.js, line 35

Returns:

The layer details as {groupDivId, layerIndex, layerId}.

Type:: object

getLayerDivId(groupDivId, layerIndex) → {string}

Get the layer div id.

Parameters:

Name	Type	Description
`groupDivId`	string	The layer group div id.
`layerIndex`	number	The layer index.

Source: src/gui/layerGroup.js, line 25

Returns:

A string id.

Type:: string

getLineFromEquation(slope, intercept, point, length, spacingopt) → {Line}

Get a line from an equation, a middle point and a length.

Parameters:

Name	Type	Attributes	Description
`slope`	number		The line slope.
`intercept`	number		The line intercept.
`point`	Point2D		The middle point of the line.
`length`	number		The line length.
`spacing`	Scalar2D	<optional>	Optional image spacing, default to [1,1].

Source: src/math/line.js, line 315

Returns:

The resulting line.

Type:: Line

getLineShape(group) → {Konva.Line|undefined}

Get a Konva.Line shape from a group.

Parameters:

Name	Type	Description
`group`	Konva.Group	The group to look into.

Source: src/tools/drawBounds.js, line 47

Returns:

The shape.

Type:: Konva.Line | undefined

getMPRDataViewConfig(dataIds) → {object}

Get MPR view config(s).

Parameters:

Name	Type	Description
`dataIds`	Array	The list of dataIds.

Source: tests/pacs/viewer.js, line 619

Returns:

The view config.

Type:: object

getMatrixFromName(name) → {Matrix33|undefined}

Get an orientation matrix from a name.

Parameters:

Name	Type	Description
`name`	string	The orientation name.

Source: src/math/orientation.js, line 61

Returns:

The orientation matrix.

Type:: Matrix33 | undefined

getMatrixInverse(m) → {Matrix33|undefined}

Get the inverse of an input 3*3 matrix.

Ref:

Parameters:

Name	Type	Description
`m`	Matrix33	The input matrix.

Source: src/math/matrix.js, line 300

Returns:

The inverse matrix or undefined if the determinant is zero.

Type:: Matrix33 | undefined

getMeasuredValue(dataElements) → {MeasuredValue}

Get a measured value object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomMeasuredValue.js, line 72

Returns:

A measured value object.

Type:: MeasuredValue

getMeasurementGroupCode() → {DicomCode}

Get a measurement group DICOM code.

Source: src/dicom/dicomCode.js, line 252

Returns:

The code.

Type:: DicomCode

getMeasurementUnitsCode(name) → {DicomCode|undefined}

Get a measurement units DICOM code.

Parameters:

Name	Type	Description
`name`	string	The unit name as defined in a quantification object.

Source: src/dicom/dicomCode.js, line 449

Returns:

The code.

Type:: DicomCode | undefined

getMetaDataWithNames(metaData) → {Object.<string, DataElement>}

Get the meta data indexed by tag names instead of tag keys.

Parameters:

Name	Type	Description
`metaData`	Object.<string, DataElement>	The meta data index by tag keys.

Source: tests/pacs/viewer.js, line 954

Returns:

The meta data indexed by tag names.

Type:: Object.<string, DataElement>

getMousePoint(event) → {Point2D}

Get the offset of an input mouse event.

Parameters:

Name	Type	Description
`event`	object	The event to get the offset from.

Source: src/gui/generic.js, line 105

Returns:

The 2D point.

Type:: Point2D

getNumberToPrecision(precision) → {function}

Get a number toprecision function with the provided precision.

Parameters:

Name	Type	Description
`precision`	number	The precision to achieve.

Source: src/gui/overlayData.js, line 15

Returns:

The to precision function.

Type:: function

getNumericMeasurement(dataElements) → {NumericMeasurement}

Get a measurement object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomNumericMeasurement.js, line 61

Returns:

A measurement object.

Type:: NumericMeasurement

getObjectUrlFromTags(config) → {string}

Create an object url from (JSON) tags.

Parameters:

Name	Type	Description
`config`	object	The data configuration.

Source: tests/dicom/pages/synthetic-data.js, line 25

Returns:

The object URL.

Type:: string

getOnInstancesLoad(seriesUID, numberOfSeries) → {function}

Get an instances QIDO query load handler.

Parameters:

Name	Type	Description
`seriesUID`	string	The series UID.
`numberOfSeries`	number	The number of series.

Source: tests/pacs/dcmweb.js, line 173

Returns:

The hanlder.

Type:: function

getOnLoadError(reqName) → {function}

Get a load error handler.

Parameters:

Name	Type	Description
`reqName`	string	The request name.

Source: tests/pacs/dcmweb.js, line 102

Returns:

The error handler.

Type:: function

getOnebyOneDataViewConfig(dataIds) → {object}

Create 1*2 view config(s).

Parameters:

Name	Type	Description
`dataIds`	Array	The list of dataIds.

Source: tests/pacs/viewer.js, line 564

Returns:

The view config.

Type:: object

getOnebyTwoDataViewConfig(dataIds) → {object}

Create 1*2 view config(s).

Parameters:

Name	Type	Description
`dataIds`	Array	The list of dataIds.

Source: tests/pacs/viewer.js, line 591

Returns:

The view config.

Type:: object

getOrientationFromCosines(cosines) → {Matrix33|undefined}

Get the orientation matrix associated to the direction cosines.

Parameters:

Name	Type	Description
`cosines`	Array.<number>	The image orientation patient cosines (6 values).

Source: src/math/orientation.js, line 198

Returns:

The orientation matrix.

Type:: Matrix33 | undefined

getOrientationMatrix(dataElements) → {Matrix33|undefined}

Get an orientation matrix from a dicom orientation element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The dicom element.

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

Returns:

The orientation matrix.

Type:: Matrix33 | undefined

getOrientationName(cosines) → {string|undefined}

Get the name of an image orientation patient.

Parameters:

Name	Type	Description
`cosines`	Array.<number>	The image orientation patient cosines (6 values).

Source: src/math/orientation.js, line 181

Returns:

The orientation name: axial, coronal or sagittal.

Type:: string | undefined

getOrientationStringLPS(matrix) → {string}

Get the orientation code of an orientation matrix. Each letter defines the towards direction. Letters are: R (right), L (left), A (anterior), P (posterior), I (inferior) and S (superior).

Parameters:

Name	Type	Description
`matrix`	Matrix33	The orientation matrix.

Source: src/math/orientation.js, line 81

Returns:

The orientation code.

Type:: string

getOrientedArray3D(array3D, orientation) → {Array.<number>}

Get the oriented values of an input 3D array.

Parameters:

Name	Type	Description
`array3D`	Array.<number>	The 3D array.
`orientation`	Matrix33	The orientation 3D matrix.

Source: src/image/geometry.js, line 557

Returns:

The values reordered according to the orientation.

Type:: Array.<number>

getPathCode() → {DicomCode}

Get a path DICOM code.

Source: src/dicom/dicomCode.js, line 279

Returns:

The code.

Type:: DicomCode

getPercentile(values, ratio) → {number}

Get an arrays' percentile. Uses linear interpolation for percentiles that lie between data points. See: https://en.wikipedia.org/wiki/Percentile (second variant interpolation).

Parameters:

Name	Type	Description
`values`	Array.<number>	The sorted array of values.
`ratio`	number	The percentile ratio [0-1].

Source: src/math/stats.js, line 161

Returns:

The percentile.

Type:: number

getPerpendicularLine(line, point, length, spacingopt) → {Line}

Get a perpendicular line to an input one at a given point.

Parameters:

Name	Type	Attributes	Description
`line`	Line		The line to be perpendicular to.
`point`	Point2D		The middle point of the perpendicular line.
`length`	number		The length of the perpendicular line.
`spacing`	Scalar2D	<optional>	Optional image spacing, default to [1,1].

Source: src/math/line.js, line 260

Returns:

The perpendicular line.

Type:: Line

getPerpendicularLineAtDistance(line, distance, length, spacingopt) → {Line}

Get a perpendicular line to an input one at a given distance of its begin point.

Parameters:

Name	Type	Attributes	Description
`line`	Line		The line to be perpendicular to.
`distance`	number		The distance to the input line begin point.
`length`	number		The length of the perpendicular line.
`spacing`	Scalar2D	<optional>	Optional image spacing, default to [1,1].

Source: src/math/line.js, line 284

Returns:

The perpendicular line.

Type:: Line

getPixelDataTag() → {Tag}

Get the PixelData Tag.

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

Returns:

The tag.

Type:: Tag

getPixelGeneratorName() → {string}

Source: tests/dicom/pages/generator.js, line 70

Returns:

The name of the selected pixel generator.

Type:: string

getPixelSpacing(elements) → {Spacing}

Get the pixel spacing from the different spacing tags.

Parameters:

Name	Type	Description
`elements`	DataElements	The DICOM elements.

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

Returns:

The read spacing or the default [1,1].

Type:: Spacing

getPixelUnit(elements) → {string|null}

Get the pixel data unit.

Parameters:

Name	Type	Description
`elements`	DataElements	The DICOM elements.

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

Returns:

The unit value if available.

Type:: string | null

getPrecisionRound(precision) → {function}

Get a rounding function for a specific precision.

Parameters:

Name	Type	Description
`precision`	number	The rounding precision.

Source: tests/pacs/viewer.js, line 877

Returns:

The rounding function.

Type:: function

getQuantificationName(code) → {string|undefined}

Get the DICOM code for a quantification name.

Parameters:

Name	Type	Description
`code`	DicomCode	The Dicom code.

Source: src/dicom/dicomCode.js, line 389

Returns:

The quantification name.

Type:: string | undefined

getQuantificationUnit(code) → {string}

Get a quantification unit name.

Parameters:

Name	Type	Description
`code`	DicomCode	The code to get the unit from.

Source: src/dicom/dicomCode.js, line 467

Returns:

The quantification unit.

Type:: string

getRectangleIndices(center, size, dir) → {Array.<Index>}

Get the indices that form a rectangle.

Parameters:

Name	Type	Description
`center`	Index	The rectangle center.
`size`	Array.<number>	The 2 rectangle sizes.
`dir`	Array.<number>	The 2 rectangle directions.

Source: src/math/rectangle.js, line 247

Returns:

The indices of the rectangle.

Type:: Array.<Index>

getReferenceGeometryCode() → {DicomCode}

Get a reference geometry DICOM code.

Source: src/dicom/dicomCode.js, line 270

Returns:

The code.

Type:: DicomCode

getReferencePointsCode() → {DicomCode}

Get a reference points DICOM code.

Source: src/dicom/dicomCode.js, line 333

Returns:

The code.

Type:: DicomCode

getRegionSliceIterator(image, index, isRescaled, min, max) → {object}

Get a slice index iterator for a rectangular region.

Parameters:

Name	Type	Description
`image`	Image	The image to parse.
`index`	Index	The current position.
`isRescaled`	boolean	Flag for rescaled values (default false).
`min`	Point2D	The minimum position (optional).
`max`	Point2D	The maximum position (optional).

Source: src/image/iterator.js, line 508

Returns:

The slice iterator.

Type:: object

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 163

Returns:

Reverse Orientation Label.

Type:: string

getRootPath(path) → {string}

Get the root of an input path. Splits using / as separator.

Parameters:

Name	Type	Description
`path`	string	The input path.

Source: src/utils/string.js, line 163

Returns:

The input path without its last part.

Type:: string

getRulesAndResult0(config) → {object}

Get writing rules #0 and resulting tags.

Parameters:

Name	Type	Description
`config`	object	A JSON config representing DICOM tags.

Source: tests/dicom/dicomWriter.test.js, line 548

Returns:

Rules and resulting tags.

Type:: object

getRunRenderTest(app) → {function}

Run render tests.

Parameters:

Name	Type	Description
`app`	object	The associated application.

Source: tests/pacs/viewer.rendertest.js, line 25

Returns:

The run render text function.

Type:: function

getSRContent(dataElements) → {DicomSRContent}

Get a content item object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomSRContent.js, line 209

Returns:

A content item object.

Type:: DicomSRContent

getSRContentFromValue(name, value, unit) → {DicomSRContent|undefined}

Get a DicomSRContent from a value.

Parameters:

Name	Type	Description
`name`	string	The value name.
`value`	object	The value.
`unit`	string	The values' unit.

Source: src/dicom/dicomSRContent.js, line 347

Returns:

The SR content.

Type:: DicomSRContent | undefined

getSagittalMat33() → {Matrix33}

Create a 3x3 sagittal (yzx) matrix.

Source: src/math/orientation.js, line 27

Returns:

The sagittal matrix.

Type:: Matrix33

getScaledOffset(offset, scale, newScale, center) → {Scalar2D}

Get a scaled offset to adapt to new scale and such as the input center stays at the same position.

Parameters:

Name	Type	Description
`offset`	Scalar2D	The previous offset as {x,y}.
`scale`	Scalar2D	The previous scale as {x,y}.
`newScale`	Scalar2D	The new scale as {x,y}.
`center`	Scalar2D	The scale center as {x,y}.

Source: src/gui/layerGroup.js, line 75

Returns:

The scaled offset as {x,y}.

Type:: Scalar2D

getScoordFromShape(shape) → {SpatialCoordinate}

Get a DICOM spatial coordinate (SCOORD) from a mathematical shape.

Parameters:

Name	Type	Description
`shape`	Point2D \| Line \| Protractor \| ROI \| Circle \| Ellipse \| Rectangle	The math shape.

Source: src/dicom/dicomSpatialCoordinate.js, line 131

Returns:

The DICOM scoord.

Type:: SpatialCoordinate

getSegment(dataElements) → {MaskSegment}

Get a segment object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomSegment.js, line 123

Returns:

A segment object.

Type:: MaskSegment

getSegmentFrameInfo(dataElements) → {DicomSegmentFrameInfo}

Get a frame information object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomSegmentFrameInfo.js, line 100

Returns:

A frame information object.

Type:: DicomSegmentFrameInfo

getSegmentationCode() → {DicomCode}

Get a segmentation DICOM code.

Source: src/dicom/dicomCode.js, line 306

Returns:

The code.

Type:: DicomCode

getSequenceDelimitationItemTag() → {Tag}

Get the SequenceDelimitationItem Tag.

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

Returns:

The tag.

Type:: Tag

getShadowColour(hexColour) → {string}

Get the shadow colour of an input colour.

Parameters:

Name	Type	Description
`hexColour`	string	The colour (as '#ab01ef').

Source: src/utils/colour.js, line 142

Returns:

The shadow colour (white or black).

Type:: string

getShapeDisplayName(shape) → {string}

Get the display name of the input shape.

Parameters:

Name	Type	Description
`shape`	Konva.Shape	The Konva shape.

Source: src/tools/drawCommands.js, line 17

Returns:

The display name.

Type:: string

getShapeFromScoord(scoord) → {Point2D|Line|Protractor|ROI|Circle|Ellipse|Rectangle}

Get a mathematical shape from a DICOM spatial coordinate (SCOORD).

Parameters:

Name	Type	Description
`scoord`	SpatialCoordinate	The DICOM scoord.

Source: src/dicom/dicomSpatialCoordinate.js, line 223

Returns:

The math shape.

Type:: Point2D | Line | Protractor | ROI | Circle | Ellipse | Rectangle

getShapePositionRange(stageSize, shape) → {object}

Get a shape top left position range.

Parameters:

Name	Type	Description
`stageSize`	Scalar2D	The stage size as {x,y}.
`shape`	Konva.Shape	The shape to evaluate.

Source: src/tools/drawBounds.js, line 173

Returns:

The range as {min, max}.

Type:: object

getShortLabelCode() → {DicomCode}

Get a short label DICOM code.

Source: src/dicom/dicomCode.js, line 324

Returns:

The code.

Type:: DicomCode

getSliceGeometrySpacing(origins) → {number|undefined}

Get the slice spacing from the difference in the Z directions of input origins.

Parameters:

Name	Type	Description
`origins`	Array.<Point3D>	An array of Point3D.

Source: src/image/geometry.js, line 582

Returns:

The spacing.

Type:: number | undefined

getSliceIndex(volumeGeometry, sliceGeometry) → {Index}

Get the slice index of an input slice into a volume geometry.

Parameters:

Name	Type	Description
`volumeGeometry`	Geometry	The volume geometry.
`sliceGeometry`	Geometry	The slice geometry.

Source: src/image/image.js, line 28

Returns:

The index of the slice in the volume geomtry.

Type:: Index

getSliceIterator(image, position, isRescaled, viewOrientation) → {object}

Get a slice index iterator.

Parameters:

Name	Type	Description
`image`	Image	The image to parse.
`position`	Index	The current position.
`isRescaled`	boolean	Flag for rescaled values (default false).
`viewOrientation`	Matrix33	The view orientation.

Source: src/image/iterator.js, line 381

Returns:

The slice iterator.

Type:: object

getSopInstanceReference(dataElements) → {SopInstanceReference}

Get a SOP reference object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomSopInstanceReference.js, line 47

Returns:

A SOP reference object.

Type:: SopInstanceReference

getSourceImageCode() → {DicomCode}

Get a source image DICOM code.

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

Returns:

The code.

Type:: DicomCode

getSourceImageForProcessingCode() → {DicomCode}

Get a source image for processing DICOM code.

Source: src/dicom/dicomCode.js, line 315

Returns:

The code.

Type:: DicomCode

getSpacingFromMeasure(dataElements) → {Spacing}

Get a spacing object from a dicom measure element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The dicom element.

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

Returns:

A spacing object.

Type:: Spacing

getSpatialCoordinate(dataElements) → {SpatialCoordinate}

Get a scoord object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomSpatialCoordinate.js, line 78

Returns:

A scoord object.

Type:: SpatialCoordinate

getSpatialCoordinate3D(dataElements) → {SpatialCoordinate3D}

Get a scoord3d object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The dicom element.

Source: src/dicom/dicomSpatialCoordinate3D.js, line 59

Returns:

A scoord3d object.

Type:: SpatialCoordinate3D

getSpinY(event) → {number}

Get a normalised spin speed in the Y direction to try to support trackpads (small and large deltaY) and mouse wheel (large deltaY). Should return 1 or -1 for a single mouse wheel tick.

Parameters:

Name	Type	Description
`event`	object	The wheel event.

Source: src/tools/scrollWheel.js, line 16

Returns:

The normalised spin Y.

Type:: number

getStats(values, flags) → {Statistics}

Get statistics on an input array of number. Note: could use https://github.com/tmcw/simple-statistics.

Parameters:

Name	Type	Description
`values`	Array.<number>	The array of values to extract stats from.
`flags`	Array.<string>	A list of stat value names to calculate.

Source: src/math/stats.js, line 71

Returns:

A statistics object.

Type:: Statistics

getSuvFactor(elements) → {object}

Get the PET SUV factor.

Ref:

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements.

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

Returns:

The value and a warning if the elements are not as expected.

Type:: object

getSyntaxDecompressionName(syntax) → {string|undefined}

Tell if a given syntax needs decompression.

Parameters:

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

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

Returns:

The name of the decompression algorithm.

Type:: string | undefined

getTagFromDictionary(tagName) → {Tag|undefined}

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 325

Returns:

The tag object or null if not found.

Type:: Tag | undefined

getTagFromKey(key) → {Tag}

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

Parameters:

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

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

Returns:

The DICOM tag.

Type:: Tag

getTagKeysReducer(dataElements) → {function}

Get an array reducer to reduce an array of tag keys taken from the input dataElements and return theses dataElements indexed by tag names.

Parameters:

Name	Type	Description
`dataElements`	Object.<string, DataElement>	The meta data index by tag keys.

Source: tests/pacs/viewer.js, line 917

Returns:

An array reducer.

Type:: function

getTargetOrientation(imageOrientation, viewOrientation) → {Matrix33}

Get the target orientation according to an image and view orientation. The target orientation is used to go from target to real space.

Parameters:

Name	Type	Description
`imageOrientation`	Matrix33	The image geometry.
`viewOrientation`	Matrix33	The view orientation.

Source: src/math/orientation.js, line 264

Returns:

The target orientation.

Type:: Matrix33

getThumbInstanceUID(json) → {string}

Get the SOPInstanceUID of the thumbnail instance.

Parameters:

Name	Type	Description
`json`	object	An instances QIDO query result.

Source: tests/pacs/dcmweb.js, line 194

Returns:

The SOPInstanceUID.

Type:: string

getTime(element) → {Object|undefined}

Get a time object with {hours, minutes, seconds} ready for the Date constructor from a DICOM element with vr=TM.

Parameters:

Name	Type	Description
`element`	DataElement	The DICOM element with date information.

Source: src/dicom/dicomDate.js, line 59

Returns:

The time object.

Type:: Object | undefined

getToken() → {string|undefined}

Get the optional token.

Source: tests/pacs/dcmweb.js, line 60

Returns:

The token.

Type:: string | undefined

getTouchPoints(event) → {Array.<Point2D>}

Get the offsets of an input touch event.

Parameters:

Name	Type	Description
`event`	object	The event to get the offset from.

Source: src/gui/generic.js, line 85

Returns:

The array of points.

Type:: Array.<Point2D>

getTouchesPositions(touches) → {Array.<Point2D>}

Get the positions (without the parent offset) of a list of touch events.

Parameters:

Name	Type	Description
`touches`	Array	The list of touch events.

Source: src/gui/generic.js, line 49

Returns:

The list of positions of the touch events.

Type:: Array.<Point2D>

getTrackingIdentifierCode() → {DicomCode}

Get a tracking identifier DICOM code.

Source: src/dicom/dicomCode.js, line 297

Returns:

The code.

Type:: DicomCode

getTransferSyntaxName(syntax) → {string}

Get a transfer syntax name from its UID.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax UID value.

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

Returns:

The transfer syntax name.

Type:: string

getTransferSyntaxUIDTag() → {Tag}

Get the TransferSyntaxUID Tag.

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

Returns:

The tag.

Type:: Tag

getTypedArray(bitsAllocated, pixelRepresentation, size) → {Uint8Array|Int8Array|Uint16Array|Int16Array|Uint32Array|Int32Array}

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`	number	The size of the new array.

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

Returns:

The good typed array.

Type:: Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array

getUID(tagName) → {string}

Get a UID for a DICOM tag.

Note: Use https://github.com/uuidjs/uuid?

Ref:

Parameters:

Name	Type	Description
`tagName`	string	The input tag.

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

Returns:

The corresponding UID.

Type:: string

getUint8ToVrValue(value, vr, isLittleEndianopt) → {object}

Get the casted typed array value from Uint8 to vr type.

Parameters:

Name	Type	Attributes	Description
`value`	object		The value to cast.
`vr`	string		The DICOM element VR.
`isLittleEndian`	boolean	<optional>	Flag to tell if the data is little or big endian (default: true).

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

Returns:

The element value casted to the vr type.

Type:: object

getUriQuery(uri) → {object}

Get the query part, split into an array, of an input URI. The URI scheme is: base?query#fragment.

Parameters:

Name	Type	Description
`uri`	string	The input URI.

Source: src/utils/uri.js, line 58

Returns:

The query part, split into an array, of the input URI.

Type:: object

getUrlFromUri(uri) → {URL}

Get an full object URL from a string uri.

Parameters:

Name	Type	Description
`uri`	string	A string representing the url.

Source: src/utils/uri.js, line 10

Returns:

A URL object.

Type:: URL

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 94

Returns:

The corresponding UTF label.

Type:: string

getVariableRegionSliceIterator(image, index, isRescaled, regions) → {object|undefined}

Get a slice index iterator for a rectangular region.

Parameters:

Name	Type	Description
`image`	Image	The image to parse.
`index`	Index	The current position.
`isRescaled`	boolean	Flag for rescaled values (default false).
`regions`	Array.<Array.<Array.<number>>>	An array of [x, y] pairs (min, max).

Source: src/image/iterator.js, line 566

Returns:

The slice iterator.

Type:: object | undefined

getVectorStringLPS(vector) → {string}

Get the orientation code of an orientation vector. Credits: David Clunie, https://www.dclunie.com/medical-image-faq/html/part2.html.

Parameters:

Name	Type	Description
`vector`	Vector3D	The orientation vector.

Source: src/math/orientation.js, line 109

Returns:

The orientation code.

Type:: string

getViewFromDOMImage(domImage, origin, index) → {object}

Get data from an input image using a canvas.

Parameters:

Name	Type	Description
`domImage`	HTMLImageElement	The DOM Image, an HTMLImageElement with extra info.
`origin`	string \| File	The data origin.
`index`	number	The data index.

Source: src/image/domReader.js, line 74

Returns:

A load data event.

Type:: object

getViewFromDOMVideo(video, onloaditem, onload, onprogress, onloadend, origin, dataIndex)

Get data from an input image using a canvas.

Parameters:

Name	Type	Description
`video`	object	The DOM Video, an HTMLVideoElement with extra info.
`onloaditem`	function	On load callback.
`onload`	object	The function to call once the data is loaded.
`onprogress`	object	The function to call to report progress.
`onloadend`	object	The function to call to report load end.
`origin`	string \| File	The data origin.
`dataIndex`	number	The data index.

Source: src/image/domReader.js, line 129

getViewOrientation(imageOrientation, targetOrientation) → {Matrix33}

Get the view orientation according to an image and target orientation. The view orientation is used to go from target to image space.

Parameters:

Name	Type	Description
`imageOrientation`	Matrix33	The image geometry.
`targetOrientation`	Matrix33	The target orientation.

Source: src/math/orientation.js, line 241

Returns:

The view orientation.

Type:: Matrix33

getVrPad(vr) → {string}

Get the VR specific padding value.

Parameters:

Name	Type	Description
`vr`	string	The element VR.

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

Returns:

The value used to pad.

Type:: string

getZeroIndex(size) → {Index}

Get an index with values set to 0 and the input size.

Parameters:

Name	Type	Description
`size`	number	The size of the index.

Source: src/math/index.js, line 175

Returns:

The zero index.

Type:: Index

gradDirection(gradX, gradY, px, py, qx, qy) → {number}

Compute the gradient direction.

Parameters:

Name	Type	Description
`gradX`	Array	The X gradient.
`gradY`	Array	The Y gradient.
`px`	number	The point X.
`py`	number	The point Y.
`qx`	number	The q X.
`qy`	number	The q Y.

Source: src/math/scissors.js, line 250

Returns:

The direction.

Type:: number

gradUnitVector(gradX, gradY, px, py, out)

Compute the gradient unit vector.

Parameters:

Name	Type	Description
`gradX`	Array	The X gradient.
`gradY`	Array	The Y gradient.
`px`	number	The point X.
`py`	number	The point Y.
`out`	object	The result.

Source: src/math/scissors.js, line 227

guessTransferSyntax(firstDataElement) → {DataElement}

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`	DataElement	The first data element of the DICOM header.

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

Returns:

The transfer syntax data element.

Type:: DataElement

guid() → {string}

Unique ID generator.

See http://stackoverflow.com/questions/105034/create-guid-uuid-in-javascript and this answer.

Source: src/math/stats.js, line 192

Returns:

A unique ID.

Type:: string

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 44

Returns:

True if the buffer includes the prefix.

Type:: boolean

hexToRgb(hexStr) → {RGB}

Convert a hex color into RGB.

Parameters:

Name	Type	Description
`hexStr`	string	The hex color as '#ab01ef'.

Source: src/utils/colour.js, line 89

Returns:

The RGB values as {r,g,b}.

Type:: RGB

id(i) → {number}

Identity, returns i.

Parameters:

Name	Type	Description
`i`	number	The input index.

Source: src/image/luts.js, line 80

Returns:

The lut value.

Type:: number

imageDataToBuffer(imageData) → {Uint8Array}

Create a simple array buffer from an ImageData buffer.

Parameters:

Name	Type	Description
`imageData`	object	The ImageData taken from a context.

Source: src/image/domReader.js, line 13

Returns:

The image buffer.

Type:: Uint8Array

includesFullStatsFlags(flags) → {boolean}

Does the input flag list contain a full stat element?

Parameters:

Name	Type	Description
`flags`	Array.<string>	A list of stat values to calculate.

Source: src/math/stats.js, line 85

Returns:

True if one of the flags is a full stat flag.

Type:: boolean

invId(i) → {number}

Returns lut_range_max minus one minus i.

Parameters:

Name	Type	Description
`i`	number	The input index.

Source: src/image/luts.js, line 90

Returns:

The lut value.

Type:: number

is32bitVLVR(vr) → {boolean}

Does the input Value Representation (VR) have a 32bit Value Length (VL).

Parameters:

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

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

Returns:

True if this VR has a 32-bit VL.

Type:: boolean

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 205

Returns:

True if a big endian syntax.

Type:: boolean

isCharSetStringVR(vr) → {boolean}

Does the input Value Representation (VR) have an special character repertoire.

Parameters:

Name	Type	Description
`vr`	string	The data VR.

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

Returns:

True if this VR has a special char set.

Type:: boolean

isDarkColour(hexColour) → {boolean}

Check if a colour given in hexadecimal format is dark.

Parameters:

Name	Type	Description
`hexColour`	string	The colour (as '#ab01ef').

Source: src/utils/colour.js, line 132

Returns:

True if the colour is dark (brightness < 0.5).

Type:: boolean

isEqualCode(code1, code2) → {boolean}

Check if two code objects are equal.

Parameters:

Name	Type	Description
`code1`	DicomCode	The first code.
`code2`	DicomCode	The second code.

Source: src/dicom/dicomCode.js, line 80

Returns:

True if both codes are equal.

Type:: boolean

isEqualContentItem(item1, item2) → {boolean}

Check if two content item objects are equal.

Parameters:

Name	Type	Description
`item1`	DicomCode	The first content item.
`item2`	DicomCode	The second content item.

Source: src/dicom/dicomSRContent.js, line 195

Returns:

True if both content items are equal.

Type:: boolean

isEqualRgb(c1, c2) → {boolean}

Check if two rgb objects are equal.

Parameters:

Name	Type	Description
`c1`	RGB	The first colour.
`c2`	RGB	The second colour.

Source: src/utils/colour.js, line 53

Returns:

True if both colour are equal.

Type:: boolean

isEqualSegment(seg1, seg2) → {boolean}

Check if two segment objects are equal.

Parameters:

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

Source: src/dicom/dicomSegment.js, line 195

Returns:

True if both segment are equal.

Type:: boolean

isEqualSegmentFrameInfo(dsfi1, dsfi2) → {boolean}

Check if two frame info objects are equal.

Parameters:

Name	Type	Description
`dsfi1`	DicomSegmentFrameInfo	The first frame info.
`dsfi2`	DicomSegmentFrameInfo	The second frame info.

Source: src/dicom/dicomSegmentFrameInfo.js, line 196

Returns:

True if both frame info are equal.

Type:: boolean

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 160

Returns:

True is the number is even.

Type:: boolean

isFileMetaInformationGroupLengthTag(tag) → {boolean}

Is the input tag the FileMetaInformationGroupLength Tag.

Parameters:

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

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

Returns:

True if the asked tag.

Type:: boolean

isIdentityMat33(mat33) → {boolean}

Check if a matrix is a 3x3 identity matrix.

Parameters:

Name	Type	Description
`mat33`	Matrix33	The matrix to test.

Source: src/math/matrix.js, line 358

Returns:

True if identity.

Type:: boolean

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 195

Returns:

True if an implicit syntax.

Type:: boolean

isItemDelimitationItemTag(tag) → {boolean}

Is the input tag the ItemDelimitationItem Tag.

Parameters:

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

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

Returns:

True if the asked tag.

Type:: boolean

isItemTag(tag) → {boolean}

Is the input tag the Item Tag.

Parameters:

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

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

Returns:

True if the asked tag.

Type:: boolean

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 237

Returns:

True if a jpeg 2000 syntax.

Type:: boolean

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 215

Returns:

True if a jpeg baseline syntax.

Type:: boolean

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

isKnownVR(vr) → {boolean}

Is the input VR a known VR.

Parameters:

Name	Type	Description
`vr`	string	The vr to test.

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

Returns:

True if known.

Type:: boolean

isNativeLittleEndian() → {boolean}

Is the Native endianness Little Endian.

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

Returns:

True if little endian.

Type:: boolean

isNodeNameLabel(node) → {boolean}

Is an input node's name 'label'.

Parameters:

Name	Type	Description
`node`	Konva.Node	A Konva node.

Source: src/tools/drawBounds.js, line 17

Returns:

True if the node's name is 'label'.

Type:: boolean

isNodeNameShape(node) → {boolean}

Is an input node's name 'shape'.

Parameters:

Name	Type	Description
`node`	Konva.Node	A Konva node.

Source: src/tools/drawBounds.js, line 27

Returns:

True if the node's name is 'shape'.

Type:: boolean

isNodeWithId(id) → {testFn}

Get a lambda to check a node's id.

Parameters:

Name	Type	Description
`id`	string	The id to check.

Source: src/tools/drawBounds.js, line 84

Returns:

A function to check a node's id.

Type:: testFn

isPixelDataTag(tag) → {boolean}

Is the input tag the PixelData Tag.

Parameters:

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

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

Returns:

True if the asked tag.

Type:: boolean

isPointInLineRange(point, line) → {boolean}

Check if a point is in a line coordinate range.

Parameters:

Name	Type	Description
`point`	Point2D	The input point.
`line`	Line	The input line.

Source: src/math/line.js, line 240

Returns:

True if the input point is in the line coordinate range.

Type:: boolean

isPositionNode(node) → {boolean}

Is an input node a position node.

Parameters:

Name	Type	Description
`node`	Konva.Node	A Konva node.

Source: src/tools/drawBounds.js, line 37

Returns:

True if the node's name is 'position-group'.

Type:: boolean

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 277

Returns:

True if a supported syntax.

Type:: boolean

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 247

Returns:

True if a RLE syntax.

Type:: boolean

isSequenceDelimitationItemTag(tag) → {boolean}

Is the input tag the SequenceDelimitationItem Tag.

Parameters:

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

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

Returns:

True if the asked tag.

Type:: boolean

isShapeInRange(shape, min, max) → {boolean}

Is an input shape top left position in the input range.

Parameters:

Name	Type	Description
`shape`	Konva.Shape	The shape to evaluate.
`min`	Point2D	The minimum top left position.
`max`	Point2D	The maximum top left position.

Source: src/tools/drawBounds.js, line 191

Returns:

True if in range.

Type:: boolean

isSimilar(a, b, tol) → {boolean}

Check if two numbers are similar.

Parameters:

Name	Type	Description
`a`	number	The first number.
`b`	number	The second number.
`tol`	number	The comparison tolerance, default to Number.EPSILON.

Source: src/math/matrix.js, line 23

Returns:

True if similar.

Type:: boolean

isSimilarSegment(seg1, seg2) → {boolean}

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

Parameters:

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

Source: src/dicom/dicomSegment.js, line 239

Returns:

True if both segment are similar.

Type:: boolean

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 183

Returns:

True if the VR is a string one.

Type:: boolean

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 171

Returns:

True if the VR is a typed array one.

Type:: boolean

isValidRules() → {boolean}

Is the JSON valid?

Source: tests/dicom/pages/anonymiser.js, line 101

Returns:

True if the input JSON is valid.

Type:: boolean

isValidTags() → {boolean}

Is the JSON valid?

Source: tests/dicom/pages/generator.js, line 198

Returns:

True if the tags are a valid JSON.

Type:: boolean

isVrToPad(vr) → {boolean}

Is the input VR a VR that could need padding.

See http://dicom.nema.org/medical/dicom/2022a/output/chtml/part05/sect_6.2.html.

Parameters:

Name	Type	Description
`vr`	string	The element VR.

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

Returns:

True if the VR needs padding.

Type:: boolean

konvaToAnnotation(drawings, drawingsDetails) → {Array.<Annotation>}

Convert a KonvaLayer object to a list of annotations.

Parameters:

Name	Type	Description
`drawings`	Array	An array of drawings stored with 'KonvaLayer().toObject()'.
`drawingsDetails`	Array.<DrawDetails>	An array of drawings details.

Source: src/gui/drawLayer.js, line 1285

Returns:

The associated list of annotations.

Type:: Array.<Annotation>

labToUintLab(triplet) → {object}

CIE LAB value (L: [0, 100], a: [-128, 127], b: [-128, 127]) to unsigned int CIE LAB ([0, 65535]).

Parameters:

Name	Type	Description
`triplet`	object	CIE XYZ triplet as {l,a,b} with CIE LAB range.

Source: src/utils/colour.js, line 170

Returns:

CIE LAB triplet as {l,a,b} with unsigned range.

Type:: object

launchJSONLint()

Open JSONLint to check the rules.

Source: tests/dicom/pages/anonymiser.js, line 114

launchJSONLint()

Open JSONLint to check the tags.

Source: tests/dicom/pages/generator.js, line 211

launchMainQido()

Launch main QIDO query to retrieve series.

Source: tests/pacs/dcmweb.js, line 115

launchQido(url, loadCallback, reqName)

Launch a QIDO request.

Parameters:

Name	Type	Description
`url`	string	The url of the request.
`loadCallback`	function	The load callback.
`reqName`	string	The request name.

Source: tests/pacs/dcmweb.js, line 227

launchStowInstances()

Launch a STOW request per instances.

Source: tests/pacs/dcmweb.js, line 335

launchStowMultipart()

Launch a STOW request with multipart data. Beware: large request could timeout...

Source: tests/pacs/dcmweb.js, line 258

logFramePosPats(elements)

Log the DICCOM seg segments ordered by frame position patients.

Parameters:

Name	Type	Description
`elements`	object	The DICOM seg elements.

Source: tests/pacs/viewer.js, line 888

mergeConfigs(config, configToMerge) → {object}

Merge a data config into the first input one. Copies all but the divId and orientation property.

Parameters:

Name	Type	Description
`config`	object	The config where to merge.
`configToMerge`	object	The config to merge.

Source: tests/pacs/viewer.js, line 510

Returns:

The updated config.

Type:: object

mergeObjects(obj1, obj2, idKey, valueKey) → {object}

Merge two similar objects.

Objects need to be in the form of: { idKey: {valueKey: [0]}, key0: {valueKey: ["abc"]}, key1: {valueKey: [33]} }.

Merged objects will be in the form of: { idKey: {valueKey: [0,1,2], merged: true}, key0: {valueKey: { 0: ["abc"], 1: ["def"], 2: ["ghi"] }}, key1: {valueKey: { 0: [33], 1: [44], 2: [55] }} }.

Parameters:

Name	Type	Description
`obj1`	object	The first object, can be the result of a previous merge.
`obj2`	object	The second object.
`idKey`	string	The key to use as index for duplicate values.
`valueKey`	string	The key to use to access object values.

Source: src/utils/operator.js, line 38

Returns:

The merged object.

Type:: object

mergeTags(tags1, tags2)

Merge two tag lists.

Parameters:

Name	Type	Description
`tags1`	object	Base list, will be modified.
`tags2`	object	List to merge.

Source: src/image/annotationGroupFactory.js, line 57

mergeTags(tags1, tags2)

Merge two tag lists.

Parameters:

Name	Type	Description
`tags1`	object	Base list, will be modified.
`tags2`	object	List to merge.

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

mprCheckTags(tags, image) → {boolean}

Check tags are coherent with image size.

Parameters:

Name	Type	Description
`tags`	object	The tags to check.
`image`	object	The associated image.

Source: tests/dicom/mprPixGenerator.js, line 218

Returns:

True if the tags are ok.

Type:: boolean

mulABC(a, b, c) → {number}

Mulitply the three inputs if the last two are not null.

Parameters:

Name	Type	Description
`a`	number	The first input.
`b`	number	The second input.
`c`	number	The third input.

Source: src/math/circle.js, line 19

Returns:

The multiplication of the three inputs or null if one of the last two is null.

Type:: number

mulABC(a, b, c) → {number}

Mulitply the three inputs if the last two are not null.

Parameters:

Name	Type	Description
`a`	number	The first input.
`b`	number	The second input.
`c`	number	The third input.

Source: src/math/ellipse.js, line 20

Returns:

The multiplication of the three inputs or null if one of the last two is null.

Type:: number

mulABC(a, b, c) → {number}

Mulitply the three inputs if the last two are not null.

Parameters:

Name	Type	Description
`a`	number	The first input.
`b`	number	The second input.
`c`	number	The third input.

Source: src/math/rectangle.js, line 20

Returns:

The multiplication of the three inputs or null if one of the last two is null.

Type:: number

onChangeParsers(input)

Handle a parser change.

Parameters:

Name	Type	Description
`input`	object	The new parser.

Source: tests/bench/bench.js, line 230

onChangeTests(input)

Handle a parser test change.

Parameters:

Name	Type	Description
`input`	object	The new test.

Source: tests/bench/bench.js, line 245

onDOMContentLoaded()

Setup.

Source: tests/dicom/pages/anonymiser.js, line 10

onDOMContentLoaded()

Setup.

Source: tests/dicom/pages/generator.js, line 16

onDOMContentLoaded()

Setup.

Source: tests/dicom/pages/synthetic-data.js, line 14

onDOMContentLoaded()

Setup.

Source: tests/image/pages/colourmaps.js, line 10

onDOMContentLoaded()

Setup.

Source: tests/pacs/dcmweb.js, line 10

onDOMContentLoaded()

Setup.

Source: tests/pacs/index.js, line 7

onDOMContentLoaded()

Setup.

Source: tests/pacs/viewer.js, line 371

onGenerate()

Generate DICOM data.

Source: tests/dicom/pages/generator.js, line 79

onInputDICOMFile(event)

Handle input DICOM file.

Parameters:

Name	Type	Description
`event`	object	The input field event.

Source: tests/dicom/pages/anonymiser.js, line 125

onInputImageFiles(event)

Handle input image file.

Parameters:

Name	Type	Description
`event`	object	The input field event.

Source: tests/dicom/pages/generator.js, line 239

onInputRulesFile(event)

Handle input rules file.

Parameters:

Name	Type	Description
`event`	object	The input field event.

Source: tests/dicom/pages/anonymiser.js, line 140

onInputTagsFile(event)

Handle input tags file.

Parameters:

Name	Type	Description
`event`	object	The input field event.

Source: tests/dicom/pages/generator.js, line 222

onLoadDICOMFile(event)

Handle DICOM file load.

Parameters:

Name	Type	Description
`event`	object	The onload event.

Source: tests/dicom/pages/anonymiser.js, line 38

onLocalChkChange()

Update dicom links on checkbox change.

Source: tests/pacs/index.js, line 238

onSaveTags()

Save the tags as a JSON file.

Source: tests/dicom/pages/generator.js, line 178

onSeriesLoad(json)

Handle a series QIDO query load.

Parameters:

Name	Type	Description
`json`	Array	JSON array data.

Source: tests/pacs/dcmweb.js, line 137

onViewGithubHosted()

Handle click on the view github hosted button.

Source: tests/pacs/index.js, line 248

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 239

Returns:

The padded input.

Type:: Array | Uint8Array

padZeroTwoDigit(str) → {string}

Pad an input string with a '0' to form a 2 digit one.

Parameters:

Name	Type	Description
`str`	string	The string to pad.

Source: src/dicom/dicomDate.js, line 9

Returns:

The padded string.

Type:: string

parseMultipart(arr) → {Array}

Extract each element of a multipart ArrayBuffer.

Ref: https://en.wikipedia.org/wiki/MIME#Multipart_messages.

Parameters:

Name	Type	Description
`arr`	ArrayBuffer	The multipart array.

Source: src/utils/array.js, line 209

Returns:

The multipart parts as an array of object as {'Content-Type', ..., data} (depending on header tags).

Type:: Array

precisionRound(number, precision) → {number}

Round a float number to a given precision.

Inspired from https://stackoverflow.com/a/49729715/3639892.

Can be a solution to not have trailing zero as when using toFixed or toPrecision. '+number.toFixed(precision)' does not pass all the tests...

Parameters:

Name	Type	Description
`number`	number	The number to round.
`precision`	number	The rounding precision.

Source: src/utils/string.js, line 220

Returns:

The rounded number.

Type:: number

qidoResponseToTable()

Show the QIDO response as a table.

Source: tests/pacs/dcmweb.js, line 418

range(dataAccessor, start, maxIter, increment, blockMaxIter, blockIncrement, reverse1, reverse2) → {object}

Get an iterator for a given range for a one component data.

Using 'maxIter' and not an 'end' index since it fails in some edge cases (for ex coronal2, ie zxy).

Parameters:

Name	Type	Description
`dataAccessor`	function	Function to access data.
`start`	number	Zero-based index at which to start the iteration.
`maxIter`	number	The maximum number of iterations.
`increment`	number	Increment between indicies.
`blockMaxIter`	number	Number of applied increment after which blockIncrement is applied.
`blockIncrement`	number	Increment after blockMaxIter is reached, the value is from block start to the next block start.
`reverse1`	boolean	If true, loop from end to start. WARN: don't forget to set the value of start as the last index!
`reverse2`	boolean	If true, loop from block end to block start.

Source: src/image/iterator.js, line 66

Returns:

An iterator folowing the iterator and iterable protocol.

Type:: object

range3d(dataAccessor, start, maxIter, increment, blockMaxIter, blockIncrement, reverse1, reverse2, isPlanar) → {object}

Get an iterator for a given range for a 3 components data.

Using 'maxIter' and not an 'end' index since it fails in some edge cases (for ex coronal2, ie zxy).

Parameters:

Name	Type	Description
`dataAccessor`	function	Function to access data.
`start`	number	Zero-based index at which to start the iteration.
`maxIter`	number	The maximum number of iterations.
`increment`	number	Increment between indicies.
`blockMaxIter`	number	Number of applied increment after which blockIncrement is applied.
`blockIncrement`	number	Increment after blockMaxIter is reached, the value is from block start to the next block start.
`reverse1`	boolean	If true, loop from end to start. WARN: don't forget to set the value of start as the last index!
`reverse2`	boolean	If true, loop from block end to block start.
`isPlanar`	boolean	A flag to know if the data is planar (RRRR...GGGG...BBBB...) or not (RGBRGBRGBRGB...), defaults to false.

Source: src/image/iterator.js, line 294

Returns:

An iterator folowing the iterator and iterable protocol.

Type:: object

rangeRegion(dataAccessor, start, end, increment, regionSize, regionOffset) → {object}

Get an iterator for a given range with bounds (for a one component data).

Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Parameters:

Name	Type	Description
`dataAccessor`	function	Function to access data.
`start`	number	The start of the range (included).
`end`	number	The end of the range (excluded).
`increment`	number	The increment between indicies.
`regionSize`	number	The size of the region to iterate through.
`regionOffset`	number	The offset between regions.

Source: src/image/iterator.js, line 137

Returns:

An iterator folowing the iterator and iterable protocol.

Type:: object

rangeRegions(dataAccessor, start, end, increment, regions) → {object}

Get an iterator for a given range with bounds (for a one component data).

Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Parameters:

Name	Type	Description
`dataAccessor`	function	Function to access data.
`start`	number	The start of the range (included).
`end`	number	The end of the range (excluded).
`increment`	number	The increment between indicies.
`regions`	Array.<Array.<number>>	An array of regions: [off0, size, off1].

Source: src/image/iterator.js, line 178

Returns:

An iterator folowing the iterator and iterable protocol.

Type:: object

replaceFlags(inputStr, values) → {string}

Replace flags in a input string. Flags are keywords surrounded with curly braces in the form: '{v0}, {v1}'.

Parameters:

Name	Type	Description
`inputStr`	string	The input string.
`values`	Array.<string>	An array of strings.

Source: src/gui/overlayData.js, line 52

Returns:

The result string.

Type:: string

Example

var values = ["a", "b"];
   var str = "The length is: {v0}. The size is: {v1}";
   var res = replaceFlags(str, values);
   // "The length is: a. The size is: b"

replaceFlags(inputStr, values) → {string}

Replace flags in a input string. Flags are keywords surrounded with curly braces.

Parameters:

Name	Type	Description
`inputStr`	string	The input string.
`values`	object	A object of {value, unit}.

Source: src/utils/string.js, line 115

Returns:

The result string.

Type:: string

rgbToHex(rgb) → {string}

Convert RGB to its hex equivalent.

Parameters:

Name	Type	Description
`rgb`	RGB	The RGB object as {r,g,b}.

Source: src/utils/colour.js, line 103

Returns:

A string representing the hex color as '#ab01ef'.

Type:: string

runIterator(iter) → {Array}

Run an input iterator and store values.

Parameters:

Name	Type	Description
`iter`	object	The iterator.

Source: tests/image/iterator.test.js, line 171

Returns:

The result array.

Type:: Array

saveRules()

Save the rules as a JSON file.

Source: tests/dicom/pages/anonymiser.js, line 81

setAppTool(toolNameopt)

Set the app tool.

Parameters:

Name	Type	Attributes	Description
`toolName`	string	<optional>	The tool to set.

Source: tests/pacs/viewer.js, line 794

setupAbout()

Setup about line.

Source: tests/pacs/viewer.js, line 966

setupBindersCheckboxes()

Setup the binders checkboxes.

Source: tests/pacs/viewer.js, line 642

setupData()

Setup the data.

Source: tests/bench/bench.js, line 182

setupParsers()

Setup the parsers.

Source: tests/bench/bench.js, line 121

setupTests()

Setup the tests.

Source: tests/bench/bench.js, line 151

setupToolsCheckboxes()

Setup the tools checkboxes.

Source: tests/pacs/viewer.js, line 736

showMessage(text, typeopt)

Show a message.

Parameters:

Name	Type	Attributes	Description
`text`	string		The text message.
`type`	string	<optional>	The message type used as css class.

Source: tests/pacs/dcmweb.js, line 26

showProgress(text)

Show a progress message.

Parameters:

Name	Type	Description
`text`	string	The text message.

Source: tests/pacs/dcmweb.js, line 40

simpleRange(dataAccessor, start, end, incrementopt) → {object}

Get an simple iterator for a given range for a one component data.

Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Parameters:

Name	Type	Attributes	Description
`dataAccessor`	function		Function to access data.
`start`	number		The start of the range (included).
`end`	number		The end of the range (excluded).
`increment`	number	<optional>	The increment between indicies (default=1).

Source: src/image/iterator.js, line 22

Returns:

An iterator folowing the iterator and iterable protocol.

Type:: object

simpleRange3d(dataAccessor, start, end, increment, isPlanar) → {object}

Get an iterator for a given range for a 3 components data.

Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Parameters:

Name	Type	Description
`dataAccessor`	function	Function to access data.
`start`	number	The start of the range (included).
`end`	number	The end of the range (excluded). (end - start) needs to be a multiple of 3...
`increment`	number	The increment between indicies (default=1).
`isPlanar`	boolean	A flag to know if the data is planar (RRRR...GGGG...BBBB...) or not (RGBRGBRGBRGB...), defaults to false.

Source: src/image/iterator.js, line 229

Returns:

A 3 components iterator folowing the iterator and iterable protocol, the value is an array of size 3 with each component.

Type:: object

sortByPosPatKey(obj) → {object}

Sort an object with pos pat string keys.

Parameters:

Name	Type	Description
`obj`	object	The object to sort.

Source: tests/pacs/viewer.js, line 860

Returns:

The sorted object.

Type:: object

splitAnnotationDivId(divId) → {object}

Split a divId to get dataId and annotationId.

Parameters:

Name	Type	Description
`divId`	string	The divId.

Source: tests/pacs/viewer.ui.annot.js, line 38

Returns:

The data and annotation ID.

Type:: object

splitKeyValueString(inputStr) → {object}

Split key/value string: key0=val00&key0=val01&key1=val10 will return{key0 : [val00, val01], key1 : val1}`.

Parameters:

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

Source: src/utils/string.js, line 58

Returns:

The split string.

Type:: object

splitUri(uri) → {object}

Split an input URI: 'root?key0=val00&key0=val01&key1=val10' returns { base : root, query : [ key0 : [val00, val01], key1 : val1 ] } Returns an empty object if the input string is not correct (null, empty...) or if it is not a query string (no question mark).

Parameters:

Name	Type	Description
`uri`	string	The string to split.

Source: src/utils/uri.js, line 30

Returns:

The split string.

Type:: object

srgbToCielab(triplet) → {object}

Convert sRGB to CIE LAB (standard illuminant D65).

Parameters:

Name	Type	Description
`triplet`	RGB	'sRGB' triplet as {r,g,b}.

Source: src/utils/colour.js, line 360

Returns:

CIE LAB triplet as {l,a,b}.

Type:: object

srgbToCiexyz(triplet) → {Scalar3D}

Convert sRGB to CIE XYZ.

Ref: https://en.wikipedia.org/wiki/SRGB#From_sRGB_to_CIE_XYZ.

Parameters:

Name	Type	Description
`triplet`	RGB	'sRGB' triplet as {r,g,b}.

Source: src/utils/colour.js, line 316

Returns:

CIE XYZ triplet as {x,y,z}.

Type:: Scalar3D

startsWith(str, search, rawPosopt) → {boolean}

Check if a string starts with the input element.

Parameters:

Name	Type	Attributes	Description
`str`	string		The input string.
`search`	string		The searched start.
`rawPos`	number	<optional>	The position in this string at which to begin searching for searchString. Defaults to 0.

Source: src/utils/string.js, line 27

Returns:

True if the input string starts with the searched string.

Type:: boolean

stringToUint8Array(str) → {Uint8Array}

Convert a string to a Uint8Array.

Parameters:

Name	Type	Description
`str`	string	The string to convert.

Source: src/utils/string.js, line 199

Returns:

The Uint8Array.

Type:: Uint8Array

tagCompareFunction(a, b) → {number}

Tag compare function.

Parameters:

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

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

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

testSegment(segment, assert, testName)

MaskSegment test: translate to element and back.

Parameters:

Name	Type	Description
`segment`	object	The segment as an object.
`assert`	object	The QUnit assert.
`testName`	string	The test name.

Source: tests/dicom/dicomSegment.test.js, line 46

testSegmentFrameInfo(frameInfo, assert, testName)

SegmentFrameInfo test: translate to element and back.

Parameters:

Name	Type	Description
`frameInfo`	object	The frameInfo as an object.
`assert`	object	The QUnit assert.
`testName`	string	The test name.

Source: tests/dicom/dicomSegmentFrameInfo.test.js, line 23

testWriteReadDataFromConfig(config, assert, writerRulesopt, outConfigopt)

Test a JSON config: write a DICOM file and read it back.

Parameters:

Name	Type	Attributes	Description
`config`	object		A JSON config representing DICOM tags.
`assert`	object		A Qunit assert.
`writerRules`	Object.<string, WriterRule>	<optional>	Optional DICOM writer rules.
`outConfig`	object	<optional>	Optional resulting JSON after applying writer rules.

Source: tests/dicom/dicomWriter.test.js, line 484

toMaxFirstThird(i) → {number}

Ramp to lut_range_max minus one on the first third values.

Parameters:

Name	Type	Description
`i`	number	The input index.

Source: src/image/luts.js, line 27

Returns:

The lut value.

Type:: number

toMaxSecondThird(i) → {number}

Ramp to lut_range_max minus one on the second third values, otherwise return 0 for the first third and lut_range_max minus one for the last third.

Parameters:

Name	Type	Description
`i`	number	The input index.

Source: src/image/luts.js, line 43

Returns:

The lut value.

Type:: number

toMaxThirdThird(i) → {number}

Ramp to lut_range_max minus one on the last third values, otherwise return 0.

Parameters:

Name	Type	Description
`i`	number	The input index.

Source: src/image/luts.js, line 62

Returns:

The lut value.

Type:: number

toStringId(arr, dimsopt) → {string}

Get a string id from array values in the form of: '#0-1_#1-2'.

Parameters:

Name	Type	Attributes	Description
`arr`	Array		The input array.
`dims`	Array.<number>	<optional>	Optional list of dimensions to use.

Source: src/utils/array.js, line 10

Returns:

The string id.

Type:: string

uint8ArrayPush(arr, value) → {Uint8Array}

Push a value at the end of an input Uint8Array.

Parameters:

Name	Type	Description
`arr`	Array \| Uint8Array	The input array.
`value`	Array \| Uint8Array	The value to push.

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

Returns:

The new array.

Type:: Uint8Array

uint8ArrayToString(arr) → {string}

Convert a Uint8Array to a string.

Parameters:

Name	Type	Description
`arr`	Uint8Array	The array to convert.

Source: src/utils/array.js, line 147

Returns:

The array as string.

Type:: string

uintLabToLab(triplet) → {object}

Unsigned int CIE LAB value ([0, 65535]) to CIE LAB value (L: [0, 100], a: [-128, 127], b: [-128, 127]).

Parameters:

Name	Type	Description
`triplet`	object	CIE LAB triplet as {l,a,b} with unsigned range.

Source: src/utils/colour.js, line 153

Returns:

CIE LAB triplet as {l,a,b} with CIE LAB range.

Type:: object

updateDataList(datalist)

Update the data list of the data runner.

Parameters:

Name	Type	Description
`datalist`	Array	The new data list.

Source: tests/bench/bench.js, line 104

v01Tov02DrawingsAndDetails(inputDrawings) → {object}

Convert drawings from v0.1 to v0.2:

v0.1: text on its own,
v0.2: text as part of label.

Parameters:

Name	Type	Description
`inputDrawings`	Array	An array of drawings.

Source: src/io/state.js, line 293

Returns:

The converted drawings.

Type:: object

v02Tov03Drawings(drawings) → {object}

Convert drawings from v0.2 to v0.3:

v0.2: one layer per slice/frame,
v0.3: one layer, one group per slice. setDrawing expects the full stage.

Parameters:

Name	Type	Description
`drawings`	Array	An array of drawings.

Source: src/io/state.js, line 221

Returns:

The layer with the converted drawings.

Type:: object

v02Tov03DrawingsDetails(details) → {object}

Convert drawing details from v0.2 to v0.3:

v0.2: array [nslices][nframes] with all,
v0.3: simple array of objects referenced by draw ids.

Parameters:

Name	Type	Description
`details`	Array	An array of drawing details.

Source: src/io/state.js, line 440

Returns:

The converted drawings.

Type:: object

v03Tov04DrawingsDetails(details) → {object}

Convert drawing details from v0.3 to v0.4:

v0.3: properties at group root,
v0.4: properties in group meta object.

Parameters:

Name	Type	Description
`details`	Array	An array of drawing details.

Source: src/io/state.js, line 471

Returns:

The converted drawings.

Type:: object

v04Tov05Data(data) → {object}

Convert drawing from v0.4 to v0.5:

v0.4: position as object,
v0.5: position as array.

Parameters:

Name	Type	Description
`data`	object	An array of drawing.

Source: src/io/state.js, line 496

Returns:

The converted drawings.

Type:: object

v04Tov05Drawings(inputDrawings) → {object}

Convert drawing from v0.4 to v0.5:

v0.4: draw id as 'slice-0_frame-1',
v0.5: draw id as '#2-0_#3-1'.

Parameters:

Name	Type	Description
`inputDrawings`	object	An array of drawing.

Source: src/io/state.js, line 510

Returns:

The converted drawings.

Type:: object

validateAnchorPosition(stageSize, anchor) → {boolean}

Validate an anchor position.

Parameters:

Name	Type	Description
`stageSize`	Scalar2D	The stage size {x,y}.
`anchor`	Konva.Shape	The anchor to evaluate.

Source: src/tools/drawBounds.js, line 207

Returns:

True if the position was corrected.

Type:: boolean

validateWindowWidth(value) → {number}

Validate an input window width.

Parameters:

Name	Type	Description
`value`	number	The value to test.

Source: src/image/windowLevel.js, line 16

Returns:

A valid window width.

Type:: number

viewerSetup()

Setup simple dwv app.

Source: tests/pacs/viewer.js, line 20

ybrToRgb(y, cb, cr) → {RGB}

Convert YBR to RGB.

Ref:

Parameters:

Name	Type	Description
`y`	number	The Y component.
`cb`	number	The Cb component.
`cr`	number	The Cr component.

Source: src/utils/colour.js, line 75

Returns:

RGB equivalent as {r,g,b}.

Type:: RGB

Type Definitions

DataElements

Type:

Object.<string, DataElement>

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

DataElements

List of DICOM data elements indexed via a 8 character string formed from the group and element numbers.

Type:

Object.<string, DataElement>

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

DataElements

Type:

Object.<string, DataElement>

Source: src/image/imageFactory.js, line 28

DataElements

Type:

Object.<string, DataElement>

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

DataViewConfigs

List of ViewConfigs indexed by dataIds.

Type:

Object.<string, Array.<ViewConfig>>

Source: src/app/application.js, line 186

TypedArray

List of compatible typed arrays.

Type:

Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array

Source: src/image/image.js, line 122

alphaFn(value, index) → {number}

Parameters:

Name	Type	Description
`value`	Array.<number> \| number	The pixel value.
`index`	number	The values' index.

Source: src/app/viewController.js, line 915

Returns:

The opacity of the input value.

Type:: number

alphaFn(value, index) → {number}

Parameters:

Name	Type	Description
`value`	Array.<number> \| number	The pixel value.
`index`	number	The values' index.

Source: src/image/maskSegmentViewHelper.js, line 77

Returns:

The opacity of the input value.

Type:: number

alphaFn(value, index) → {number}

Parameters:

Name	Type	Description
`value`	Array.<number> \| number	The pixel value.
`index`	number	The values' index.

Source: src/image/view.js, line 273

Returns:

The opacity of the input value.

Type:: number

compareFn(a, b) → {number}

Parameters:

Name	Type	Description
`a`	object	The first object.
`b`	object	The first object.

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

Returns:

0 to sort a after b, <0 to sort a before b, 0 to not change order.

Type:: number

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/io/filesLoader.js, line 161

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/io/urlsLoader.js, line 171

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/tools/drawShapeEditor.js, line 77

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/tools/drawShapeHandler.js, line 84

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/utils/progress.js, line 136

testFn(node) → {boolean}

Parameters:

Name	Type	Description
`node`	Konva.Node	The node.

Source: src/tools/drawBounds.js, line 72

Returns:

True if the node passes the test.

Type:: boolean