Skip to main content
Version: Next

FrameStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

animationChannelRange

animationChannelRange: NumberRange

center

center: Point2D

View center in pixel coordinates

channel

channel: number

channelSecondaryValues

channelSecondaryValues: number[]

channelValues

channelValues: number[]

colorbarLabelCustomText

colorbarLabelCustomText: string

publicreadonlycolorbarStore

colorbarStore: ColorbarStore

publicreadonlycontourConfig

contourConfig: ContourConfigStore

contourStores

contourStores: Map<number, ContourStore>

currentCompressionQuality

currentCompressionQuality: number

currentFrameView

currentFrameView: FrameView

cursorInfo

cursorInfo: CursorInfo

cursorMoving

cursorMoving: boolean

cursorValue

cursorValue: { channel: number; position: Point2D; value: number }

Type declaration

  • channel: number
  • position: Point2D
  • value: number

publicreadonlydefaultWcsSystem

defaultWcsSystem: SystemType

fittingLog

fittingLog: string

fittingModelImage

fittingModelImage: FrameStore

fittingResidualImage

fittingResidualImage: FrameStore

fittingResult

fittingResult: string

fittingResultRegionParams

fittingResultRegionParams: { points: Point2D[]; rotation: number }[]

publicframeInfo

frameInfo: FrameInfo

generatedPVRegionId

generatedPVRegionId: number

intensityUnit

intensityUnit: string

isOffsetCoord

isOffsetCoord: boolean

isRequestPVCancelling

isRequestPVCancelling: boolean

isRequestingMoments

isRequestingMoments: boolean

isRequestingPV

isRequestingPV: boolean

momentImages

momentImages: FrameStore[]

moving

moving: boolean

offsetCenter

offsetCenter: Point2D

View center for the relative coordinate in pixel coordinates

overlayBeamSettings

overlayBeamSettings: OverlayBeamStore

publicreadonlypixelUnitSizeArcsec

pixelUnitSizeArcsec: Point2D

publicpointShapeCache

pointShapeCache: PointAnnotationShape

previewPVRasterData

previewPVRasterData: Float32Array

previewViewHeight

previewViewHeight: number

previewViewWidth

previewViewWidth: number

pvImages

pvImages: FrameStore[]

rasterScalingReference

rasterScalingReference: FrameStore

publicreadonlyrenderConfig

renderConfig: RenderConfigStore

requestingMomentsProgress

requestingMomentsProgress: number

requestingPVProgress

requestingPVProgress: number

requiredChannel

requiredChannel: number

publicrequiredFrameViewForRegionRender

requiredFrameViewForRegionRender: FrameView

requiredStokes

requiredStokes: number

publicrestFreqStore

restFreqStore: RestFreqStore

secondaryRasterScalingImages

secondaryRasterScalingImages: FrameStore[]

secondarySpatialImages

secondarySpatialImages: FrameStore[]

secondarySpectralImages

secondarySpectralImages: FrameStore[]

spatialReference

spatialReference: FrameStore

publicspatialTransformAST

spatialTransformAST: Mapping

publicspectralCoordsSupported

spectralCoordsSupported: Map<string, { type: SpectralType; unit: SpectralUnit }>

spectralReference

spectralReference: FrameStore

spectralSystem

spectralSystem: SpectralSystem

publicspectralSystemsSupported

spectralSystemsSupported: SpectralSystem[]

spectralType

spectralType: SpectralType

spectralTypeSecondary

spectralTypeSecondary: SpectralType

spectralUnit

spectralUnit: SpectralUnit

spectralUnitSecondary

spectralUnitSecondary: SpectralUnit

stokes

stokes: number

stokesFiles

stokesFiles: StokesFile[]

titleCustomText

titleCustomText: string

publicupdatePreviewDataGenerator

updatePreviewDataGenerator: Generator<unknown, any, unknown>

publicreadonlyvalidWcs

validWcs: boolean

publicreadonlyvectorOverlayConfig

