Global

Members

(constant) DRAW_DEBUG

Draw Debug flag.

Source: src/tools/draw.js, line 35

(constant) InteractionEventNames

List of interaction event names.

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

(constant) RequiredDicomSegTags

List of DICOM Seg required tags.

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

(constant) binderList

List of binders.

Source: src/gui/stage.js, line 124

(constant) customUI

Overridalbe custom UI object for client defined UI.

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

(constant) d65

CIE Standard Illuminant D65, standard 2° observer.

Source: src/utils/colour.js, line 142
See: https://en.wikipedia.org/wiki/Illuminant_D65

(constant) decoderScripts

Decoder scripts to be passed to web workers for image decoding.

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

(constant) defaultArrowLabelText

Default draw label text.

Source: src/tools/arrow.js, line 11

(constant) defaultCircleLabelText

Default draw label text.

Source: src/tools/circle.js, line 13

(constant) defaultEllipseLabelText

Default draw label text.

Source: src/tools/ellipse.js, line 13

(constant) defaultFreeHandLabelText

Default draw label text.

Source: src/tools/freeHand.js, line 8

(constant) defaultPresets :Object.<string, Object.<string, {center: number, width: number}>>

List of default window level presets.

Type:

Object.<string, Object.<string, {center: number, width: number}>>

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

(constant) defaultProtractorLabelText

Default draw label text.

Source: src/tools/protractor.js, line 12

(constant) defaultRectangleLabelText

Default draw label text.

Source: src/tools/rectangle.js, line 13

(constant) defaultRoiLabelText

Default draw label text.

Source: src/tools/roi.js, line 9

(constant) defaultRulerLabelText

Default draw label text.

Source: src/tools/ruler.js, line 11

(constant) dictionary

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

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

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

(constant) i18n

Namespace for translation function. (in a namespace to allow for override from client)

Source: src/utils/i18n.js, line 5

(constant) lut_range_max

Lookup tables for image colour display.

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

(constant) luts :Object.<string, ColourMap>

List of available lookup tables (lut).

Type:

Object.<string, ColourMap>

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

(constant) minWindowWidth

Minimum window width value.

Source: src/image/windowCenterAndWidth.js, line 6
See: http://dicom.nema.org/dicom/2013/output/chtml/part03/sect_C.11.html#sect_C.11.2.1.2

(constant) viewEventNames :Array

List of view event names.

Type:

Array

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

Methods

addDataRow(id)

Add a data row.

Parameters:

Name	Type	Description
`id`	number	The data index.

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

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 362

addTagsToDictionary(group, tags)

Add tags to the dictionary.

Parameters:

Name	Type	Description
`group`	string	The group key.
`tags`	object	The tags to add.

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

arrayEquals(arr0, arr1) → {boolean}

Check for array equality.

