Skip to main content
Version: Next

RenderConfigStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

alpha

alpha: number

bias

bias: number

channelHistogram

channelHistogram: IHistogram

colorMapIndex

colorMapIndex: number

contrast

contrast: number

cubeHistogram

cubeHistogram: IHistogram

cubeHistogramProgress

cubeHistogramProgress: number

customColormapHexEnd

customColormapHexEnd: string

customColormapHexStart

customColormapHexStart: string

gamma

gamma: number

histChannel

histChannel: number

inverted

inverted: boolean

readonlypreference

preference: PreferenceStore

previewHistogramMax

previewHistogramMax: number

previewHistogramMin

previewHistogramMin: number

scaleMax

scaleMax: number[]

scaleMin

scaleMin: number[]

scaling

scaling: FrameScaling

selectedPercentile

selectedPercentile: number[]

stokesIndex

stokesIndex: number

useCubeHistogram

useCubeHistogram: boolean

useCubeHistogramContours

useCubeHistogramContours: boolean

visible

visible: boolean

staticreadonlyALPHA_MAX

ALPHA_MAX: 1000000 = 1000000

staticreadonlyALPHA_MIN

ALPHA_MIN: 0.1 = 0.1

staticreadonlyBIAS_MAX

BIAS_MAX: 1 = 1

staticreadonlyBIAS_MIN

BIAS_MIN: -1 = -1

staticreadonlyCOLOR_MAPS_ALL

COLOR_MAPS_ALL: string[] = ...

All provided colormaps.

staticreadonlyCOLOR_MAPS_CUSTOM

COLOR_MAPS_CUSTOM: custom = "custom"

staticreadonlyCOLOR_MAPS_MONO

COLOR_MAPS_MONO: Map<string, string> = ...

Some commonly used single-color gradients.

staticreadonlyCOLOR_MAPS_PANEL

COLOR_MAPS_PANEL: color_panel = "color_panel"

staticreadonlyCOLOR_MAPS_SELECTED

COLOR_MAPS_SELECTED: string[] = ...

The selected colormaps shown in the option.

staticreadonlyCONTRAST_MAX

CONTRAST_MAX: 2 = 2

staticreadonlyCONTRAST_MIN

CONTRAST_MIN: 0 = 0

staticreadonlyCUSTOM_COLOR_MAP_INDEX

CUSTOM_COLOR_MAP_INDEX: -1 = -1

staticreadonlyGAMMA_MAX

GAMMA_MAX: 2 = 2

staticreadonlyGAMMA_MIN

GAMMA_MIN: 0.1 = 0.1

staticreadonlyPERCENTILE_RANKS

PERCENTILE_RANKS: number[] = ...

staticreadonlySCALING_TYPES

SCALING_TYPES: Map<FrameScaling, string> = ...

Accessors

colorMap

  • get colorMap(): string

  • Returns string

colorscaleArray

  • get colorscaleArray(): any[]

  • Returns any[]

contourHistogram

  • get contourHistogram(): IHistogram

  • Returns IHistogram

customColorGradient

  • get customColorGradient(): { color: Uint8ClampedArray; size: number }

  • Returns { color: Uint8ClampedArray; size: number }

    • color: Uint8ClampedArray
    • size: number

histogram

  • get histogram(): IHistogram

  • Returns IHistogram

histogramMax

  • get histogramMax(): any

  • Returns any

histogramMin

  • get histogramMin(): number

  • Returns number

monoColormapHex

  • get monoColormapHex(): string

  • Returns string

scaleMaxVal

  • get scaleMaxVal(): number

  • Returns number

scaleMinVal

  • get scaleMinVal(): number

  • Returns number

scalingName

  • get scalingName(): string

  • Returns string

selectedPercentileVal

  • get selectedPercentileVal(): number

  • Returns number

Methods

resetBias

  • resetBias(): void

  • Set the bias to be default value 0.

    Returns void

resetContrast

  • resetContrast(): void

  • Set the contrast to be default value 1.

    Returns void

setAlpha

  • setAlpha(alpha: number): void

  • Set the alpha value for the scaling type Power.

    Parameters

    • alpha: number

      The alpha value of the scaling type Power.

    Returns void

