SpectralProfileWidgetStore

Hierarchy

• RegionWidgetStore
  • SpectralProfileWidgetStore

Index

Constructors

• constructor

Properties

• channel
• channelValueRange
• cursorX
• fileId
• fittingStore
• intensityUnit
• isHighlighted
• isMarkerTextVisible
• isMeanRmsVisible
• isMouseMoveIntoLinePlots
• isRestFrameShiftInputValid
• isSecondaryAxisCursorInfoVisible
• isStreamingData
• isXAxisRestFrameEnabled
• isYAxisRestFrameEnabled
• lineColorMap
• linePlotInitXYBoundaries
• linePlotPointSize
• lineWidth
• maskRange
• maxX
• maxY
• minX
• minY
• momentMask
• momentRegionId
• plotType
• primaryLineColor
• profileSelectionStore
• regionIdMap
• restFrameRedshift
• restFrameShiftMode
• restFrameVelocityConvention
• selectedMoments
• selectingMode
• settingsTabId
• shouldKeep
• smoothingStore
• type
• PRIMARY_LINE_KEY

Accessors

• displayChannelValueRange
• displayIntensityUnit
• displayMaskRange
• effectiveFrame
• effectiveRegion
• effectiveRegionId
• effectiveRegionInfo
• effectiveRestFrameRedshift
• effectiveSecondarySpectralType
• effectiveSecondarySpectralUnit
• frameOptions
• intensityOptions
• isAutoScaledX
• isAutoScaledY
• isEffectiveFrameEqualToActiveFrame
• isIntensityConvertible
• isMatchingSelectedRegion
• isMomentRegionValid
• isRestFrameCorrectionActive
• isRestFrameCorrectionRequested
• isSelectingMomentChannelRange
• isSelectingMomentMaskRange
• isXAxisRestFrameActive
• isXAxisRestFrameSupported
• isYAxisRestFrameActive
• isYAxisRestFrameSupported
• momentRegionInfo
• momentRegionOptions
• plotData
• profileNum
• redshiftFactor
• restFrameCorrectionExportComments
• restFrameRadialVelocity
• secondarySpectralUnitLabel
• selectedRange
• spectralUnitLabel
• transformedSpectralLines
• xAxisLabel
• yAxisLabel
• yAxisRestFrameScale
• yUnit
• yUnitLabel

Methods

• addSpectralLines
• applyConfig
• clearFrameEntry
• clearMomentRangeSelectingMode
• clearProfileColors
• clearRegionMap
• clearSelectedMoments
• clearSpectralLines
• clearXBounds
• clearXYBounds
• clearYBounds
• convertDisplayXToObserved
• convertDisplayYToObserved
• convertObservedXToDisplay
• convertObservedYToDisplay
• deselectMoment
• dispose
• getProfileColor
• initXYBoundaries
• isMomentSelected
• removeMomentByIndex
• removeProfileColor
• requestingMomentCancelled
• requestMoment
• selectFrame
• selectMoment
• selectMomentRegion
• setChannel
• setCursor
• setFileId
• setHighlighted
• setKeep
• setLinePlotPointSize
• setLineWidth
• setMarkerTextVisible
• setMeanRmsVisible
• setMomentMask
• setMomentRangeSelectingMode
• setMouseMoveIntoLinePlots
• setMultiProfileIntensityUnit
• setPlotType
• setProfileColor
• setRegionId
• setRestFrameRadialVelocity
• setRestFrameRedshift
• setRestFrameShift
• setRestFrameShiftInputValid
• setRestFrameShiftMode
• setRestFrameVelocityConvention
• setSecondaryAxisCursorInfoVisible
• setSelectedChannelRange
• setSelectedDisplayChannelRange
• setSelectedDisplayMaskRange
• setSelectedMaskRange
• setSettingsTabId
• setSpectralCoordinate
• setSpectralCoordinateSecondary
• setSpectralSystem
• setXAxisRestFrameEnabled
• setXBounds
• setXYBounds
• setYAxisRestFrameEnabled
• setYBounds
• toConfig
• updateStreamingDataStatus
• calculateRequirementsArray
• calculateRequirementsMap
• diffSpectralRequirements

