Skip to main content
Version: Next

VectorOverlayConfigStore

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

angularSource

angularSource: VectorOverlaySource = VectorOverlaySource.Current

color

color: RGBColor = ...

colormap

colormap: string = ""

colormapBias

colormapBias: number = 0.0

colormapContrast

colormapContrast: number = 1.0

intensityMax

intensityMax: number | undefined = undefined

intensityMin

intensityMin: number | undefined = undefined

intensitySource

intensitySource: VectorOverlaySource = VectorOverlaySource.Current

isColormapEnabled

isColormapEnabled: boolean = false

isDebiasing

isDebiasing: boolean = false

isEnabled

isEnabled: boolean = false

isFractionalIntensity

isFractionalIntensity: boolean = false

isThresholdEnabled

isThresholdEnabled: boolean = false

isVisible

isVisible: boolean = true

lengthMax

lengthMax: number = VectorOverlayConfigStore.defaultLengthMax

lengthMin

lengthMin: number = VectorOverlayConfigStore.defaultLengthMin

pixelAveraging

pixelAveraging: number = 0

qError

qError: number = 0

rotationOffset

rotationOffset: number = 0

thickness

thickness: number = 1

threshold

threshold: number = 0

thresholdOption

thresholdOption: any = CARTA.PolarizationType.I

uError

uError: number = 0

publicstaticdefaultLengthMax

defaultLengthMax: number = 20

publicstaticdefaultLengthMin

defaultLengthMin: number = 0

Methods

setColor

  • setColor(color: ColorInput): void

  • Parameters

    • color: ColorInput

    Returns void

setColormap

  • setColormap(colormap: string): void

  • Parameters

    • colormap: string

    Returns void

setColormapBias

  • setColormapBias(val: number): void

  • Parameters

    • val: number

    Returns void

setColormapContrast

  • setColormapContrast(val: number): void

  • Parameters

    • val: number

    Returns void

setColormapEnabled

  • setColormapEnabled(isColormapEnabled: boolean): void

  • Parameters

    • isColormapEnabled: boolean

    Returns void

setEnabled

  • setEnabled(isEnabled: boolean): void

  • Parameters

    • isEnabled: boolean

    Returns void

setIntensityRange

  • setIntensityRange(min: number | undefined, max: number | undefined): void

  • Parameters

    • min: number | undefined
    • max: number | undefined

    Returns void

setLengthRange

  • setLengthRange(min: number, max: number): void

  • Parameters

    • min: number
    • max: number

    Returns void

setRotationOffset

  • setRotationOffset(val: number): void

  • Parameters

    • val: number

    Returns void

setThickness

  • setThickness(val: number): void

  • Parameters

    • val: number

    Returns void

setThresholdEnabled

  • setThresholdEnabled(isThresholdEnabled: boolean): void

  • Parameters

    • isThresholdEnabled: boolean

    Returns void

setThresholdOption

  • setThresholdOption(val: any): void

  • Parameters

    • val: any

    Returns void

setVectorOverlayConfiguration

  • setVectorOverlayConfiguration(angularSource: VectorOverlaySource, intensitySource: VectorOverlaySource, pixelAveraging: number, isFractionalIntensity: boolean, isThresholdEnabled: boolean, threshold: number, isDebiasing: boolean, qError: number, uError: number, thresholdOption: any): void

  • Parameters

    • angularSource: VectorOverlaySource
    • intensitySource: VectorOverlaySource
    • pixelAveraging: number
    • isFractionalIntensity: boolean
    • isThresholdEnabled: boolean
    • threshold: number
    • isDebiasing: boolean
    • qError: number
    • uError: number
    • thresholdOption: any

    Returns void

setVisible

  • setVisible(isVisible: boolean): void

  • Parameters

    • isVisible: boolean

    Returns void

toggleVisibility

  • toggleVisibility(): void

  • Returns void

updateFromWorkspace

Page Options