vectorOverlayConfig: VectorOverlayConfigStore

publicreadonlyvectorOverlayStore

vectorOverlayStore: VectorOverlayStore

publicwcsInfo

wcsInfo: FrameSet

publicreadonlywcsInfo3D

wcsInfo3D: FrameSet

publicreadonlywcsInfoForTransformation

wcsInfoForTransformation: FrameSet

publicwcsInfoShifted

wcsInfoShifted: FrameSet

zoomLevel

zoomLevel: number

zooming

zooming: boolean

Accessors

aspectRatio

  • get aspectRatio(): number

  • Returns number

beamAllChannels

  • get beamAllChannels(): IBeam[]

  • Returns IBeam[]

beamProperties

  • get beamProperties(): { angle: number; majorAxis: number; minorAxis: number; overlayBeamSettings: OverlayBeamStore; x: number; y: number }

  • Returns { angle: number; majorAxis: number; minorAxis: number; overlayBeamSettings: OverlayBeamStore; x: number; y: number }

    • angle: number
    • majorAxis: number
    • minorAxis: number
    • overlayBeamSettings: OverlayBeamStore
    • x: number
    • y: number

centerMovement

centerWCS

channelInfo

channelType

  • get channelType(): string

  • Returns string

channelValueBounds

  • get channelValueBounds(): FloatBounds

  • Returns FloatBounds

contourProgress

  • get contourProgress(): number

  • Returns number

coordinateOptions

  • get coordinateOptions(): { label: string; value: string }[]

  • Returns { label: string; value: string }[]

coordinateOptionsZ

  • get coordinateOptionsZ(): { label: string; value: string }[]

  • Returns { label: string; value: string }[]

depthAxisInfo

  • get depthAxisInfo(): string

  • Returns string

depthNumber

  • get depthNumber(): number

  • Returns number

dimension

  • get dimension(): string

  • Returns string

dirX

  • get dirX(): number

  • Returns number

dirXLabel

  • get dirXLabel(): string

  • Returns string

dirXNumber

  • get dirXNumber(): number

  • Returns number

dirY

  • get dirY(): number

  • Returns number

dirYLabel

  • get dirYLabel(): string

  • Returns string

dirYNumber

  • get dirYNumber(): number

  • Returns number

filename

  • get filename(): string

  • Returns string

fovSize

fovSizeWCS

hasLinearStokes

  • get hasLinearStokes(): boolean

  • Returns boolean

hasSquarePixels

  • get hasSquarePixels(): boolean

  • Returns boolean

hasStokes

  • get hasStokes(): boolean

  • Returns boolean

hasVisibleBeam

  • get hasVisibleBeam(): boolean

  • Returns boolean

headerRestFreq

  • get headerRestFreq(): number

  • Returns number

headerUnit

  • get headerUnit(): string

  • Returns string

id

  • get id(): number

  • The unique identifier of the frame.

    Returns number

intensityConfig

isCoordChannel

  • get isCoordChannel(): boolean

  • Returns boolean

isCoordChannelSecondary

  • get isCoordChannelSecondary(): boolean

  • Returns boolean

isCoordVelocity

  • get isCoordVelocity(): boolean

  • Returns boolean

isCursorValueCurrent

  • get isCursorValueCurrent(): boolean

  • Returns boolean

isPVImage

  • get isPVImage(): boolean

  • Returns boolean

isPreview

  • get isPreview(): boolean

  • Returns boolean

isRenderable

  • get isRenderable(): boolean

  • Returns boolean

isRestFreqEditable

  • get isRestFreqEditable(): boolean

  • Returns boolean

isSecondarySpectralPropsEqual

  • get isSecondarySpectralPropsEqual(): boolean

  • Returns boolean

isSpectralChannel

  • get isSpectralChannel(): boolean

  • Returns boolean

isSpectralCoordinateConvertible

  • get isSpectralCoordinateConvertible(): boolean

  • Returns boolean

isSpectralPropsEqual

  • get isSpectralPropsEqual(): boolean

  • Returns boolean