Constructors

constructor

• SpectralProfileWidgetStore(coordinate?: string): SpectralProfileWidgetStore

• Overrides RegionWidgetStore.constructor

  Parameters

  • coordinate: string = "z"

  Returns SpectralProfileWidgetStore

Properties

channel

channel: number = 0

channelValueRange

channelValueRange: NumberRange = ...

cursorX

cursorX: number = 0

inheritedfileId

fileId: number = ACTIVE_FILE_ID

Inherited from RegionWidgetStore.fileId

readonlyfittingStore

fittingStore: ProfileFittingStore

intensityUnit

intensityUnit: string | undefined = undefined

isHighlighted

isHighlighted: boolean = false

isMarkerTextVisible

isMarkerTextVisible: boolean = false

isMeanRmsVisible

isMeanRmsVisible: boolean = false

isMouseMoveIntoLinePlots

isMouseMoveIntoLinePlots: boolean = false

isRestFrameShiftInputValid

isRestFrameShiftInputValid: boolean = true

isSecondaryAxisCursorInfoVisible

isSecondaryAxisCursorInfoVisible: boolean = false

isStreamingData

isStreamingData: boolean = false

isXAxisRestFrameEnabled

isXAxisRestFrameEnabled: boolean = false

isYAxisRestFrameEnabled

isYAxisRestFrameEnabled: boolean = false

lineColorMap

lineColorMap: Map<LineKey, string> = ...

linePlotInitXYBoundaries

linePlotInitXYBoundaries: { maxXVal: number | undefined; maxYVal: number | undefined; minXVal: number | undefined; minYVal: number | undefined } = ...

Type declaration

• maxXVal: number | undefined

• maxYVal: number | undefined

• minXVal: number | undefined

• minYVal: number | undefined

linePlotPointSize

linePlotPointSize: number = 1.5

lineWidth

lineWidth: number = 1

maskRange

maskRange: NumberRange = ...

maxX

maxX: number | undefined = undefined

maxY

maxY: number | undefined = undefined

minX

minX: number | undefined = undefined

minY

minY: number | undefined = undefined

momentMask

momentMask: MomentMask = CARTA.MomentMask.None

momentRegionId

momentRegionId: number = RegionId.ACTIVE

plotType

plotType: PlotType = PlotType.STEPS

primaryLineColor

primaryLineColor: string = "auto-blue"

readonlyprofileSelectionStore

profileSelectionStore: SpectralProfileSelectionStore

inheritedregionIdMap

regionIdMap: Map<number, number> = ...

Inherited from RegionWidgetStore.regionIdMap

restFrameRedshift

restFrameRedshift: number = 0

restFrameShiftMode

restFrameShiftMode: RestFrameShiftMode = PreferenceStore.Instance.spectralProfilerRestFrameShiftMode

restFrameVelocityConvention

restFrameVelocityConvention: VelocityConvention = PreferenceStore.Instance.spectralProfilerRestFrameVelocityConvention

selectedMoments

selectedMoments: Moment[] = ...

selectingMode

selectingMode: MomentSelectingMode = MomentSelectingMode.NONE

settingsTabId

settingsTabId: SpectralProfilerSettingsTabs = SpectralProfilerSettingsTabs.CONVERSION

shouldKeep

shouldKeep: boolean = false

readonlysmoothingStore

smoothingStore: ProfileSmoothingStore

inheritedtype

type: RegionsType

Inherited from RegionWidgetStore.type

publicstaticreadonlyPRIMARY_LINE_KEY

PRIMARY_LINE_KEY: Primary = "Primary"

Accessors

displayChannelValueRange

• get displayChannelValueRange(): NumberRange

• Returns NumberRange

displayIntensityUnit

• get displayIntensityUnit(): string | undefined

• Returns string | undefined

displayMaskRange

• get displayMaskRange(): NumberRange

• Returns NumberRange

inheritedeffectiveFrame

• get effectiveFrame(): FrameStore | null | undefined

• Inherited from RegionWidgetStore.effectiveFrame

  Returns FrameStore | null | undefined

inheritedeffectiveRegion

• get effectiveRegion(): RegionStore | undefined

