Class: View

new View(image)

View class.

Parameters:

Name	Type	Description
`image`	Image	The associated image. Need to set the window lookup table once created (either directly or with helper methods).

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

Methods

addEventListener(type, callback)

Add an event listener to this class.

Parameters:

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

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

addWindowLut(wlut)

Add the window LUT to the list.

Parameters:

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

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

addWindowPresets(presets)

Add window presets to the existing ones.

Parameters:

Name	Type	Description
`presets`	object	The window presets.

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

canSetPosition(position) → {boolean}

Check is the provided position can be set.

Parameters:

Name	Type	Description
`position`	dwv.math.Point	The position.

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

Returns:

True is the position is in bounds.

Type:: boolean

clone() → {dwv.image.View}

Clone the image using all meta data and the original data buffer.

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

Returns:

A full copy of this {dwv.image.View}.

Type:: dwv.image.View

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 866

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 902

Returns:

False if not in bounds.

Type:: boolean

generateImageData(array, index)

Generate display image data to be given to a canvas.

Parameters:

Name	Type	Description
`array`	Array	The array to fill in.
`index`	dwv.math.Index	Optional index at which to generate, otherwise generates at current index.

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

getAlphaFunction() → {function}

Get the alpha function.

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

Returns:

The function.

Type:: function

getColourMap() → {object}

Get the colour map of the image.

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

Returns:

The colour map of the image.

Type:: object

getCurrentIndex() → {dwv.math.Index}

Get the current index.

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

Returns:

The current index.

Type:: dwv.math.Index

getCurrentPosition() → {dwv.math.Point}

Get the current position.

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

Returns:

The current position.

Type:: dwv.math.Point

getCurrentWindowLut(rsi) → {Window}

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

Parameters:

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

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

Fires:

dwv.image.View#event:wlchange

Returns:

The window LUT of the image.

Type:: Window

getImage() → {Image}

Get the associated image.

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

Returns:

The associated image.

Type:: Image

getOrientation() → {dwv.math.Matrix33}

Get the view orientation.

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

Returns:

The orientation matrix.

Type:: dwv.math.Matrix33

getOrigin(position) → {dwv.math.Point}

Get the origin at a given position.

Parameters:

Name	Type	Description
`position`	dwv.math.Point	The position.

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

Returns:

The origin.

Type:: dwv.math.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 171

Returns:

The milliseconds per frame.

Type:: number

getScrollIndex() → {number}

Get the scroll dimension index.

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

Returns:

The index.

Type:: number

getWindowLevelMinMax() → {object}

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 747

Returns:

A min/max window level.

Type:: object

getWindowPresets() → {object}

Get the window presets.

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

Returns:

The window presets.

Type:: object

getWindowPresetsNames() → {object}

Get the window presets names.

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

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 845

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 912

Returns:

False if not in bounds.

Type:: boolean

init()

Initialise the view: set initial index.

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

removeEventListener(type, callback)

Remove an event listener from this class.

Parameters:

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

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

setAlphaFunction(func)

Set alpha function.

Parameters:

Name	Type	Description
`func`	function	The function.

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

Fires:

dwv.image.View#event:alphafuncchange

setColourMap(map)

Set the colour map of the image.

Parameters:

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

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

Fires:

dwv.image.View#event:colourchange

setCurrentIndex(index, silent) → {boolean}

Set the current index.

Parameters:

Name	Type	Description
`index`	dwv.math.Index	The new index.
`silent`	boolean	Flag to fire event or not.

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

Fires:

dwv.image.View#event:positionchange

Returns:

False if not in bounds.

Type:: boolean

setCurrentPosition(position, silent) → {boolean}

Set the current position.

Parameters:

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

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

Fires:

dwv.image.View#event:positionchange

Returns:

False if not in bounds

Type:: boolean

setDefaultColourMap(map)

Set the default colour map.

Parameters:

Name	Type	Description
`map`	object	The colour map.

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

setImage(inImage)

Set the associated image.

Parameters:

Name	Type	Description
`inImage`	Image	The associated image.

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

setInitialIndex()

Set the initial index to 0.

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

setOrientation(mat33)

Set the view orientation.

Parameters:

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

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

setWindowLevel(center, width, name, silent)

Set the view window/level.

Parameters:

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

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

Fires:

dwv.image.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 765

setWindowLevelPreset(name, silent)

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

Parameters:

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

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

setWindowLevelPresetById(id, silent)

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

Parameters:

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

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

setWindowPresets(presets)

Set the window presets.

Parameters:

Name	Type	Description
`presets`	object	The window presets.

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

(inner) alphaFunction(_value, _index) → {number}

Per value alpha function.

Parameters:

Name	Type	Description
`_value`	*	The pixel value. Can be a number for monochrome data or an array for RGB data.
`_index`	number	The data index of the value.

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

Returns:

The coresponding alpha [0,255].

Type:: number

Events

alphafuncchange

Alpha func change event.

Type:

object

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

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 396

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 561

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 634

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 365