isSpectralSystemConvertible

  • get isSpectralSystemConvertible(): boolean

  • Returns boolean

isSwappedZ

  • get isSwappedZ(): boolean

  • Returns boolean

isUVImage

  • get isUVImage(): boolean

  • Returns boolean

isXY

  • get isXY(): boolean

  • Returns boolean

isYX

  • get isYX(): boolean

  • Returns boolean

maxMip

  • get maxMip(): number

  • Returns number

nativeSpectralCoordinate

  • get nativeSpectralCoordinate(): string

  • Returns string

numChannels

  • get numChannels(): number

  • Returns number

offsetCenterWCS

polarizationInfo

  • get polarizationInfo(): string[]

  • Returns string[]

polarizations

previewCursorValue

  • get previewCursorValue(): { channel: number; position: Point2D; value: number }

  • Returns { channel: number; position: Point2D; value: number }

    • channel: number
    • position: Point2D
    • value: number

regionSet

renderConfigSiblings

renderHeight

  • get renderHeight(): number

  • Returns number

renderWidth

  • get renderWidth(): number

  • Returns number

renderedAxesNumbers

  • get renderedAxesNumbers(): [number, number]

  • Returns [number, number]

requiredFrameView

requiredPolarization

  • get requiredPolarization(): number

  • Returns number

requiredPolarizationIndex

  • get requiredPolarizationIndex(): number

  • Returns number

requiredPolarizationInfo

  • get requiredPolarizationInfo(): string

  • Returns string

requiredUnit

  • get requiredUnit(): string

  • Returns string

sharedRegions

  • get sharedRegions(): boolean

  • Returns boolean

spatialSiblings

spatialTransform

spectral

  • get spectral(): number

  • Returns number

spectralAxis

  • get spectralAxis(): { specsys: string; type: SpectralTypeSet; valid: boolean; value: number }

spectralCoordinate

  • get spectralCoordinate(): string

  • Returns string

spectralCoordinateSecondary

  • get spectralCoordinateSecondary(): string

  • Returns string

spectralInfo

spectralLabel

  • get spectralLabel(): string

  • Returns string

spectralNumber

  • get spectralNumber(): number

  • Returns number

spectralSiblings

spectralUnitStr

  • get spectralUnitStr(): string

  • Returns string

stokesInfo

  • get stokesInfo(): string[]

  • Returns string[]

stokesNumber

  • get stokesNumber(): number

  • Returns number

stokesOptions

  • get stokesOptions(): { label: string; value: number }[]

  • Returns { label: string; value: number }[]

transformedWcsInfo

  • get transformedWcsInfo(): any

  • Returns any

unitFrameView

uvAxis

  • get uvAxis(): number

  • Returns number

Methods

addFittingModelImage

addFittingResidualImage

addMomentImage

addPvImage

addSecondaryRasterScalingImage

  • addSecondaryRasterScalingImage(frame: FrameStore): void

addSecondarySpatialImage

addSecondarySpectralImage

  • addSecondarySpectralImage(frame: FrameStore): void

applyContours

  • applyContours(): void

  • Returns void

applyVectorOverlay

  • applyVectorOverlay(): void

  • Returns void

clearContours

  • clearContours(updateBackend?: boolean): void

  • Parameters

    • updateBackend: boolean = true

    Returns void

clearRasterScalingReference

  • clearRasterScalingReference(): void

  • Returns void

clearSpatialReference

  • clearSpatialReference(): void

  • Returns void

clearSpectralReference

  • clearSpectralReference(): void

  • Returns void

clearVectorOverlay

  • clearVectorOverlay(updateBackend?: boolean): void

  • Parameters

    • updateBackend: boolean = true

    Returns void

publicconvertFreqMHzToSettingWCS

  • convertFreqMHzToSettingWCS(value: number): number

  • Parameters

    • value: number

    Returns number

publicconvertToNativeWCS

  • convertToNativeWCS(value: number): number

  • Parameters

    • value: number

    Returns number