Parameters:

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

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

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`	*	Second array.

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

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

bindAppToControls()

Bind app to controls.

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

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

Bound a node position.

Parameters:

Name	Type	Description
`node`	object	The node to bound the position.
`min`	object	The minimum position as {x,y}.
`max`	object	The maximum position as {x,y}.

Source: src/tools/draw.js, line 1054

Returns:

True if the position was corrected.

Type:: boolean

buildLut(func) → {Array}

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

buildMultipart(parts, boundary) → {Uint8Array}

Build a multipart message. See: https://en.wikipedia.org/wiki/MIME#Multipart_messages See: https://hg.orthanc-server.com/orthanc-dicomweb/file/tip/Resources/Samples/JavaScript/stow-rs.js

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 217

Returns:

The full multipart message.

Type:: Uint8Array

canCreateCanvas(width, height) → {boolean}

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

Parameters:

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

Source: src/gui/generic.js, line 136
See: https://github.com/ivmartel/dwv/issues/902
https://github.com/jhildenbiddle/canvas-size/blob/v1.2.4/src/canvas-test.js

Returns:

True is the canvas can be created.

Type:: boolean

canNodeChangeColour(node) → {boolean}

Is the input node a node that has the 'stroke' method.

Parameters:

Name	Type	Description
`node`	object	A Konva node.

Source: src/app/drawController.js, line 88

Returns:

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

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 7

Returns:

The new string.

Type:: string

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 188

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 40

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 113

Returns:

True isf selected.

Type:: boolean

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 68

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

checkUnknownVR(element)

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

Parameters:

Name	Type	Description
`element`	DataElement	The DICOM element.

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

cielabToCiexyz(triplet) → {object}

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

Parameters:

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

Source: src/utils/colour.js, line 155
See: https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIELAB_to_CIEXYZ

Returns:

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

Type:: object

cielabToSrgb(triplet) → {object}

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 301

Returns:

sRGB triplet as {r,g,b}.

Type:: object

ciexyzToCielab(triplet) → {object}

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

Parameters:

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

Source: src/utils/colour.js, line 192
See: https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIEXYZ_to_CIELAB

Returns:

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

Type:: object

ciexyzToSrgb(triplet) → {object}

Convert CIE XYZ to sRGB.

Parameters:

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

Source: src/utils/colour.js, line 230
See: https://en.wikipedia.org/wiki/SRGB#From_CIE_XYZ_to_sRGB

Returns:

sRGB triplet as {r,g,b}.

Type:: object

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 66

Returns:

The cleaned string.

Type:: string

clearDataTable()

Clear the data table.

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

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 321

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.

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 636
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

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 193

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 27

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 901

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 170

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 194

Returns:

The gradient.

Type:: Array

computeGradient(greyscale) → {object}

Parameters:

Name	Type	Description
`greyscale`	object	The input greyscale-

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

Returns:

A gradient object

Type:: object

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

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 12

Returns:

A greyscale object

Type:: object

computeLaplace(greyscale) → {object}

Parameters:

Name	Type	Description
`greyscale`	object	The input greyscale.

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

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 280

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 186

createImage(elements) → {Image}

Create an Image from DICOM elements.

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements.

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

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	The DICOM elements.

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

Returns:

The mask Image object.

Type:: Image

createView(elements, image) → {View}

Create a View from DICOM elements and image.

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements.
`image`	Image	The associated image.

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

Returns:

The View object.

Type:: View

decodeKeyValueUri(uri, replaceMode) → {Array}

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

Parameters:

Name Type Description

Name	Type	Description
`uri`	string	The URI to decode.
`replaceMode`	string	The key replace mode. replaceMode 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.

uri

string

The URI to decode.

replaceMode

string

The key replace mode. replaceMode 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 100

Returns:

The list of input file urls.

Type:: Array

decodeManifest(manifest, nslices) → {Array}

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 219

Returns:

The decoded manifest.

Type:: Array

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 76

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 40

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 34

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

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 64

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 229

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 325

generate()

Generate DICOM data

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

generateGradSquare(tags) → {object}

Simple GradSquarePixGenerator

Parameters:

Name	Type	Description
`tags`	object	The input tags.

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

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

getAnchorMin(group) → {object|undefined}

Get the minimum position in a groups' anchors.

Parameters:

Name	Type	Description
`group`	object	The group that contains anchors.

Source: src/tools/draw.js, line 1031

Returns:

The minimum position as {x,y}.

Type:: object | 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 184

Returns:

The angle.

Type:: number

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 1163

Returns:

The bytes per element.

Type:: number

getBrightness(rgbTriplet) → {number}

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

Parameters:

Name	Type	Description
`rgbTriplet`	object	RGB triplet.

Source: src/utils/colour.js, line 72
See: https://en.wikipedia.org/wiki/YIQ#From_RGB_to_YIQ

Returns:

The brightness ([0,1]).

Type:: number

getCode(dataElements) → {object}

Get a code object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The dicom element.

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

Returns:

A code object.

Type:: object

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 53

Returns:

The position compare function.

Type:: compareFn

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 65

Returns:

The html list element.

Type:: object

getControlDiv(id, name, min, max, value, callback, precision) → {object}

Get a control div: label, range and number field.

Parameters:

Name	Type	Description
`id`	string	The control id.
`name`	string	The control name.
`min`	number	The control minimum value.
`max`	number	The control maximum value.
`value`	number	The control value.
`callback`	function	The callback on control value change.
`precision`	number	Optional number field float precision.

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

Returns:

The control div.

Type:: object

getCoronalMat33() → {Matrix33}

Create a 3x3 coronal (xzy) matrix.

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

Returns:

The coronal matrix.

Type:: Matrix33

getData() → {Array}

Get the selected data.

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

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 1150

Returns:

The DICOM element.

Type:: DataElement

getDataElementPrefixByteSize(vr, isImplicit) → {number}

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

Parameters:

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

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

Returns:

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

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

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

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

Type:: number

getDataLayerGroupIds(dataViewConfig) → {Array}

Get the layer group ids associated to a data.

Parameters:

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

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

Returns:

The list of ids.

Type:: Array

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`	object	The DICOM element with date information.

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

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`	object	The DICOM element with date-time information.

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

Returns:

The time object.

Type:: Object | undefined

getDeOrientedArray3D(array3D, orientation) → {Array}

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

Parameters:

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

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

Returns:

The values reordered to compensate the orientation.

Type:: Array

getDefaultAnchor(x, y, id, style) → {object}

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`	object	The application style.

Source: src/tools/editor.js, line 22

Returns:

The default anchor shape.

Type:: object

getDefaultDicomSegJson() → {object}

Get the default DICOM seg tags as an object.

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

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

getDimensionOrganization(dataElements) → {object}

Check the dimension organization from a dicom element.

Parameters:

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

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

Returns:

The dimension organizations and indices.

Type:: object

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 35

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 149

Returns:

The full dwv url.

Type:: string

getDwvVersion() → {string}

Get the version of the library.

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

Returns:

The version of the library.

Type:: string

getElement(containerDivId, name) → {object}

Get a HTML element associated to a container div.

Parameters:

Name	Type	Description
`containerDivId`	string	The id of the container div.
`name`	string	The name or id to find.

Deprecated: Yes
Source: src/gui/generic.js, line 26

Returns:

The found element or null.

Type:: object

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

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

Parameters:

Name	Type	Description
`jsonTags`	Object.<string, any>	The DICOM json tags object.

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

Returns:

The DICOM elements.

Type:: Object.<string, DataElement>

getEllipseIndices(center, radius, dir) → {Array}

Get the indices that form a ellpise.

Parameters:

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

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

Returns:

The indices of the ellipse.

Type:: Array

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 236

Returns:

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

Type:: function

getEventOffset(event) → {Array}

Get the offset of an input event.

Parameters:

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

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

Returns:

The array of offsets.

Type:: Array

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 94

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 173

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 693

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 224

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 92

Returns:

The find callback function.

Type:: function

getFlags(inputStr) → {Array}

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 87

Returns:

An array of found flags.

Type:: Array

getFullStats(array) → {object}

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

Parameters:

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

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

Returns:

A full stats object.

Type:: object

getHierarchyLog(layer, prefix) → {string}

Debug function to output the layer hierarchy as text.

Parameters:

Name	Type	Description
`layer`	object	The Konva layer.
`prefix`	string	A display prefix (used in recursion).

Source: src/app/drawController.js, line 99

Returns:

A text representation of the hierarchy.

Type:: string

getIdentityMat33() → {Matrix33}

Create a 3x3 identity matrix.

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

Returns:

The identity matrix.

Type:: Matrix33

getImage2DSize(elements) → {object}

Extract the 2D size from dicom elements.

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements.

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

Returns:

The size.

Type:: object

getIndexCompareFunction(direction) → {function}

