Class: ViewController

Constructor

new ViewController(view, index)

Parameters:

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

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

Classes

ViewController

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

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 174

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 130

canQuantifyImage() → {boolean}

Can the image values be quantified?

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

Returns:

True if possible.

Type:: boolean

canScroll() → {boolean}

Can the data be scrolled?

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

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`	Point	The position.

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

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 428

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 620

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 630

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 142

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 482

Returns:

True if the associated image has equal meta data.

Type:: boolean

generateImageData(array, index)

Generate display image data to be given to a canvas.

Parameters:

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

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

get2DSpacing() → {Array}

Get the current spacing.

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

Returns:

The 2D spacing.

Type:: Array

getColourMap() → {ColourMap}

Get the colour map.

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

Returns:

The colour map.

Type:: ColourMap

getCurrentIndex() → {Index}

Get the current index.

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

Returns:

The current index.

Type:: Index

getCurrentOrientedIndex() → {Index}

Get the current oriented index.

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

Returns:

The index.

Type:: Index

getCurrentPosition() → {Point}

Get the current position.

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

Returns:

The position.

Type:: Point

getCurrentScrollIndexValue() → {object}

Get the current scroll index value.

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

Returns:

The value.

Type:: object

getCurrentScrollPosition() → {object}

Get the current scroll position value.

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

Returns:

The value.

Type:: object

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 349

Returns:

A list of values.

Type:: Array

getImageRescaledDataRange() → {object}

Get the image rescaled data range.

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

Returns:

The range as {min, max}.

Type:: object

getImageSize() → {Size}

Get the image size.

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

Returns:

The size.

Type:: 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 401

Returns:

A list of values.

Type:: Array

getImageWorldSize() → {object}

Get the image world (mm) 2D size.

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

Returns:

The 2D size as {x,y}.

Type:: object

getMaskSegmentHelper() → {object}

Get the mask segment helper.

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

Returns:

The helper.

Type:: object

getOffset3DFromPlaneOffset(offset2D) → {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 598

Returns:

The 3D world offset.

Type:: Vector3D

getOrigin(position) → {Point}

Get the origin at a given posittion.

Parameters:

Name	Type	Description
`position`	Point	The input position.

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

Returns:

The origin.

Type:: Point

getPixelUnit() → {string}

Get the image pixel unit.

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

Returns:

The unit

Type:: string

getPlaneHelper() → {object}

Get the plane helper.

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

Returns:

The helper.

Type:: object

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`	object	The 2D position as {x,y}.

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

Returns:

The 3D point.

Type:: Point3D

getPlanePositionFromPosition(point) → {object}

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

Parameters:

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

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

Returns:

The 2D position.

Type:: object

getPositionFromPlanePoint(x, y) → {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 527

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 319

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 247

Returns:

The index.

Type:: number

getWindowLevel() → {object}

Get the window/level.

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

Returns:

The window center and width.

Type:: object

getWindowLevelPresetsNames() → {Array}

Get the window/level presets names.

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

Returns:

The presets names.

Type:: Array

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 609

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 640

Returns:

False if not in bounds.

Type:: boolean

initialise()

Initialise the controller.

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

isMask() → {boolean}

Check is the associated image is a mask.

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

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 201

Returns:

True if the controler is playing.

Type:: boolean

play()

Scroll play: loop through all slices.

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

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

setColourMap(colourMap)

Set the colour map.

Parameters:

Name	Type	Description
`colourMap`	ColourMap	The colour map.

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

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 759

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 566

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 516

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 297

setViewAlphaFunction(func)

Set the view per value alpha function.

Parameters:

Name	Type	Description
`func`	alphaFn	The function.

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

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 716

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 183

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 192

stop()

Stop scroll playing.

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