• Inherited from RegionWidgetStore.effectiveRegion

  Returns RegionStore | undefined

inheritedeffectiveRegionId

• get effectiveRegionId(): number | null

• Inherited from RegionWidgetStore.effectiveRegionId

  Returns number | null

inheritedeffectiveRegionInfo

• get effectiveRegionInfo(): string | undefined

• Inherited from RegionWidgetStore.effectiveRegionInfo

  Returns string | undefined

effectiveRestFrameRedshift

• get effectiveRestFrameRedshift(): number

• Returns number

effectiveSecondarySpectralType

• get effectiveSecondarySpectralType(): SpectralType

• Returns SpectralType

effectiveSecondarySpectralUnit

• get effectiveSecondarySpectralUnit(): SpectralUnit | null

• Returns SpectralUnit | null

inheritedframeOptions

• get frameOptions(): OptionProps[]

• Inherited from RegionWidgetStore.frameOptions

  Returns OptionProps[]

intensityOptions

• get intensityOptions(): string[]

• Returns string[]

isAutoScaledX

• get isAutoScaledX(): boolean

• Returns boolean

isAutoScaledY

• get isAutoScaledY(): boolean

• Returns boolean

inheritedisEffectiveFrameEqualToActiveFrame

• get isEffectiveFrameEqualToActiveFrame(): boolean

• Inherited from RegionWidgetStore.isEffectiveFrameEqualToActiveFrame

  Returns boolean

isIntensityConvertible

• get isIntensityConvertible(): boolean

• Returns boolean

inheritedisMatchingSelectedRegion

• get isMatchingSelectedRegion(): boolean

• Inherited from RegionWidgetStore.isMatchingSelectedRegion

  Returns boolean

isMomentRegionValid

• get isMomentRegionValid(): boolean

• Returns boolean

isRestFrameCorrectionActive

• get isRestFrameCorrectionActive(): boolean

• Returns boolean

isRestFrameCorrectionRequested

• get isRestFrameCorrectionRequested(): boolean

• Returns boolean

isSelectingMomentChannelRange

• get isSelectingMomentChannelRange(): boolean

• Returns boolean

isSelectingMomentMaskRange

• get isSelectingMomentMaskRange(): boolean

• Returns boolean

isXAxisRestFrameActive

• get isXAxisRestFrameActive(): boolean

• Returns boolean

isXAxisRestFrameSupported

• get isXAxisRestFrameSupported(): boolean

• Returns boolean

isYAxisRestFrameActive

• get isYAxisRestFrameActive(): boolean

• Returns boolean

isYAxisRestFrameSupported

• get isYAxisRestFrameSupported(): boolean

• Returns boolean

momentRegionInfo

• get momentRegionInfo(): string | undefined

• Returns string | undefined

momentRegionOptions

• get momentRegionOptions(): OptionProps[]

• Returns OptionProps[]

plotData

• get plotData(): MultiPlotData | null

• Returns MultiPlotData | null

profileNum

• get profileNum(): number

• Returns number

redshiftFactor

• get redshiftFactor(): number

• Returns number

restFrameCorrectionExportComments

• get restFrameCorrectionExportComments(): string[]

• Returns string[]

restFrameRadialVelocity

• get restFrameRadialVelocity(): number

• Returns number

secondarySpectralUnitLabel

• get secondarySpectralUnitLabel(): string

• Returns string

selectedRange

• get selectedRange(): { center: number; isHorizontal: boolean; width: number } | null

• Returns { center: number; isHorizontal: boolean; width: number } | null

spectralUnitLabel

• get spectralUnitLabel(): string

• Returns string

transformedSpectralLines

• get transformedSpectralLines(): SpectralLine[]

• Returns SpectralLine[]

xAxisLabel

• get xAxisLabel(): string | undefined

• Returns string | undefined

yAxisLabel

• get yAxisLabel(): string | undefined

• Returns string | undefined

yAxisRestFrameScale

• get yAxisRestFrameScale(): number

• Returns number

yUnit

• get yUnit(): string | undefined

• Returns string | undefined

yUnitLabel

• get yUnitLabel(): string | undefined

• Returns string | undefined

Methods

addSpectralLines

• addSpectralLines(spectralLines: SpectralLine[]): void

• Parameters

  • spectralLines: SpectralLine[]

  Returns void

publicapplyConfig

• applyConfig(widgetSettings: any): void

• Parameters

  • widgetSettings: any

  Returns void

inheritedclearFrameEntry

• clearFrameEntry(fileId: number): void

• Inherited from RegionWidgetStore.clearFrameEntry

  Parameters

  • fileId: number

  Returns void

clearMomentRangeSelectingMode

• clearMomentRangeSelectingMode(): void

• Returns void

clearProfileColors

• clearProfileColors(): void

• Returns void

inheritedclearRegionMap

• clearRegionMap(): void

• Inherited from RegionWidgetStore.clearRegionMap

  Returns void

clearSelectedMoments

• clearSelectedMoments(): void

• Returns void

clearSpectralLines

• clearSpectralLines(): void

• Returns void

clearXBounds

• clearXBounds(): void

• Returns void

clearXYBounds

• clearXYBounds(): void

• Returns void

clearYBounds

• clearYBounds(): void

• Returns void

publicconvertDisplayXToObserved

• convertDisplayXToObserved(value: number, spectralType?: string | null | undefined, spectralUnit?: SpectralUnit | null | undefined): number

• Parameters

  • value: number

  • spectralType: string | null | undefined = ...

  • spectralUnit: SpectralUnit | null | undefined = ...

  Returns number

publicconvertDisplayYToObserved

• convertDisplayYToObserved(value: number): number

• Parameters

  • value: number

  Returns number

publicconvertObservedXToDisplay

• convertObservedXToDisplay(value: number, spectralType?: string | null | undefined, spectralUnit?: SpectralUnit | null | undefined): number

• Parameters

  • value: number

  • spectralType: string | null | undefined = ...

  • spectralUnit: SpectralUnit | null | undefined = ...

  Returns number

publicconvertObservedYToDisplay

• convertObservedYToDisplay(value: number): number

• Parameters

  • value: number

  Returns number

deselectMoment

• deselectMoment(deselected: Moment): void

• Delete moments to generate maps.

  ---

  Parameters

  • deselected: Moment

    Moment in CARTA.Moment.

  Returns void

publicdispose

• dispose(): void

• Returns void

getProfileColor

• getProfileColor(lineKey: LineKey): string | undefined

• Parameters

  • lineKey: LineKey

  Returns string | undefined

initXYBoundaries

• initXYBoundaries(minXVal: number | undefined, maxXVal: number | undefined, minYVal: number | undefined, maxYVal: number | undefined): void

• Parameters

  • minXVal: number | undefined

  • maxXVal: number | undefined

  • minYVal: number | undefined

  • maxYVal: number | undefined

  Returns void

isMomentSelected

• isMomentSelected(momentType: Moment): boolean

• Parameters

  • momentType: Moment

  Returns boolean

removeMomentByIndex

• removeMomentByIndex(removeIndex: number): void

• Parameters

  • removeIndex: number

  Returns void

removeProfileColor

• removeProfileColor(lineKey: LineKey): void

• Parameters

  • lineKey: LineKey

  Returns void

requestingMomentCancelled

• requestingMomentCancelled(): void

• Cancel the moment maps request.

  ---

  Returns void

requestMoment

• requestMoment(): void

• Request the moment maps.

  ---

  Returns void

publicselectFrame

• selectFrame(fileId: number): void

• Parameters

  • fileId: number

  Returns void

selectMoment

• selectMoment(selected: Moment): void

• Add moments to generate maps.

  ---

  Parameters

  • selected: Moment

    Moment in CARTA.Moment.

  Returns void

selectMomentRegion

• selectMomentRegion(regionId: number): void

• Select region for generating moment maps.

  ---

  Parameters

  • regionId: number

    Region ID number.

  Returns void

setChannel

• setChannel(channel: number): void

• Parameters

  • channel: number

  Returns void

setCursor

• setCursor(cursorVal: number): void

• Parameters

  • cursorVal: number

  Returns void

inheritedsetFileId

• setFileId(fileId: number): void

• Inherited from RegionWidgetStore.setFileId

  Parameters

  • fileId: number

  Returns void

