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.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

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

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

  • 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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 null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • 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

Amplitude

  • get Amplitude(): number

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

    Returns number

    Since

    2.0

  • set Amplitude(value): void

  • Parameters

    • value: number

    Returns void

AmplitudeIsFixed

  • get AmplitudeIsFixed(): boolean

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

    Returns boolean

    Since

    2.0

  • set AmplitudeIsFixed(value): void

  • Parameters

    • value: boolean

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Curve

Enabled

IndividualFittingModes

  • get IndividualFittingModes(): IndividualFittingModes

  • The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination.

    Returns IndividualFittingModes

    Since

    2.0

  • set IndividualFittingModes(value): void

  • Parameters

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ManualUpdate

  • get ManualUpdate(): boolean

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

    Returns boolean

    Since

    2.0

  • set ManualUpdate(value): void

  • Parameters

    • value: boolean

    Returns void

Position

  • get Position(): number

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

    Returns number

    Since

    2.0

  • set Position(value): void

  • Parameters

    • value: number

    Returns void

PositionIsFixed

  • get PositionIsFixed(): boolean

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

    Returns boolean

    Since

    2.0

  • set PositionIsFixed(value): void

  • Parameters

    • value: boolean

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

TypeId

Width

  • get Width(): number

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

    Returns number

    Since

    2.0

  • set Width(value): void

  • Parameters

    • value: number

    Returns void

WidthIsFixed

  • get WidthIsFixed(): boolean

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

    Returns boolean

    Since

    2.0

  • set WidthIsFixed(value): void

  • Parameters

    • value: boolean

    Returns void

GetResultsDataSource

Update

Settings

Member Visibility

On This Page

Methods
Default capability