endMoving

  • endMoving(): void

  • Returns void

publicfindChannelIndexByValue

  • findChannelIndexByValue(x: number): number

  • Parameters

    • x: number

    Returns number

fitZoom

  • fitZoom(): number

  • Returns number

publicgenRegionWcsProperties

  • genRegionWcsProperties(regionType: RegionType, controlPoints: Point2D[], rotation: number, regionId?: number): string

  • Parameters

    • regionType: RegionType
    • controlPoints: Point2D[]
    • rotation: number
    • regionId: number = -1

    Returns string

publicgetCatalogControlMap

publicgetControlMap

publicgetCursorInfo

  • getCursorInfo(cursorPosImageSpace: Point2D): { infoWCS: any; isInsideImage: boolean; posImageSpace: Point2D; posWCS: any; precision: { x: number; y: number } }

  • Parameters

    Returns { infoWCS: any; isInsideImage: boolean; posImageSpace: Point2D; posWCS: any; precision: { x: number; y: number } }

    • infoWCS: any
    • isInsideImage: boolean
    • posImageSpace: Point2D
    • posWCS: any
    • precision: { x: number; y: number }
      • x: number
      • y: number

getImagePosFromWCS

  • Converts positions from WCS coordinates to image coordinates.

    Parameters

    • wcsList: WCSPoint2D[]

      An array of positions in WCS coordinates.

    Returns Point2D[]

    An array of corresponding positions in image coordinates.

publicgetImageXValueFromArcsec

  • getImageXValueFromArcsec(arcsecValue: number): number

  • Parameters

    • arcsecValue: number

    Returns number

publicgetImageYValueFromArcsec

  • getImageYValueFromArcsec(arcsecValue: number): number

  • Parameters

    • arcsecValue: number

    Returns number

publicgetRegion

publicgetRegionProperties

  • getRegionProperties(regionId: number): string[]

  • Parameters

    • regionId: number

    Returns string[]

publicgetRegionWcsProperties

getWCSFromImagePos

  • Converts positions from image coordinates to WCS coordinates.

    Parameters

    • posList: Point2D[]

      An array of positions in image coordinates.

    Returns WCSPoint2D[]

    An array of corresponding positions in WCS coordinates.

publicgetWcsSizeInArcsec

incrementChannels

  • incrementChannels(deltaChannel: number, deltaStokes: number, wrap?: boolean): void

  • Parameters

    • deltaChannel: number
    • deltaStokes: number
    • wrap: boolean = true

    Returns void

onResizePreviewWidget

  • onResizePreviewWidget(width: number, height: number): void

  • Parameters

    • width: number
    • height: number

    Returns void

publicremoveCatalogControlMap

publicremoveControlMap

removeMomentImage

  • removeMomentImage(): void

  • Returns void

removePvImage

  • removePvImage(): void

  • Returns void

removeSecondaryRasterScalingImage

  • removeSecondaryRasterScalingImage(frame: FrameStore): void

removeSecondarySpatialImage

  • removeSecondarySpatialImage(frame: FrameStore): void

removeSecondarySpectralImage

  • removeSecondarySpectralImage(frame: FrameStore): void

resetFitting

  • resetFitting(): void

  • Returns void

resetMomentRequestState

  • resetMomentRequestState(): void

  • Returns void

resetPvRequestState

  • resetPvRequestState(): void

  • Returns void

setAnimationRange

  • setAnimationRange(range: NumberRange): void

  • Parameters

    • range: NumberRange

    Returns void

setCenter

  • setCenter(x: number, y: number, enableSpatialTransform?: boolean): boolean

  • Set the view center in the pixel coordinates.

    Parameters

    • x: number

      x-axis value in the pixel coordinates.

    • y: number

      y-axis value in the pixel coordinates.

    • enableSpatialTransform: boolean = true

      enable spatial coordinates transform.

    Returns boolean

    • true if offset center is setted succesfully

setCenterWcs

  • setCenterWcs(wcsX: string, wcsY: string): boolean

  • Set the view center in WCS coordinate.

    Parameters

    • wcsX: string

      x-axis value in the WCS coordinate

    • wcsY: string

      y-axis value in the WCS coordinate

    Returns boolean

    • false

setChannel

  • setChannel(channel: number, recursive?: boolean): void

  • Sets the channel of the frame.

    Parameters

    • channel: number

      The channel index to set.

    • recursive: boolean = true

      Whether to update channels of spectrally matched frames.

    Returns void

setChannels

  • setChannels(channel: number, stokes: number, recursive: boolean): void

  • Sets the channel and the Stokes parameter of the frame.

    Parameters

    • channel: number

      The channel index to set.

    • stokes: number

      The Stokes parameter to set. Standard polarization requires the polarization index (eg. "I": 0). Computed polarization requires the polarization value (eg. "Pangle": 17).

    • recursive: boolean

      Whether to update channels of spectrally matched frames.

    Returns void

setColorbarLabelCustomText

  • setColorbarLabelCustomText(text: string): void

  • Parameters

    • text: string

    Returns void

setCursorPosition

  • setCursorPosition(posImageSpace: Point2D): void

  • Parameters

    Returns void

setCursorValue

  • setCursorValue(position: Point2D, channel: number, value: number): void

  • Parameters

    • position: Point2D
    • channel: number
    • value: number

    Returns void

setFittingLog

  • setFittingLog(log: string): void

  • Parameters

    • log: string

    Returns void

setFittingResult

  • setFittingResult(results: string): void

  • Parameters

    • results: string

    Returns void

setFittingResultRegionParams

  • setFittingResultRegionParams(params: { points: Point2D[]; rotation: number }[]): void

  • Parameters

    • params: { points: Point2D[]; rotation: number }[]

    Returns void

setFrameInfo

setGeneratedPVRegionId

  • setGeneratedPVRegionId(regionId: number): void

  • Parameters

    • regionId: number

    Returns void

setIntensityUnit

  • setIntensityUnit(intensityUnitStr: string): void

  • Parameters

    • intensityUnitStr: string

    Returns void

