Class: ViewController

Constructor

new ViewController(view)

Parameters:

Name	Type	Description
`view`	View	The associated view.

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

Classes

ViewController

Methods

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 137

Returns:

The list of presets.

Type:: object

bindImageAndLayer(viewLayer)

Bind the view image to the provided layer.

Parameters:

Name	Type	Description
`viewLayer`	ViewLayer	The layer to bind.

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

canQuantifyImage() → {boolean}

Can the image values be quantified?

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

Returns:

True if possible.

Type:: boolean

canScroll() → {boolean}

Can the data be scrolled?

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

Returns:

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

Type:: boolean

canWindowLevel() → {boolean}

Can window and level be applied to the data?

Deprecated: Since v0.33, please use isMonochrome instead.
Source: src/app/viewController.js, line 464

Returns:

True if possible.

Type:: boolean

decrementIndex(dim, silentopt) → {boolean}

Decrement the provided dimension.

Parameters:

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

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

Returns:

False if not in bounds.

Type:: boolean

decrementScrollIndex(silentopt) → {boolean}

Decrement the scroll dimension index.

Parameters:

Name	Type	Attributes	Description
`silent`	boolean	<optional>	Do not send event.

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

Returns:

False if not in bounds.

Type:: boolean

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 539

Returns:

True if the associated image has equal meta data.

Type:: boolean

generateImageData(array, indexopt)

Generate display image data to be given to a canvas.

Parameters:

Name	Type	Attributes	Description
`array`	ImageData		The array to fill in.
`index`	Index	<optional>	Optional index at which to generate, otherwise generates at current index.

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

get2DSpacing() → {Scalar2D}

Get the current view (2D) spacing.

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

Returns:

The spacing as a 2D array.

Type:: Scalar2D

getColourMap() → {string}

Get the colour map.

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

Returns:

The colour map name.

Type:: string

getCurrentImageUid() → {string}

Get the SOP image UID of the current image.

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

Returns:

The UID.

Type:: string

getCurrentIndex() → {Index}

Get the current index.

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

Returns:

The current index.

Type:: Index

getCurrentOrientedIndex() → {Index}

Get the current oriented index.

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

Returns:

The index.

Type:: Index

getCurrentPosition() → {Point}

Get the current position.

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

Returns:

The position.

Type:: Point

getCurrentScrollIndexValue() → {object}

Get the current scroll index value.

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

Returns:

The value.

Type:: object

getCurrentScrollPosition() → {number}

Get the current scroll position value.

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

Returns:

The value.

Type:: number

getCurrentWindowPresetName() → {string}

Get the current window level preset name.

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

Returns:

The preset name.

Type:: string

getDecrementPosition(dim) → {Point}

Get the current position decremented in the input direction.

Parameters:

Name	Type	Description
`dim`	number	The direction in which to decrement.

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

Returns:

The resulting point.

Type:: Point

getDecrementScrollPosition() → {Point}

Get the current position decremented in the scroll direction.

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

Returns:

The resulting point.

Type:: Point

getImageRegionValues(min, max) → {Array}

Get some values from the associated image in a region.

Parameters:

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

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

Returns:

A list of values.

Type:: Array

getImageRescaledDataRange() → {object}

Get the image rescaled data range.

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

Returns:

The range as {min, max}.

Type:: object

getImageSize() → {Size}

Get the oriented image size.

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

Returns:

The size.

Type:: Size

getImageVariableRegionValues(regions) → {Array}

Get some values from the associated image in variable regions.

Parameters:

Name	Type	Description
`regions`	Array.<Array.<Array.<number>>>	A list of [x, y] pairs (min, max).

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

Returns:

A list of values.

Type:: Array

getImageWorldSize() → {Scalar2D}

Get the image world (mm) 2D size.

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

Returns:

The 2D size as {x,y}.

Type:: Scalar2D

getIncrementPosition(dim) → {Point}

Get the current position incremented in the input direction.

Parameters:

Name	Type	Description
`dim`	number	The direction in which to increment.

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

Returns:

The resulting point.

Type:: Point

getIncrementScrollPosition() → {Point}

Get the current position decremented in the scroll direction.

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

Returns:

The resulting point.

Type:: Point

getIndexFromPosition(point) → {Index}

Get the index of a world position.

Parameters:

Name	Type	Description
`point`	Point	The 3D position.

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

Returns:

The index.

Type:: Index

getModality() → {string}

Get the image modality.

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

Returns:

The modality.

Type:: string

getOffset3DFromPlaneOffset(offset2D) → {Vector3D}

Get a 3D offset from a plane one.

Parameters:

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

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

Returns:

The 3D world offset.

Type:: Vector3D

getOrigin(positionopt) → {Point3D}

Get the first origin or at a given position.

Parameters:

Name	Type	Attributes	Description
`position`	Point	<optional>	Optional position.

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

Returns:

The origin.

Type:: Point3D

getOriginForImageUid(uid) → {Point3D|undefined}

