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

colormapEnabled

colormapEnabled: boolean = false

debiasing

debiasing: boolean = false

enabled

enabled: boolean = false

fractionalIntensity

fractionalIntensity: boolean = false

intensityMax

intensityMax: number | undefined = undefined

intensityMin

intensityMin: number | undefined = undefined

intensitySource

intensitySource: VectorOverlaySource = VectorOverlaySource.Current

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

thresholdEnabled

thresholdEnabled: boolean = false

thresholdOption

thresholdOption: any = CARTA.PolarizationType.I

uError

uError: number = 0

visible

visible: boolean = true

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(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setEnabled

  • setEnabled(val: boolean): void

  • Parameters

    • val: 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(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setThresholdOption

  • setThresholdOption(val: any): void

  • Parameters

    • val: any

    Returns void

setVectorOverlayConfiguration

  • setVectorOverlayConfiguration(angularSource: VectorOverlaySource, intensitySource: VectorOverlaySource, pixelAveraging: number, fractionalIntensity: boolean, thresholdEnabled: boolean, threshold: number, debiasing: boolean, qError: number, uError: number, thresholdOption: any): void

  • Parameters

    • angularSource: VectorOverlaySource
    • intensitySource: VectorOverlaySource
    • pixelAveraging: number
    • fractionalIntensity: boolean
    • thresholdEnabled: boolean
    • threshold: number
    • debiasing: boolean
    • qError: number
    • uError: number
    • thresholdOption: any

    Returns void

setVisible

  • setVisible(visible: boolean): void

  • Parameters

    • visible: boolean

    Returns void

toggleVisibility

  • toggleVisibility(): void

  • Returns void

updateFromWorkspace

Page Options