Class: ViewController

new ViewController(view, index)

View controller.

Parameters:

Name	Type	Description
`view`	dwv.image.View	The associated view.
`index`	number	The associated data index.

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

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/app/viewController.js, line 705

addWindowLevelPresets(presets) → {object}

Add window/level presets to the view.

Parameters:

Name	Type	Description
`presets`	object	A preset object.

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

Returns:

The list of presets.

Type:: object

applyHiddenSegments()

Apply the hidden segments list by setting the corresponding alpha function.

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

canQuantifyImage() → {boolean}

Can the image values be quantified?

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

Returns:

True if possible.

Type:: boolean

canScroll() → {boolean}

Can the data be scrolled?

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

Returns:

True if the data has either the third dimension or above greater than one.

Type:: boolean

canSetPosition(position) → {boolean}

Check is the provided position can be set.

Parameters:

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

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

Returns:

True is the position is in bounds.

Type:: boolean

canWindowLevel() → {boolean}

Can window and level be applied to the data?

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

Returns:

True if possible.

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/app/viewController.js, line 557

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/app/viewController.js, line 567

Returns:

False if not in bounds.

Type:: boolean

deleteSegment(segmentNumber, exeCallback)

Delete a segment.

Parameters:

Name	Type	Description
`segmentNumber`	number	The segment number.
`exeCallback`	function	The post execution callback.

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

equalImageMeta(meta) → {boolean}

Compare the input meta data to the associated image one.

Parameters:

Name	Type	Description
`meta`	object	The meta data.

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

Returns:

True if the associated image has equal meta data.

Type:: boolean

generateImageData(array, position)

Generate display image data to be given to a canvas.

Parameters:

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

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

get2DSpacing() → {Array}

Get the current spacing.

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

Returns:

The 2D spacing.

Type:: Array

getColourMap() → {object}

Get the colour map.

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

Returns:

The colour map.

Type:: object

getCurrentIndex() → {dwv.math.Index}

Get the current index.

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

Returns:

The current index.

Type:: dwv.math.Index

getCurrentOrientedIndex() → {dwv.math.Index}

Get the current oriented index.

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

Returns:

The index.

Type:: dwv.math.Index

getCurrentPosition() → {dwv.math.Point}

Get the current position.

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

Returns:

The position.

Type:: dwv.math.Point

getCurrentScrollIndexValue() → {object}

Get the current scroll index value.

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

Returns:

The value.

Type:: object

getCurrentScrollPosition() → {object}

Get the current scroll position value.

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

Returns:

The value.

Type:: object

getImageRegionValues(min, max) → {Array}

Get some values from the associated image in a region.

Parameters:

Name	Type	Description
`min`	dwv.math.Point2D	Minimum point.
`max`	dwv.math.Point2D	Maximum point.

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

Returns:

A list of values.

Type:: Array

getImageRescaledDataRange() → {object}

Get the image rescaled data range.

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

Returns:

The range as {min, max}.

Type:: object

getImageSize() → {dwv.image.Size}

Get the image size.

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

Returns:

The size.

Type:: dwv.image.Size

getImageVariableRegionValues(regions) → {Array}

Get some values from the associated image in variable regions.

Parameters:

Name	Type	Description
`regions`	Array	A list of regions.

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

Returns:

A list of values.

Type:: Array

getImageWorldSize() → {object}

Get the image world (mm) 2D size.

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

Returns:

The 2D size as {x,y}.

Type:: object

getMaskSegmentHelper() → {object}

Get the mask segment helper.

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

Returns:

The helper.

Type:: object

getOffset3DFromPlaneOffset(offset2D) → {dwv.math.Vector3D}

Get a 3D offset from a plane one.

Parameters:

Name	Type	Description
`offset2D`	object	The plane offset as {x,y}.

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

Returns:

The 3D world offset.

Type:: dwv.math.Vector3D

getPixelUnit() → {string}

Get the image pixel unit.

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

Returns:

The unit

Type:: string

getPlaneHelper() → {object}

Get the plane helper.

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

Returns:

The helper.

Type:: object

getPlanePositionFromPlanePoint(point2D) → {dwv.math.Point3D}

Get a plane 3D position from a plane 2D position: does not compensate for the image origin. Needed for setting the scale center...

Parameters:

Name	Type	Description
`point2D`	dwv.math.Point2D	The 2D position as {x,y}.

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

Returns:

The 3D point.

Type:: dwv.math.Point3D

getPlanePositionFromPosition(point3D) → {object}

Get a 2D (x,y) position from a position.

Parameters:

Name	Type	Description
`point3D`	dwv.math.Point3D	The 3D position.

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

Returns:

The 2D position.

Type:: object

getPositionFromPlanePoint(x, y) → {dwv.math.Point}

Get a position from a 2D (x,y) position.

Parameters:

Name	Type	Description
`x`	number	The column position.
`y`	number	The row position.

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

Returns:

The associated position.

Type:: dwv.math.Point

getRescaledImageValue(position) → {number|undefined}

Get the image rescaled value at the input position.

Parameters:

Name	Type	Description
`position`	dwv.math.Point	the input position.

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

Returns:

The image value or undefined if out of bounds or no quantifiable (for ex RGB).

Type:: number | undefined

getScrollIndex() → {number}

Get the scroll index.

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

Returns:

The index.

Type:: number

getWindowLevel() → {object}

Get the window/level.

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

Returns:

The window center and width.

Type:: object

getWindowLevelPresetsNames() → {Array}

Get the window/level presets names.

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

Returns:

The presets names.

Type:: Array

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/app/viewController.js, line 546

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/app/viewController.js, line 577

Returns:

False if not in bounds.

Type:: boolean

initialise()

Initialise the controller.

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

isMask() → {boolean}

Check is the associated image is a mask.

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

Returns:

True if the associated image is a mask.

Type:: boolean

isPlaying() → {boolean}

Check if the controller is playing.

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

Returns:

True if the controler is playing.

Type:: boolean

play()

Scroll play: loop through all slices.

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

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/app/viewController.js, line 716

setColourMap(colourMap)

Set the colour map.

Parameters:

Name	Type	Description
`colourMap`	object	The colour map.

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

setColourMapFromName(name)

Set the colour map from a name.

Parameters:

Name	Type	Description
`name`	string	The name of the colour map to set.

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

setCurrentIndex(index, silent) → {boolean}

Set the current index.

Parameters:

Name	Type	Description
`index`	dwv.math.Index	The index.
`silent`	boolean	If true, does not fire a positionchange event.

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

Returns:

False if not in bounds.

Type:: boolean

setCurrentPosition(pos, silent) → {boolean}

Set the current position.

Parameters:

Name	Type	Description
`pos`	dwv.math.Point	The position.
`silent`	boolean	If true, does not fire a positionchange event.

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

Returns:

False if not in bounds.

Type:: boolean

setImage(img, index)

Set the associated image.

Parameters:

Name	Type	Description
`img`	Image	The associated image.
`index`	number	The data index of the image.

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

setViewAlphaFunction(func)

Set the view per value alpha function.

Parameters:

Name	Type	Description
`func`	function	The function.

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

setWindowLevel(wc, ww)

Set the window/level.

Parameters:

Name	Type	Description
`wc`	number	The window center.
`ww`	number	The window width.

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

setWindowLevelPreset(name)

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

Parameters:

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

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

setWindowLevelPresetById(id)

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

Parameters:

Name	Type	Description
`id`	number	The id of the preset to activate.

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

stop()

Stop scroll playing.

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