setIsRequestPVCancelling

  • setIsRequestPVCancelling(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setIsRequestingMoments

  • setIsRequestingMoments(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setIsRequestingPV

  • setIsRequestingPV(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setOffsetCenter

  • setOffsetCenter(x: number, y: number, enableSpatialTransform?: boolean): boolean

  • Set the offset center and update the displayed coordinates.

    Parameters

    • x: number

      x-axis value in the pixel coordinates.

    • y: number

      y-axis value in the pixel coordinates.

    • enableSpatialTransform: boolean = true

      enable spatial coordinates transform.

    Returns boolean

    • true if offset center is setted succesfully

setOffsetCenterWcs

  • setOffsetCenterWcs(wcsX: string, wcsY: string): boolean

  • Set the offset center in WCS coordinates.

    Parameters

    • wcsX: string

      x-axis value in the WCS coordinates.

    • wcsY: string

      y-axis value in the WCS coordinates.

    Returns boolean

    • false

setPreviewPVRasterData

  • setPreviewPVRasterData(previewPVRasterData: Float32Array, skipUpdatePreviewData?: boolean): void

  • Parameters

    • previewPVRasterData: Float32Array
    • skipUpdatePreviewData: boolean = false

    Returns void

setRasterScalingReference

  • setRasterScalingReference(frame: FrameStore): void

setSpatialReference

setSpectralCoordinate

  • setSpectralCoordinate(coordStr: string, alignSpectralSiblings?: boolean): boolean

  • Parameters

    • coordStr: string
    • alignSpectralSiblings: boolean = true

    Returns boolean

setSpectralCoordinateSecondary

  • setSpectralCoordinateSecondary(coordStr: string, alignSpectralSiblings?: boolean): boolean

  • Parameters

    • coordStr: string
    • alignSpectralSiblings: boolean = true

    Returns boolean

setSpectralCoordinateToRadioVelocity

  • setSpectralCoordinateToRadioVelocity(): void

  • Returns void

setSpectralReference

setSpectralSystem

  • setSpectralSystem(spectralSystem: SpectralSystem, alignSpectralSiblings?: boolean): boolean

  • Parameters

    Returns boolean

setStokes

  • setStokes(polarization: POLARIZATIONS, recursive?: boolean): void

  • Sets the Stokes parameter of the frame. Required for carta-python. If the provided polarization value is not found in the frame, the function will return without making any changes.

    Parameters

    • polarization: POLARIZATIONS

      The polarization value.

    • recursive: boolean = false

      Whether to update channels of spectrally matched frames.

    Returns void

setStokesByIndex

  • setStokesByIndex(polarizationIndex: number, recursive?: boolean): void

  • Sets the Stokes parameter of the frame by the index. If the provided polarizationIndex is not a valid index or exceeds the range, the function will return without making any changes.

    Parameters

    • polarizationIndex: number

      The index of the polarization value.

    • recursive: boolean = false

      Whether to update channels of spectrally matched frames.

    Returns void

setStokesFiles

  • setStokesFiles(stokesFiles: StokesFile[]): void

  • Parameters

    • stokesFiles: StokesFile[]

    Returns void

setTitleCustomText

  • setTitleCustomText(text: string): void

  • Parameters

    • text: string

    Returns void

setZoom

  • setZoom(zoom: number, absolute?: boolean): void

  • Parameters

    • zoom: number
    • absolute: boolean = false

    Returns void

startMoving

  • startMoving(): void

  • Returns void

toggleOffsetCoord

  • toggleOffsetCoord(): void

  • Toggle of the offset coordinates. This function initially sets the current view center (instead of the image center) as the offset center.

    Returns void

updateCursorRegion

  • updateCursorRegion(pos: Point2D): void

updateFromContourData

  • updateFromContourData(contourImageData: ContourImageData): void

  • Parameters

    • contourImageData: ContourImageData

    Returns void

updateFromVectorOverlayData

  • updateFromVectorOverlayData(vectorOverlayData: IVectorOverlayTileData): void

  • Parameters

    • vectorOverlayData: IVectorOverlayTileData

    Returns void

updateOffsetCenter

  • updateOffsetCenter(): void

  • Returns void

publicupdatePreviewData

  • updatePreviewData(previewData: PvPreviewData): Generator<void, void, unknown>

  • Parameters

    • previewData: PvPreviewData

    Returns Generator<void, void, unknown>

updateRequestingMomentsProgress

  • updateRequestingMomentsProgress(progress: number): void

  • Parameters

    • progress: number

    Returns void

updateRequestingPvProgress

  • updateRequestingPvProgress(progress: number): void

  • Parameters

    • progress: number

    Returns void

publicupdateSpectralVsDirectionWcs

  • updateSpectralVsDirectionWcs(): void

  • Returns void

updateWcsSystem

  • updateWcsSystem(formatStringX: string, formatStyingY: string, explicitSystem: SystemType): void

  • Parameters

    • formatStringX: string
    • formatStyingY: string
    • explicitSystem: SystemType

    Returns void

zoomToPoint

  • zoomToPoint(x: number, y: number, zoom: number, absolute?: boolean): void

  • Parameters

    • x: number
    • y: number
    • zoom: number
    • absolute: boolean = false

    Returns void

zoomToSizeX

  • zoomToSizeX(x: number): boolean

  • Parameters

    • x: number

    Returns boolean

zoomToSizeXWcs

  • zoomToSizeXWcs(wcsX: string): boolean

  • Parameters

    • wcsX: string

    Returns boolean

zoomToSizeY

  • zoomToSizeY(y: number): boolean

  • Parameters

    • y: number

    Returns boolean

zoomToSizeYWcs

  • zoomToSizeYWcs(wcsY: string): boolean

  • Parameters

    • wcsY: string

    Returns boolean