setHighlighted

• setHighlighted(isHighlighted: boolean): void

• Parameters

  • isHighlighted: boolean

  Returns void

setKeep

• setKeep(shouldKeep: boolean): void

• Keep previous moment maps.

  ---

  Parameters

  • shouldKeep: boolean

    A boolean. Set true to keep previous moment maps.

  Returns void

setLinePlotPointSize

• setLinePlotPointSize(val: number): void

• Parameters

  • val: number

  Returns void

setLineWidth

• setLineWidth(val: number): void

• Parameters

  • val: number

  Returns void

setMarkerTextVisible

• setMarkerTextVisible(isMarkerTextVisible: boolean): void

• Parameters

  • isMarkerTextVisible: boolean

  Returns void

setMeanRmsVisible

• setMeanRmsVisible(isMeanRmsVisible: boolean): void

• Parameters

  • isMeanRmsVisible: boolean

  Returns void

setMomentMask

• setMomentMask(momentMask: MomentMask): void

• Mask for generating moment maps.

  ---

  Parameters

  • momentMask: MomentMask

    enum CARTA.MomentMask.

  Returns void

setMomentRangeSelectingMode

• setMomentRangeSelectingMode(mode: MomentSelectingMode): void

• Parameters

  • mode: MomentSelectingMode

  Returns void

setMouseMoveIntoLinePlots

• setMouseMoveIntoLinePlots(isMouseMoveIntoLinePlots: boolean): void

• Parameters

  • isMouseMoveIntoLinePlots: boolean

  Returns void

setMultiProfileIntensityUnit

• setMultiProfileIntensityUnit(intensityUnitStr: string | undefined): void

• Parameters

  • intensityUnitStr: string | undefined

  Returns void

setPlotType

• setPlotType(val: PlotType): void

• Parameters

  • val: PlotType

  Returns void

setProfileColor

• setProfileColor(lineKey: LineKey, color: string): void

• Parameters

  • lineKey: LineKey

  • color: string

  Returns void

setRegionId

• setRegionId(fileId: number, regionId: number): void

• Overrides RegionWidgetStore.setRegionId

  Set region for the spectral profiler.

  ---

  Parameters

  • fileId: number

    File ID number.

  • regionId: number

    Region ID number.

  Returns void

setRestFrameRadialVelocity

• setRestFrameRadialVelocity(velocityKms: number): void

• Parameters

  • velocityKms: number

  Returns void

setRestFrameRedshift

• setRestFrameRedshift(redshift: number): void

• Parameters

  • redshift: number

  Returns void

setRestFrameShift

• setRestFrameShift(value: number): boolean

• Parameters

  • value: number

  Returns boolean

setRestFrameShiftInputValid

• setRestFrameShiftInputValid(isValid: boolean): void

• Parameters

  • isValid: boolean

  Returns void

setRestFrameShiftMode

• setRestFrameShiftMode(mode: RestFrameShiftMode): void

• Parameters

  • mode: RestFrameShiftMode

  Returns void

setRestFrameVelocityConvention

• setRestFrameVelocityConvention(convention: VelocityConvention): void

• Parameters

  • convention: VelocityConvention

  Returns void

setSecondaryAxisCursorInfoVisible

• setSecondaryAxisCursorInfoVisible(isSecondaryAxisCursorInfoVisible: boolean): void

• Parameters

  • isSecondaryAxisCursorInfoVisible: boolean

  Returns void

setSelectedChannelRange

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

• Set the channel range for generating moment maps.

  ---

  Parameters

  • min: number

    Number of first channel.

  • max: number

    Number of last channel.

  Returns void

setSelectedDisplayChannelRange

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

• Parameters

  • min: number

  • max: number

  Returns void

setSelectedDisplayMaskRange

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

• Parameters

  • min: number

  • max: number

  Returns void

setSelectedMaskRange

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

• Parameters

  • min: number

  • max: number

  Returns void

setSettingsTabId

• setSettingsTabId(tabId: SpectralProfilerSettingsTabs): void

• Parameters

  • tabId: SpectralProfilerSettingsTabs

  Returns void

setSpectralCoordinate

• setSpectralCoordinate(coordStr: string): void