Get the image origin for a image UID.

Parameters:

Name	Type	Description
`uid`	string	The UID.

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

Returns:

The origin.

Type:: Point3D | undefined

getPixelUnit() → {string}

Get the image pixel unit.

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

Returns:

The unit.

Type:: string

getPlaneHelper() → {PlaneHelper}

Get the plane helper.

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

Returns:

The helper.

Type:: PlaneHelper

getPlanePoints(position) → {Array.<Point3D>}

Get a list of points that define the plane at input position, given this classes orientation.

Parameters:

Name	Type	Description
`position`	Point	The position.

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

Returns:

An origin and 2 cosines vectors.

Type:: Array.<Point3D>

getPlanePositionFromPlanePoint(point2D) → {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`	Point2D	The 2D position.

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

Returns:

The 3D point.

Type:: Point3D

getPlanePositionFromPosition(point) → {Point2D}

Get a 2D plane position from a world position.

Parameters:

Name	Type	Description
`point`	Point	The 3D position.

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

Returns:

The 2D position.

Type:: Point2D

getPositionFromPlanePoint(point2D, kopt) → {Point}

Get a world position from a 2D plane position.

Parameters:

Name	Type	Attributes	Description
`point2D`	Point2D		The input point.
`k`	number	<optional>	Optional slice index, if undefined, uses the current one.

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

Returns:

The associated position.

Type:: Point

getRescaledImageValue(position) → {number|undefined}

Get the image rescaled value at the input position.

Parameters:

Name	Type	Description
`position`	Point	The input position.

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

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 239

Returns:

The index.

Type:: number

getWindowLevel() → {WindowLevel}

Get the window/level.

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

Returns:

The window and level.

Type:: WindowLevel

getWindowLevelPresetsNames() → {Array.<string>}

Get the window/level presets names.

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

Returns:

The presets names.

Type:: Array.<string>

includesImageUid(uid) → {boolean}

Check if the image includes an UID.

Parameters:

Name	Type	Description
`uid`	string	The UID.

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

Returns:

True if present.

Type:: boolean

incrementIndex(dim, silentopt) → {boolean}

Increment the provided dimension.

Parameters:

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

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

Returns:

False if not in bounds.

Type:: boolean

incrementScrollIndex(silentopt) → {boolean}

Increment the scroll dimension index.

Parameters:

Name	Type	Attributes	Description
`silent`	boolean	<optional>	Do not send event.

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

Returns:

False if not in bounds.

Type:: boolean

initialise()

Initialise the controller.

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

isAquisitionOrientation() → {boolean}

Is this view in the same orientation as the image aquisition.

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

Returns:

True if in aquisition plane.

Type:: boolean

isMask() → {boolean}

Check is the associated image is a mask.

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

Returns:

True if the associated image is a mask.

Type:: boolean

isMonochrome() → {boolean}

Is the data monochrome.

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

Returns:

True if the data is monochrome.

Type:: boolean

isPlaying() → {boolean}

Check if the controller is playing.

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

Returns:

True if the controler is playing.

Type:: boolean

isPositionInBounds(positionopt) → {boolean}

Check if the current position (default) or the provided position is in bounds.

Parameters:

Name	Type	Attributes	Description
`position`	Point	<optional>	Optional position.

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

Returns:

True is the position is in bounds.

Type:: boolean

moreThanOne(dim) → {boolean}

Is the data size larger than one in the given dimension?

Parameters:

Name	Type	Description
`dim`	number	The dimension.

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

Returns:

True if the image size is larger than one in the given dimension.

Type:: boolean

play()

Scroll play: loop through all slices.

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

setColourMap(name)

Set the colour map.

Parameters:

Name	Type	Description
`name`	string	The colour map name.

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

setCurrentIndex(index, silentopt) → {boolean}

Set the current index.

Parameters:

Name	Type	Attributes	Description
`index`	Index		The index.
`silent`	boolean	<optional>	If true, does not fire a positionchange event.

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

Returns:

False if not in bounds.

Type:: boolean

setCurrentPosition(pos, silentopt) → {boolean}

Set the current position.

Parameters:

Name	Type	Attributes	Description
`pos`	Point		The position.
`silent`	boolean	<optional>	If true, does not fire a positionchange event.

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

Returns:

False if not in bounds.

Type:: boolean

setImage(img)

Set the associated image.

Parameters:

Name	Type	Description
`img`	Image	The associated image.

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

setViewAlphaFunction(func)

Set the view per value alpha function.

Parameters:

Name	Type	Description
`func`	alphaFn	The function.

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

setWindowLevel(wl)

Set the window and level.

Parameters:

Name	Type	Description
`wl`	WindowLevel	The window and level.

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

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 146

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 155

stop()

Stop scroll playing.

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

unbindImageAndLayer(viewLayer)

Unbind the view image to the provided layer.

Parameters:

Name	Type	Description
`viewLayer`	ViewLayer	The layer to bind.

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