GaussianFittingModel Class

Spotfire 14.2 API Reference
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.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.FittingModelsFittingModel
        Spotfire.Dxp.Application.Visuals.FittingModelsGaussianFittingModel

Namespace:  Spotfire.Dxp.Application.Visuals.FittingModels
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class GaussianFittingModel : FittingModel

The GaussianFittingModel type exposes the following members.

Properties

  NameDescription
Public propertyAmplitude
Gets or sets the value of the Amplitude of the Gaussian curve.
Public propertyAmplitudeIsFixed
Gets or sets a value indicating whether the Amplitude should be constant during the fitting calculation.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCurve
Gets the Gaussian curve.
Public propertyEnabled
Gets or sets a value indicating whether this FittingModel is enabled.
(Inherited from FittingModel.)
Public propertyIndividualFittingModes
The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination.
(Inherited from FittingModel.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyManualUpdate
Gets or sets a value indicating whether to use manual updates.
(Inherited from FittingModel.)
Public propertyPosition
Gets or sets the value of the Position (mean) of the Gaussian curve.
Public propertyPositionIsFixed
Gets or sets a value indicating whether the Position should be constant during the fitting calculation.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTypeId
Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers.
(Inherited from FittingModel.)
Public propertyWidth
Gets or sets the value of the Width of the Gaussian curve.
Public propertyWidthIsFixed
Gets or sets a value indicating whether the Width should be constant during the fitting calculation.
Top
Methods

  NameDescription
Public methodGetResultsDataSource
Gets the current results as a data source.
(Inherited from FittingModel.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Forces an update of this fitting model. Only allowed if ManualUpdate is set to true.
(Inherited from FittingModel.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Remarks

This class cannot be inherited. See the CustomFittingModel class for creating custom fitting models.
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference