Class: View

Constructor

new View(image)

Parameters:

Name	Type	Description
`image`	Image	The associated image.

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

Example

// XMLHttpRequest onload callback
const onload = function (event) {
  // parse the dicom buffer
  const dicomParser = new dwv.DicomParser();
  dicomParser.parse(event.target.response);
  // create the image object
  const image = dwv.createImage(dicomParser.getDicomElements());
  // create the view
  const view = dwv.createView(dicomParser.getDicomElements(), image);
  // setup canvas
  const canvas = document.createElement('canvas');
  canvas.width = 256;
  canvas.height = 256;
  const ctx = canvas.getContext("2d");
  // update the image data
  const imageData = ctx.createImageData(256, 256);
  view.generateImageData(imageData);
  ctx.putImageData(imageData, 0, 0);
  // update html
  const div = document.getElementById('dwv');
  div.appendChild(canvas);;
};
// DICOM file request
const request = new XMLHttpRequest();
const url = 'https://raw.githubusercontent.com/ivmartel/dwv/master/tests/data/bbmri-53323851.dcm';
request.open('GET', url);
request.responseType = 'arraybuffer';
request.onload = onload;
request.send();

Classes

View

Methods

addEventListener(type, callback)

Add an event listener to this class.

Parameters:

Name	Type	Description
`type`	string	The event type.
`callback`	function	The function associated with the provided event type, will be called with the fired event.

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

addWindowLut(wlut)

Add the window LUT to the list.

Parameters:

Name	Type	Description
`wlut`	WindowLut	The window LUT of the image.

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

addWindowPresets(presets)

Add window presets to the existing ones.

Parameters:

Name	Type	Description
`presets`	object	The window presets.

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

canSetPosition(position) → {boolean}

Check is the provided position can be set.

Parameters:

Name	Type	Description
`position`	Point	The position.

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

Returns:

True is the position is in bounds.

Type:: boolean

decrementIndex(dim, silent) → {boolean}

Decrement the provided dimension.

Parameters:

Name	Type	Description
`dim`	number	The dimension to increment.
`silent`	boolean	Do not send event.

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

Returns:

False if not in bounds.

Type:: boolean

decrementScrollIndex(silent) → {boolean}

Decrement the scroll dimension index.

Parameters:

Name	Type	Description
`silent`	boolean	Do not send event.

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

Returns:

False if not in bounds.

Type:: boolean

generateImageData(data, index)

Generate display image data to be given to a canvas.

Parameters:

Name	Type	Description
`data`	ImageData	The iamge data to fill in.
`index`	Index	Optional index at which to generate, otherwise generates at current index.

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

getAlphaFunction() → {alphaFn}

Get the alpha function.

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

Returns:

The function.

Type:: alphaFn

getColourMap() → {ColourMap}

Get the colour map of the image.

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

Returns:

The colour map of the image.

Type:: ColourMap

getCurrentIndex() → {Index}

Get the current index.

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

Returns:

The current index.

Type:: Index

getCurrentPosition() → {Point}

Get the current position.

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

Returns:

The current position.

Type:: Point

getCurrentWindowLut(rsiopt) → {WindowLut}

Get the window LUT of the image. Warning: can be undefined in no window/level was set.

Parameters:

Name	Type	Attributes	Description
`rsi`	object	<optional>	Optional image rsi, will take the one of the current slice otherwise.

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

Fires:

View#event:wlchange

Returns:

The window LUT of the image.

Type:: WindowLut

getImage() → {Image}

Get the associated image.

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

Returns:

The associated image.

Type:: Image

getOrientation() → {Matrix33}

Get the view orientation.

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

Returns:

The orientation matrix.

Type:: Matrix33

getOrigin(position) → {Point}

Get the origin at a given position.

Parameters:

Name	Type	Description
`position`	Point	The position.

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

Returns:

The origin.

Type:: Point

getPlaybackMilliseconds(recommendedDisplayFrameRate) → {number}

Get the milliseconds per frame from frame rate.

Parameters:

Name	Type	Description
`recommendedDisplayFrameRate`	number	Recommended Display Frame Rate.

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

Returns:

The milliseconds per frame.

Type:: number

getScrollIndex() → {number}

Get the scroll dimension index.

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

Returns:

The index.

Type:: number

getWindowLevelMinMax() → {WindowCenterAndWidth}

Get the image window/level that covers the full data range. Warning: uses the latest set rescale LUT or the default linear one.

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

Returns:

A min/max window level.

Type:: WindowCenterAndWidth

getWindowPresets() → {object}

Get the window presets.

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

Returns:

The window presets.

Type:: object

getWindowPresetsNames() → {object}

Get the window presets names.

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

Returns:

The list of window presets names.

Type:: object

incrementIndex(dim, silent) → {boolean}

Increment the provided dimension.

Parameters:

Name	Type	Description
`dim`	number	The dimension to increment.
`silent`	boolean	Do not send event.

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

Returns:

False if not in bounds.

Type:: boolean

incrementScrollIndex(silent) → {boolean}

Increment the scroll dimension index.

Parameters:

Name	Type	Description
`silent`	boolean	Do not send event.

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

Returns:

False if not in bounds.

Type:: boolean

init()

Initialise the view: set initial index.

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

removeEventListener(type, callback)

Remove an event listener from this class.

Parameters:

Name	Type	Description
`type`	string	The event type.
`callback`	function	The function associated with the provided event type.

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

setAlphaFunction(func)

Set alpha function.

Parameters:

Name	Type	Description
`func`	alphaFn	The function.

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

Fires:

View#event:alphafuncchange

setColourMap(map)

Set the colour map of the image.

Parameters:

Name	Type	Description
`map`	ColourMap	The colour map of the image.

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

Fires:

View#event:colourchange

setCurrentIndex(index, silentopt) → {boolean}

Set the current index.

Parameters:

Name	Type	Attributes	Description
`index`	Index		The new index.
`silent`	boolean	<optional>	Flag to fire event or not.

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

Fires:

View#event:positionchange

Returns:

False if not in bounds.

Type:: boolean

setCurrentPosition(position, silent) → {boolean}

Set the current position.

Parameters:

Name	Type	Description
`position`	Point	The new position.
`silent`	boolean	Flag to fire event or not.

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

Fires:

View#event:positionchange

Returns:

False if not in bounds

Type:: boolean

setDefaultColourMap(map)

Set the default colour map.

Parameters:

Name	Type	Description
`map`	ColourMap	The colour map.

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

setImage(inImage)

Set the associated image.

Parameters:

Name	Type	Description
`inImage`	Image	The associated image.

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

setInitialIndex()

Set the initial index to 0.

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

setOrientation(mat33)

Set the view orientation.

Parameters:

Name	Type	Description
`mat33`	Matrix33	The orientation matrix.

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

setWindowLevel(center, width, nameopt, silentopt)

Set the view window/level.

Parameters:

Name	Type	Attributes	Description
`center`	number		The window center.
`width`	number		The window width.
`name`	string	<optional>	Associated preset name, defaults to 'manual'. Warning: uses the latest set rescale LUT or the default linear one.
`silent`	boolean	<optional>	Flag to launch events with skipGenerate.

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

Fires:

View#event:wlchange

setWindowLevelMinMax()

Set the image window/level to cover the full data range. Warning: uses the latest set rescale LUT or the default linear one.

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

setWindowLevelPreset(name, silentopt)

Set the window level to the preset with the input name.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the preset to activate.
`silent`	boolean	<optional>	Flag to launch events with skipGenerate.

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

setWindowLevelPresetById(id, silentopt)

Set the window level to the preset with the input id.

Parameters:

Name	Type	Attributes	Description
`id`	number		The id of the preset to activate.
`silent`	boolean	<optional>	Flag to launch events with skipGenerate.

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

setWindowPresets(presets)

Set the window presets.

Parameters:

Name	Type	Description
`presets`	object	The window presets.

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

Events

alphafuncchange

Alpha func change event.

Type:

object

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

colourchange

Color change event.

Type:

object

Properties

Name	Type	Description
`value`	Array	The changed value.
`wc`	number	The new window center value.
`ww`	number	The new window wdth value.

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

positionchange

Position change event.

Type:

object

Properties

Name	Type	Description
`value`	Array	The changed value as [index, pixelValue].
`diffDims`	Array	An array of modified indices.

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

wlchange

Window/level change event.

Type:

object

Properties

Name	Type	Description
`value`	Array	The changed value.
`wc`	number	The new window center value.
`ww`	number	The new window wdth value.
`skipGenerate`	boolean	Flag to skip view generation.

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

wlpresetadd

Window/level add preset event.

Type:

object

Properties

Name	Type	Description
`name`	string	The name of the preset.

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