Get an array sort callback. f(a,b) > 0 -> b,a f(a,b) < 0 -> a,b f(a,b) = 0 -> original order

Parameters:

Name	Type	Description
`direction`	number	The direction to use to compare indices.

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

Returns:

A function that compares two Index.

Type:: function

getIndexFromStringId(inputStr) → {Index}

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

Parameters:

Name	Type	Description
`inputStr`	string	The input string.

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

Returns:

The corresponding index.

Type:: Index

getItemDelimitationItemTag() → {Tag}

Get the ItemDelimitationItem Tag.

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

Returns:

The tag.

Type:: Tag

getItemTag() → {Tag}

Get the Item Tag.

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

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 358

Returns:

The list of values.

Type:: Array

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 53

Returns:

The layer details as {groupDivId, 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 34

Returns:

The layer details as {groupDivId, layerId}.

Type:: object

getLayerDivId(groupDivId, layerId) → {string}

Get the layer div id.

Parameters:

Name	Type	Description
`groupDivId`	string	The layer group div id.
`layerId`	number	The lyaer id.

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

Returns:

A string id.

Type:: string

getLayerGroupDivIds(dataViewConfigs) → {Array}

Get the layer groups div ids from the data view configs.

Parameters:

Name	Type	Description
`dataViewConfigs`	object	The configs.

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

Returns:

The list of ids.

Type:: Array

getMatrixFromName(name) → {Matrix33}

Get an orientation matrix from a name.

Parameters:

Name	Type	Description
`name`	string	The orientation name.

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

Returns:

The orientation matrix.

Type:: Matrix33

getMatrixInverse(m) → {Matrix33|undefined}

Get the inverse of an input 3*3 matrix.

Parameters:

Name	Type	Description
`m`	Matrix33	The input matrix.

Source: src/math/matrix.js, line 299
See: https://en.wikipedia.org/wiki/Invertible_matrix#Inversion_of_3_%C3%97_3_matrices
https://github.com/willnode/N-Matrix-Programmer

Returns:

The inverse matrix or undefined if the determinant is zero.

Type:: Matrix33 | undefined

getMetaDataWithNames(metaData) → {object}

Get the meta data with names instead of tag keys.

Parameters:

Name	Type	Description
`metaData`	object	The initial meta data.

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

Returns:

The list of meta data.

Type:: object

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 27

Returns:

The object URL.

Type:: string

getOnInstanceLoad(i) → {function}

Get an instance load handler.

Parameters:

Name	Type	Description
`i`	number	The id of the load.

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

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 66

Returns:

The error handler.

Type:: function

getOrientationName(orientation) → {string}

Get the name of an image orientation patient.

Parameters:

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

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

Returns:

The orientation name: axial, coronal or sagittal.

Type:: string

getOrientedArray3D(array3D, orientation) → {Array}

Get the oriented values of an input 3D array.

Parameters:

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

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

Returns:

The values reordered according to the orientation.

Type:: Array

getPercentile(array, 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
`array`	Array	The sorted array of values.
`ratio`	number	The percentile ratio [0-1].

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

Returns:

The percentile,

Type:: number

getPerpendicularLine(line, point, length) → {object}

Get a perpendicular line to an input one.

Parameters:

Name	Type	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.

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

Returns:

A perpendicular line.

Type:: object

getPixelDataTag() → {Tag}

Get the PixelData Tag.

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

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) → {object}

Get the pixel spacing from the different spacing tags.

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements.

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

Returns:

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

Type:: object

getPixelUnit(elements) → {string|null}

Get the pixel data unit.

Parameters:

Name	Type	Description
`elements`	object	The DICOM elements.

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

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 930

Returns:

The rounding function.

Type:: function

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 504

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 158

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 161

Returns:

The input path without its last part.

Type:: string

getSagittalMat33() → {Matrix33}

Create a 3x3 sagittal (yzx) matrix.

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

Returns:

The sagittal matrix.

Type:: Matrix33

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

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`	object	The previous offset as {x,y}.
`scale`	object	The previous scale as {x,y}.
`newScale`	object	The new scale as {x,y}.
`center`	object	The scale center as {x,y}.

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

Returns:

The scaled offset as {x,y}.

Type:: object

getSegment(dataElements) → {object}

Get a segment object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The dicom element.

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

Returns:

A segment object.

Type:: object

getSegmentFrameInfo(dataElements) → {object}

Get a frame information object from a dicom element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The dicom element.

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

Returns:

A frame information object.

Type:: object

getSelectedTool() → {string}

Get the selected tool

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

Returns:

The tool name.

Type:: string

getSequenceDelimitationItemTag() → {Tag}

Get the SequenceDelimitationItem Tag.

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

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 97

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`	object	The Konva shape.

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

Returns:

The display name.

Type:: string

getSimilarPoint3DFunction(point, tol) → {function}

Get an array find callback for a similar input point.

Parameters:

Name	Type	Description
`point`	Point3D	The point to compare to.
`tol`	number	The comparison tolerance default to Number.EPSILON.

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

Returns:

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

Type:: function

getSimpleStats(array) → {object}

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

Parameters:

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

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

Returns:

A simple stats object.

Type:: object

getSliceGeometrySpacing(origins, orientation, withCheckopt) → {number|undefined}

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

Parameters:

Name	Type	Attributes	Description
`origins`	Array		An array of Point3D.
`orientation`	Matrix33		The oritentation matrix.
`withCheck`	boolean	<optional>	Flag to activate spacing variation check, default to true.

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

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 24

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 377

Returns:

The slice iterator.

Type:: object

getSpacingFromMeasure(dataElements) → {Spacing}

Get a spacing object from a dicom measure element.

Parameters:

Name	Type	Description
`dataElements`	DataElements	The dicom element.

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

Returns:

A spacing object.

Type:: Spacing

getStats(array, flags) → {object}

Get the minimum, maximum, mean and standard deviation of an array of values. Note: could use https://github.com/tmcw/simple-statistics.

Parameters:

Name	Type	Description
`array`	Array	The array of values to extract stats from.
`flags`	Array	A list of stat values to calculate.

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

Returns:

A stats object.

Type:: object

getSyntaxDecompressionName(syntax) → {string}

Tell if a given syntax needs decompression.

Parameters:

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

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

Returns:

The name of the decompression algorithm.

Type:: string

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 324

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 200

Returns:

The DICOM tag.

Type:: Tag

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/gui/layerGroup.js, line 94

Returns:

The target orientation.

Type:: Matrix33

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`	object	The DICOM element with date information.

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

Returns:

The time object.

Type:: Object | undefined

getTouchesPositions(touches) → {Array}

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 68

Returns:

The list of positions of the touch events.

Type:: Array

getTransferSyntaxName(syntax) → {string}

Get the transfer syntax name. Reference: UID Values.

Parameters:

Name	Type	Description
`syntax`	string	The transfer syntax.

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

Returns:

The name of the transfer syntax.

Type:: string

getTransferSyntaxUIDTag() → {Tag}

Get the TransferSyntaxUID Tag.

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

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 463

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?

Parameters:

Name	Type	Description
`tagName`	string	The input tag.

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

Returns:

The corresponding UID.

Type:: string

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 54

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 89

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	An array of regions.

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

Returns:

The slice iterator.

Type:: object | undefined

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/gui/layerGroup.js, line 71

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 162

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 203

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 246

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 223

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 401

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 132

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 45

Returns:

True if the buffer includes the prefix.

Type:: boolean

hexToRgb(hexStr) → {object}

Convert a hex color into RGB.

Parameters:

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

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

Returns:

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

Type:: object

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	A list of stat values to calculate.

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

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 5353

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 221

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 5376

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 87

Returns:

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

Type:: boolean

isEqualRgb(c1, c2) → {boolean}

Check if two rgb objects are equal.

Parameters:

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

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

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`	object	The first segment.
`seg2`	object	The second segment.

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

Returns:

True if both segment 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 116

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 234

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 357

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 211

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 273

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 253

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 276

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 231

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 255

Returns:

True if a jpeg lossless syntax.

Type:: boolean

isJpegRetiredTransferSyntax(syntax) → {boolean}

Tell if a given syntax is a retired JPEG one.

Parameters:

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

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

Returns:

True if a retired jpeg syntax.

Type:: boolean

isJpeglsTransferSyntax(syntax) → {boolean}

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

Parameters:

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

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

Returns:

True if a jpeg-ls syntax.

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`	object	A Konva node.

Source: src/app/drawController.js, line 50

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`	object	A Konva node.

Source: src/app/drawController.js, line 30

Returns:

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

Type:: boolean

isNodeNameShapeExtra(node) → {boolean}

Is a node an extra shape associated with a main one.

Parameters:

Name	Type	Description
`node`	object	A Konva node.

Source: src/app/drawController.js, line 40

Returns:

True if the node's name starts with '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/app/drawController.js, line 76

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 313

Returns:

True if the asked tag.

Type:: boolean

isPositionNode(node) → {boolean}

Is an input node a position node.

Parameters:

Name	Type	Description
`node`	object	A Konva node.

Source: src/app/drawController.js, line 60

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 316

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 286

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 293

Returns:

True if the asked tag.

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`	object	The first segment.
`seg2`	object	The second segment.

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

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 139

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 127

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 98

Returns:

True if the input JSON is valid.

Type:: boolean

isValidTags() → {boolean}

Is the JSON valid?

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

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/dicom/2013/output/chtml/part05/sect_6.2.html

Parameters:

Name	Type	Description
`vr`	string	The element VR.

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

Returns:

True if the VR needs padding.

Type:: boolean

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 {x,y,z} with CIE LAB range.

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

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 111

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 79

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 161

launchStow()

Launch a STOW request.

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

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 941

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 36

Returns:

The merged object.

Type:: object

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 14

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 193

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 297

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 122

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 137

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 223

onMainQidoLoad(json)

Handle the data loaded by the main QIDO query.

Parameters:

Name	Type	Description
`json`	Array	JSON array data.

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

onOpacityChange(event)

Handle app opacity change.

Parameters:

Name	Type	Description
`event`	object	The change event.

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

onSaveTags()

Save the tags as a JSON file.

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

onWLChange(event)

Handle app wl change.

Parameters:

Name	Type	Description
`event`	object	The change event.

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

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 194

Returns:

The padded input.

Type:: Array | Uint8Array

parseMultipart(arr) → {Array}

Extract each element of a multipart ArrayBuffer. https://en.wikipedia.org/wiki/MIME#Multipart_messages

Parameters:

Name	Type	Description
`arr`	ArrayBuffer	The multipart array.

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

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 216

Returns:

The rounded number.

Type:: number

prepareAndGetMPRDataViewConfig() → {object}

Create MPR view config(s).

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

Returns:

The view config.

Type:: object

prepareAndGetSimpleDataViewConfig() → {object}

Create simple view config(s).

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

Returns:

The view config.

Type:: object

qidoResponseToTable(json)

Show the QIDO response as a table.

Parameters:

Name	Type	Description
`json`	Array	The qido response as json object.

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

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 65

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 290

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).

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 135
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

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).

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	An array of regions: [off0, size, off1].

Source: src/image/iterator.js, line 175
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

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.

Parameters:

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

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

Returns:

The result string.

Type:: string

rgbToHex(rgb) → {string}

Convert RGB to its hex equivalent.

Parameters:

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

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

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 170

Returns:

The result array.

Type:: Array

saveRules()

Save the rules as a JSON file.

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

setupBindersCheckboxes()

Setup the binders checkboxes

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

setupData()

Setup the data.

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

setupParsers()

Setup the parsers.

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

setupToolsCheckboxes()

Setup the tools checkboxes

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

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 24

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

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

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 21
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

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.

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 225
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

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 913

Returns:

The sorted object.

Type:: object

splitKeyValueString(inputStr) → {object}

Split key/value string: key0=val00&key0=val01&key1=val10 returns { key0 : [val00, val01], key1 : val1 }

Parameters:

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

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

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 26

Returns:

The split string.

Type:: object

srgbToCielab(triplet) → {object}

Convert sRGB to CIE LAB (standard illuminant D65).

Parameters:

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

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

Returns:

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

Type:: object

srgbToCiexyz(triplet) → {object}

Convert sRGB to CIE XYZ.

Parameters:

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

Source: src/utils/colour.js, line 267
See: https://en.wikipedia.org/wiki/SRGB#From_sRGB_to_CIE_XYZ

Returns:

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

Type:: object

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 24

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 197

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 184

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

testWriteReadDataFromConfig(config, assert)

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

Parameters:

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

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

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

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 181

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 50

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 108

Returns:

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

Type:: object

unbindAppToControls()

Unbind app to controls.

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

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 103

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 306

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 234

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 453

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 484

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 509

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 523

Returns:

The converted drawings.

Type:: object

validateAnchorPosition(stageSize, anchor) → {boolean}

Validate an anchor position.

Parameters:

Name	Type	Description
`stageSize`	object	The stage size {x,y}.
`anchor`	object	The anchor to evaluate.

Source: src/tools/draw.js, line 1111

Returns:

True if the position was corrected.

Type:: boolean

validateGroupPosition(stageSize, group) → {boolean}

Validate a group position.

Parameters:

Name	Type	Description
`stageSize`	object	The stage size {x,y}.
`group`	object	The group to evaluate.

Source: src/tools/draw.js, line 1080

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/windowCenterAndWidth.js, line 29

Returns:

A valid window width.

Type:: number

viewerSetup()

Setup simple dwv app.

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

ybrToRgb(y, cb, cr) → {object}

Convert YBR to RGB.

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 31
See: http://dicom.nema.org/dicom/2013/output/chtml/part03/sect_C.7.html#sect_C.7.6.3.1.2
https://en.wikipedia.org/wiki/YCbCr#JPEG_conversion

Returns:

RGB equivalent as {r,g,b}.

Type:: object

Type Definitions

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 21

DataElements

Type:

Object.<string, DataElement>

Source: src/image/imageFactory.js, line 27

DataElements

Type:

Object.<string, DataElement>

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

DataViewConfigs

List of ViewConfigs indexed by dataIds.

Type:

Object.<string, Array.<ViewConfig>>

Source: src/app/application.js, line 137

TypedArray

List of compatible typed arrays.

Type:

Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array

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

alphaFn(value, index) → {number}

Parameters:

Name	Type	Description
`value`	object	The pixel value.
`index`	object	The values' index.

Source: src/app/viewController.js, line 738

Returns:

The value to display.

Type:: number

alphaFn(value, index) → {number}

Parameters:

Name	Type	Description
`value`	object	The pixel value.
`index`	object	The values' index.

Source: src/image/maskSegmentHelper.js, line 170

Returns:

The value to display.

Type:: number

alphaFn(value, index) → {number}

Parameters:

Name	Type	Description
`value`	object	The pixel value.
`index`	object	The values' index.

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

Returns:

The value to display.

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 38

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/image/maskSegmentHelper.js, line 206

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/io/filesLoader.js, line 162

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/io/urlsLoader.js, line 172

eventFn(event)

Parameters:

Name	Type	Description
`event`	object	The event.

Source: src/tools/editor.js, line 100

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`	object	The node.

Source: src/app/drawController.js, line 64

Returns:

True if the node passes the test.

Type:: boolean