Action
    Preparing search index...

    Class GaussianFittingModel

    Represents a Gausssian fitting model that defines a Gaussian curve that minimizes the sum-of-squares of the y-distances between the data and the curve.

    This class cannot be inherited. See the Spotfire.Dxp.Application.Extension.CustomFittingModel class for creating custom fitting models.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Amplitude AmplitudeIsFixed Context Curve Enabled IndividualFittingModes IsAttached LimitToMarking ManualUpdate Position PositionIsFixed Transactions TypeId Width WidthIsFixed ForEachNodeInSubTree GetResultsDataSource Update

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1 | null

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get Amplitude(): number

      Gets or sets the value of the Amplitude of the Gaussian curve.

      Returns number

      2.0

    • set Amplitude(value: number): void

      Parameters

      • value: number

      Returns void

    • get AmplitudeIsFixed(): boolean

      Gets or sets a value indicating whether the Amplitude should be constant during the fitting calculation.

      Returns boolean

      2.0

    • set AmplitudeIsFixed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Enabled(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel is enabled.

      Returns boolean

      2.0

    • set Enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LimitToMarking(): boolean

      Gets or sets a value indicating whether the fitting model should only include marked data when fitting. When true the active marking from the owning visual will limit the data used to perform the curve fit. Note that for some fitting model that don't use the visualization data, this property has no effect.

      Returns boolean

      2.5

    • set LimitToMarking(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ManualUpdate(): boolean

      Gets or sets a value indicating whether to use manual updates.

      Returns boolean

      2.0

    • set ManualUpdate(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Position(): number

      Gets or sets the value of the Position (mean) of the Gaussian curve.

      Returns number

      2.0

    • set Position(value: number): void

      Parameters

      • value: number

      Returns void

    • get PositionIsFixed(): boolean

      Gets or sets a value indicating whether the Position should be constant during the fitting calculation.

      Returns boolean

      2.0

    • set PositionIsFixed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • get Width(): number

      Gets or sets the value of the Width of the Gaussian curve.

      Returns number

      2.0

    • set Width(value: number): void

      Parameters

      • value: number

      Returns void

    • get WidthIsFixed(): boolean

      Gets or sets a value indicating whether the Width should be constant during the fitting calculation.

      Returns boolean

      2.0

    • set WidthIsFixed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability