WindowLevelTool

WindowLevel tool manipulates the windowLevel applied to a viewport. It provides a way to set the windowCenter and windowWidth of a viewport by dragging mouse over the image.

Hierarchy

• BaseTool
  • WindowLevelTool

Index

Constructors

• constructor

Properties

• configuration
• mode
• supportedInteractionTypes
• toolGroupId
• toolName

Methods

• _getImageDynamicRangeFromMiddleSlice
• _getImageDynamicRangeFromViewport
• _getMultiplierFromDynamicRange
• applyActiveStrategy
• applyActiveStrategyCallback
• getNewRange
• getPTScaledNewRange
• getToolName
• mouseDragCallback
• setActiveStrategy
• setConfiguration
• touchDragCallback

Constructors

constructor

• new WindowLevelTool(toolProps?: {}, defaultToolProps?: { supportedInteractionTypes: string[] }): WindowLevelTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: {} = {}

  • defaultToolProps: { supportedInteractionTypes: string[] } = ...

  Returns WindowLevelTool

Properties

publicconfiguration

configuration: Record<string, any>

Inherited from BaseTool.configuration

publicmode

mode: ToolModes

Inherited from BaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Inherited from BaseTool.supportedInteractionTypes

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

Inherited from BaseTool.toolGroupId

ToolGroup ID the tool instance belongs to

statictoolName

toolName: any

Overrides BaseTool.toolName

Methods

_getImageDynamicRangeFromMiddleSlice

• _getImageDynamicRangeFromMiddleSlice(scalarData: any, dimensions: any): number

• Parameters

  • scalarData: any

  • dimensions: any

  Returns number

_getImageDynamicRangeFromViewport

• _getImageDynamicRangeFromViewport(viewport: any): number

• Parameters

  • viewport: any

  Returns number

_getMultiplierFromDynamicRange

• _getMultiplierFromDynamicRange(viewport: any, volumeId: any): number

• Parameters

  • viewport: any

  • volumeId: any

  Returns number

publicapplyActiveStrategy

• applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any

• Inherited from BaseTool.applyActiveStrategy

  Applies the active strategy function to the enabled element with the specified operation data.

  ---

  Parameters

  • enabledElement: IEnabledElement

    The element that is being operated on.

  • operationData: unknown

    The data that needs to be passed to the strategy.

  Returns any

  The result of the strategy.

publicapplyActiveStrategyCallback

• applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): any

• Inherited from BaseTool.applyActiveStrategyCallback

  Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.

  ---

  Parameters

  • enabledElement: IEnabledElement

    The element that is being operated on.

  • operationData: unknown

    The data that needs to be passed to the strategy.

  • callbackType: string

    the type of the callback

  Returns any

  The result of the strategy.

getNewRange

• getNewRange(__namedParameters: Object): { lower: number; upper: number }

• Parameters

  • __namedParameters: Object

  Returns { lower: number; upper: number }

  • lower: number

  • upper: number

getPTScaledNewRange

• getPTScaledNewRange(__namedParameters: Object): { lower: any; upper: any }

• Parameters

  • __namedParameters: Object

  Returns { lower: any; upper: any }

  • lower: any

  • upper: any

publicgetToolName

• getToolName(): string

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

mouseDragCallback

• mouseDragCallback(evt: InteractionEventType): void

• Parameters

  • evt: InteractionEventType

  Returns void

publicsetActiveStrategy

• setActiveStrategy(strategyName: string): void

• Inherited from BaseTool.setActiveStrategy

  Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.

  ---

  Parameters

  • strategyName: string

    name of the strategy to be set as active

  Returns void

publicsetConfiguration

• setConfiguration(newConfiguration: Record<string, any>): void

• Inherited from BaseTool.setConfiguration

  merges the new configuration with the tool configuration

  ---

  Parameters

  • newConfiguration: Record<string, any>

  Returns void

touchDragCallback

• touchDragCallback(evt: InteractionEventType): void

• Parameters

  • evt: InteractionEventType

  Returns void