setBias

  • setBias(bias: number): void

  • Set the bias value.

    Parameters

    • bias: number

      The bias value of the colormap.

    Returns void

setColorMap

  • setColorMap(colormap: string): void

setColorMapIndex

  • setColorMapIndex(index: number): void

  • Set index of the colormap.

    Parameters

    Returns void

setContrast

  • setContrast(contrast: number): void

  • Set the contrast value.

    Parameters

    • contrast: number

      The contrast value of the colormap.

    Returns void

setCustomHexEnd

  • setCustomHexEnd(colorHex: string): void

  • Set Hex to generate the custom colormap.

    Parameters

    • colorHex: string

      The Hex string.

    Returns void

setCustomHexStart

  • setCustomHexStart(colorHex: string): void

  • Set starting Hex to generate the custom colormap. The default color is black.

    Parameters

    • colorHex: string

      The Hex string.

    Returns void

setCustomScale

  • setCustomScale(minVal: number, maxVal: number): void

  • Set minimum and maximum values of the scaling.

    Parameters

    • minVal: number

      The minimum scaling value.

    • maxVal: number

      The maximum scaling value.

    Returns void

setGamma

  • setGamma(gamma: number): void

  • Set the gamma value for the scaling type Gamma.

    Parameters

    • gamma: number

      The gamma value of the scaling type Gamma.

    Returns void

setHistChannel

  • setHistChannel(val: number): void

  • Set the channel number for the histogram.

    Parameters

    • val: number

      The channel number.

    Returns void

setInverted

  • setInverted(inverted: boolean): void

  • Invert the colormap.

    Parameters

    • inverted: boolean

      True for inverting colormap.

    Returns void

setPercentileRank

  • setPercentileRank(rank: number): boolean

  • Set the included histogram fraction for the colormap.

    Parameters

    • rank: number

      A value between 0 and 100.

    Returns boolean

    A boolean for the checking purpose.

setPreviewHistogramMax

  • setPreviewHistogramMax(histogramMax: number): void

  • Set the upper boundary of the histogram in the preview image.

    Parameters

    • histogramMax: number

      The upper cut of the histogram.

    Returns void

setPreviewHistogramMin

  • setPreviewHistogramMin(histogramMin: number): void

  • Set the lower boundary of the histogram in the preview image.

    Parameters

    • histogramMin: number

      The lower cut of the histogram.

    Returns void

setScaling

setStokesIndex

  • setStokesIndex(val: number): void

  • Set the polarization index for the histogram.

    Parameters

    • val: number

      The polarization index from 0 to maximum 8 (depending on data).

    Returns void

setUseCubeHistogram

  • setUseCubeHistogram(val: boolean): void

  • Use cube data instead of per channel data for the histogram.

    Parameters

    • val: boolean

      True for using the cube data.

    Returns void

setUseCubeHistogramContours

  • setUseCubeHistogramContours(val: boolean): void

  • Use cube data instead of per channel data for the contour.

    Parameters

    • val: boolean

      True for using the cube data.

    Returns void

setVisible

  • setVisible(visible: boolean): void

  • Parameters

    • visible: boolean

    Returns void

toggleVisibility

  • toggleVisibility(): void

  • Returns void

updateChannelHistogram

  • updateChannelHistogram(histogram: IHistogram): void

  • Parameters

    • histogram: IHistogram

    Returns void

updateCubeHistogram

  • updateCubeHistogram(histogram: IHistogram, progress: number): void

  • Parameters

    • histogram: IHistogram
    • progress: number

    Returns void

updateFrom

updateFromWorkspace

updateSiblings

  • updateSiblings(): void

  • Returns void

publicstaticIsColormapValid

  • IsColormapValid(colormap: string): boolean

  • Parameters

    • colormap: string

    Returns boolean

publicstaticIsGammaValid

  • IsGammaValid(gamma: number): boolean

  • Parameters

    • gamma: number

    Returns boolean

publicstaticIsPercentileValid

  • IsPercentileValid(percentile: number): boolean

  • Parameters

    • percentile: number

    Returns boolean

publicstaticIsScalingValid