OpenLIME Class: LayerDstretch

new LayerDstretch(options)

Creates a new LayerDStretch instance

Parameters:

Name	Type	Description
`options`	LayerDStretchOptions	Configuration options

Source:

LayerDstretch.js, line 57

Throws:

If url option is not provided
Type Error

Example

```javascript
// Create DStretch layer
const dstretchLayer = new OpenLIME.Layer({
  type: 'dstretch',
  url: 'image.jpg',
  visible: true
});

// Add to viewer
viewer.addLayer('enhanced', dstretchLayer);

// Adjust enhancement parameters
dstretchLayer.setLight([0.5, 0.3], 500); // Animate to new enhancement
```

Extends

LayerImage

Methods

addControl(name, value)

Adds a shader parameter control

Parameters:

Name	Type	Description
`name`	string	Control identifier
`value`	*	Initial value

Inherited From:

Layer#addControl

Overrides:

LayerImage#addControl

Source:

Layer.js, line 437

Throws:

If control already exists
Type Error

addShaderFilter(filter)

Adds a filter to the current shader

Parameters:

Name	Type	Description
`filter`	Object	Filter specification

Inherited From:

Layer#addShaderFilter

Overrides:

LayerImage#addShaderFilter

Source:

Layer.js, line 170

Throws:

If no shader is set
Type Error

boundingBox()

Gets layer bounding box in scene coordinates

Inherited From:

Layer#boundingBox

Overrides:

LayerImage#boundingBox

Source:

Layer.js, line 381

Returns:

Bounding box

Type: BoundingBox

clearShaderFilters(name)

Removes all filters from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#clearShaderFilters

Overrides:

LayerImage#clearShaderFilters

Source:

Layer.js, line 190

Throws:

If no shader is set
Type Error

getControl(name)

Gets the shader parameter control corresponding to name

Parameters:

Name	Type	Description
`name`	*	The name of the control. return {*} The control

Inherited From:

Layer#getControl

Overrides:

LayerImage#getControl

Source:

Layer.js, line 422

getMode()

Gets the current shader visualization mode

Inherited From:

Layer#getMode

Overrides:

LayerImage#getMode

Source:

Layer.js, line 289

Returns:

Current mode or null if no shader

Type: string | null

getModes()

Gets available shader modes

Inherited From:

Layer#getModes

Overrides:

LayerImage#getModes

Source:

Layer.js, line 299

Returns:

Array of available modes

Type: Array.<string>

getState( [stateMask])

Gets the current layer state

Parameters:

Name	Type	Argument	Default	Description
`stateMask`	Object	<optional>	null	Optional mask to filter returned state properties

Inherited From:

Layer#getState

Overrides:

LayerImage#getState

Source:

Layer.js, line 216

Returns:

Current state object

Type: Object

interpolateControls()

Updates control interpolation

Inherited From:

Layer#interpolateControls

Overrides:

LayerImage#interpolateControls

Source:

Layer.js, line 472

Returns:

Whether all interpolations are complete

Type: boolean

pixelSizePerMM()

Gets pixel size in millimeters

Inherited From:

Layer#pixelSizePerMM

Overrides:

LayerImage#pixelSizePerMM

Source:

Layer.js, line 372

Returns:

Size of one pixel in mm

Type: number

removeShaderFilter(name)

Removes a filter from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#removeShaderFilter

Overrides:

LayerImage#removeShaderFilter

Source:

Layer.js, line 180

Throws:

If no shader is set
Type Error

scale()

Gets layer scale

Inherited From:

Layer#scale

Overrides:

LayerImage#scale

Source:

Layer.js, line 362

Returns:

Current scale value

Type: number

setControl(name, value [, dt] [, easing])

Sets a shader control value with optional animation

Parameters:

Name	Type	Argument	Default	Description
`name`	string			Control identifier
`value`	*			New value
`dt`	number	<optional>		Animation duration in ms
`easing`	string	<optional>	'linear'	Easing function

Inherited From:

Layer#setControl

Overrides:

LayerImage#setControl

Source:

Layer.js, line 452

Fires:

Layer#event:update

setLight(value [, dt])

Sets the enhancement parameters through a light-like interface

Parameters:

Name	Type	Argument	Description
`value`	Array.<number>		Two values controlling the enhancement transformation
`dt`	number	<optional>	Animation duration in milliseconds

Source:

LayerDstretch.js, line 85

Fires:

Layer#event:update

setMode(mode)

Sets shader visualization mode

Parameters:

Name	Type	Description
`mode`	string	Mode to set

Inherited From:

Layer#setMode

Overrides:

LayerImage#setMode

Source:

Layer.js, line 310

Fires:

Layer#event:update

setShader(id)

Sets the active shader

Parameters:

Name	Type	Description
`id`	string	Shader identifier from registered shaders

Inherited From:

Layer#setShader

Overrides:

LayerImage#setShader

Source:

Layer.js, line 277

Fires:

Layer#event:update

Throws:

If shader ID is not found
Type Error

setState(state [, dt] [, easing])

Sets the layer state with optional animation

Parameters:

Name	Type	Argument	Default	Description
`state`	Object			State object with controls and mode
`dt`	number	<optional>		Animation duration in ms
`easing`	string	<optional>	'linear'	Easing function ('linear'\|'ease-out'\|'ease-in-out')