Skip to main content
Version: 5.0.0

ImageFittingStore

Manages the state and logic for multiple Gaussian image fitting.

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

backgroundOffset

backgroundOffset: number = 0

Constant background offset.

backgroundOffsetFixed

backgroundOffsetFixed: boolean = true

Indicates whether to fix the background offset when fitting.

components

components: ImageFittingIndividualStore[]

Stores the initial values and fixed flags for each Gaussian component.

createModelImage

createModelImage: boolean = true

Indicates whether to generate a model image when requesting for fitting.

createResidualImage

createResidualImage: boolean = true

Indicates whether to generate a residual image when requesting for fitting.

isAutoInitVal

isAutoInitVal: boolean = true

Indicates whether to auto‑generate initial values when requesting for fitting.

isCancelling

isCancelling: boolean = false

Whether cancel is in progress.

isFitting

isFitting: boolean = false

Whether a fitting request is currently being processed.

progress

progress: number = 0

Progress of the current fitting request, from 0 to 1 (multiply by 100 for %).

selectedComponentIndex

selectedComponentIndex: number

Index of the component currently selected in the UI.

selectedFileId

selectedFileId: number = ACTIVE_FILE_ID

ID of the file currently selected for fitting.

selectedRegionId

selectedRegionId: number = FOV_REGION_ID

ID of the region currently selected for fitting. Set to 0 for the current field of view, or -1 for the full image.

solverType

solverType: FittingSolverType = CARTA.FittingSolverType.Cholesky

Solver used for fitting.

Accessors

effectiveFrame

fitDisabled

  • get fitDisabled(): boolean

  • Whether fitting is disabled due to an invalid file ID, all parameters being fixed, invalid initial values, or fitting in progress.

    Returns boolean

fixedParamsNum

  • get fixedParamsNum(): number

  • The total number of fixed parameters across all Gaussian parameters. Returns 0 if automatic initial-value generation is enabled.

    Returns number

frameOptions

  • get frameOptions(): OptionProps<string | number>[]

  • The available file frame options for selection, including the active file.

    Returns OptionProps<string | number>[]

regionOptions

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

  • The available region options including the field of view, entire image, and all closed, non-temporary regions.

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

solverOptions

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

  • Available fitting solver options shown in the UI. MCholesky is excluded because it is not supported in all GSL versions.

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

validParams

  • get validParams(): boolean

  • Whether all input initial values are valid. Returns true if automatic initial-value generation is enabled.

    Returns boolean

staticInstance

Methods

cancelFitting

  • cancelFitting(): void

  • Cancels a fitting request if the progress is incomplete and updates the cancelling status.

    Returns void

clearComponents

  • clearComponents(): void

  • Resets settings to defaults.

    Returns void

createRegions

  • createRegions(): Promise<void>

  • Creates ellipse regions on the selected image based on the fitting results.

    Returns Promise<void>

deleteSelectedComponent

  • deleteSelectedComponent(): void

  • Removes the currently selected component (if more than one remains).

    Returns void

fitImage

  • fitImage(): void

  • Sends a fitting request using the current fitting settings. If automatic initial-value generation is enabled, NaN values and false flags are used instead of components. Skips the request if fitting is currently disabled.

    Returns void

resetBackgroundOffset

  • resetBackgroundOffset(): void

  • Resets the background offset to 0.

    Returns void

resetFittingState

  • resetFittingState(): void

  • Resets the fitting states and progress.

    Returns void

setBackgroundOffset

  • setBackgroundOffset(offset: number): void

  • Sets the constant background offset.

    Parameters

    • offset: number

      Offset value (ignored if not finite).

    Returns void

setComponents

  • setComponents(num: number): void

  • Sets the number of components used for fitting.

    Parameters

    • num: number

      The number of components.

    Returns void

setIsAutoInitVal

  • setIsAutoInitVal(isAuto: boolean): void

  • Enables or disables automatic initial‑value generation.

    Parameters

    • isAuto: boolean

      True to enable, false to disable.

    Returns void

setIsCancelling

  • setIsCancelling(isCancelling: boolean): void

  • Updates whether cancel is in progress.

    Parameters

    • isCancelling: boolean

      True if cancellation has been requested.

    Returns void

setIsFitting

  • setIsFitting(isFitting: boolean): void

  • Updates whether a fitting request is currently being processed.

    Parameters

    • isFitting: boolean

      True when fitting is in progress.

    Returns void

setProgress

  • setProgress(progress: number): void

  • Sets the progress of the current fitting request.

    Parameters

    • progress: number

      Progress from 0 to 1 (multiply by 100 for %).

    Returns void

setResultString

  • setResultString(regionId: number, fovInfo: IRegionInfo, fixedParams: boolean[], values: IGaussianComponent[], errors: IGaussianComponent[], offsetValue: number, offsetError: number, integratedFluxValues: number[], integratedFluxErrors: number[], fittingLog: string): void

  • Processes the fitting results and stores the formatted result string and log messages.

    Parameters

    • regionId: number

      The region ID used for fitting.

    • fovInfo: IRegionInfo

      Field of view parameters when fitting was performed on the current FOV.

    • fixedParams: boolean[]

      Fixed flags for each fitting parameters.

    • values: IGaussianComponent[]

      Values for each Gaussian component.

    • errors: IGaussianComponent[]

      Fitting errors for each Gaussian component.

    • offsetValue: number

      The background offset.

    • offsetError: number

      Fitting error of the background offset.

    • integratedFluxValues: number[]

      Integrated flux values for each Gaussian component.

    • integratedFluxErrors: number[]

      Errors of the integrated flux values.

    • fittingLog: string

      The log message.

    Returns void

setSelectedComponentIndex

  • setSelectedComponentIndex(index: number): void

  • Sets the index of the component currently selected in the UI.

    Parameters

    • index: number

      The selected component index.

    Returns void

setSelectedFileId

  • setSelectedFileId(id: number): void

  • Sets the ID of the file currently selected for fitting.

    Parameters

    • id: number

      The file ID.

    Returns void

setSelectedRegionId

  • setSelectedRegionId(id: number): void

  • Sets the ID of the region currently selected for fitting.

    Parameters

    • id: number

      The region ID (0 = current FOV, -1 = full image, positive number = specific region).

    Returns void

setSolverType

  • setSolverType(type: FittingSolverType): void

  • Sets the solver used for fitting.

    Parameters

    • type: FittingSolverType

      A value from CARTA.FittingSolverType.

    Returns void

toggleBackgroundOffsetFixed

  • toggleBackgroundOffsetFixed(): void

  • Toggles whether the background offset is fixed during fitting.

    Returns void

toggleCreateModelImage

  • toggleCreateModelImage(): void

  • Toggles whether to generate a model image when requesting for fitting.

    Returns void

toggleCreateResidualImage

  • toggleCreateResidualImage(): void

  • Toggles whether to generate a residual image when requesting for fitting.

    Returns void