• Set spectral coordinates.

  ---

  Parameters

  • coordStr: string

    A string of

    <i>

    Spectral type (unit)

    </i>

    like Frequency (GHz).

  Returns void

setSpectralCoordinateSecondary

• setSpectralCoordinateSecondary(coordStr: string): void

• Parameters

  • coordStr: string

  Returns void

setSpectralSystem

• setSpectralSystem(specsys: SpectralSystem): void

• Set the spectral system.

  ---

  Parameters

  • specsys: SpectralSystem

    Spectral system SpectralSystem.

  Returns void

setXAxisRestFrameEnabled

• setXAxisRestFrameEnabled(isEnabled: boolean): void

• Parameters

  • isEnabled: boolean

  Returns void

setXBounds

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

• Parameters

  • minVal: number

  • maxVal: number

  Returns void

setXYBounds

• setXYBounds(minX: number, maxX: number, minY: number, maxY: number): void

• Parameters

  • minX: number

  • maxX: number

  • minY: number

  • maxY: number

  Returns void

setYAxisRestFrameEnabled

• setYAxisRestFrameEnabled(isEnabled: boolean): void

• Parameters

  • isEnabled: boolean

  Returns void

setYBounds

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

• Parameters

  • minVal: number

  • maxVal: number

  Returns void

publictoConfig

• toConfig(): { linePlotPointSize: number; lineWidth: number; maxXVal: number | undefined; maxYVal: number | undefined; meanRmsVisible: boolean; minXVal: number | undefined; minYVal: number | undefined; plotType: PlotType; primaryLineColor: string; restFrameRedshift: number; restFrameShiftMode: RestFrameShiftMode; restFrameVelocityConvention: VelocityConvention; xAxisRestFrameEnabled: boolean; yAxisRestFrameEnabled: boolean }

• Returns { linePlotPointSize: number; lineWidth: number; maxXVal: number | undefined; maxYVal: number | undefined; meanRmsVisible: boolean; minXVal: number | undefined; minYVal: number | undefined; plotType: PlotType; primaryLineColor: string; restFrameRedshift: number; restFrameShiftMode: RestFrameShiftMode; restFrameVelocityConvention: VelocityConvention; xAxisRestFrameEnabled: boolean; yAxisRestFrameEnabled: boolean }

  • linePlotPointSize: number

  • lineWidth: number

  • maxXVal: number | undefined

  • maxYVal: number | undefined

  • meanRmsVisible: boolean

  • minXVal: number | undefined

  • minYVal: number | undefined

  • plotType: PlotType

  • primaryLineColor: string

  • restFrameRedshift: number

  • restFrameShiftMode: RestFrameShiftMode

  • restFrameVelocityConvention: VelocityConvention

  • xAxisRestFrameEnabled: boolean

  • yAxisRestFrameEnabled: boolean

updateStreamingDataStatus

• updateStreamingDataStatus(isStreamingData: boolean): void

• Parameters

  • isStreamingData: boolean

  Returns void

publicstaticinheritedcalculateRequirementsArray

• calculateRequirementsArray(widgetsMap: Map<string, RegionWidgetStore>): Map<number, number[]>

• Inherited from RegionWidgetStore.calculateRequirementsArray

  Parameters

  • widgetsMap: Map<string, RegionWidgetStore>

  Returns Map<number, number[]>

publicstaticcalculateRequirementsMap

• calculateRequirementsMap(widgetsMap: Map<string, SpectralProfileWidgetStore>): Map<number, Map<number, SetSpectralRequirements>>

• Parameters

  • widgetsMap: Map<string, SpectralProfileWidgetStore>

  Returns Map<number, Map<number, SetSpectralRequirements>>

publicstaticdiffSpectralRequirements

• diffSpectralRequirements(originalRequirements: Map<number, Map<number, SetSpectralRequirements>>, updatedRequirements: Map<number, Map<number, SetSpectralRequirements>>): SetSpectralRequirements[]

• Parameters

  • originalRequirements: Map<number, Map<number, SetSpectralRequirements>>

  • updatedRequirements: Map<number, Map<number, SetSpectralRequirements>>

  Returns SetSpectralRequirements[]