GaussianFittingModel Class

Spotfire 15.0 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: 71.0.22122.5390 (71.0.22122.5390)

Syntax

Copy

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

The GaussianFittingModel type exposes the following members.

Properties

	Name	Description
	Amplitude	Gets or sets the value of the Amplitude of the Gaussian curve.
	AmplitudeIsFixed	Gets or sets a value indicating whether the Amplitude should be constant during the fitting calculation.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Curve	Gets the Gaussian curve.
	Enabled	Gets or sets a value indicating whether this FittingModel is enabled. (Inherited from FittingModel.)
	IndividualFittingModes	The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination. (Inherited from FittingModel.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	LimitToMarking	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. (Inherited from FittingModel.)
	ManualUpdate	Gets or sets a value indicating whether to use manual updates. (Inherited from FittingModel.)
	Position	Gets or sets the value of the Position (mean) of the Gaussian curve.
	PositionIsFixed	Gets or sets a value indicating whether the Position should be constant during the fitting calculation.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers. (Inherited from FittingModel.)
	Width	Gets or sets the value of the Width of the Gaussian curve.
	WidthIsFixed	Gets or sets a value indicating whether the Width should be constant during the fitting calculation.

Top

Methods

	Name	Description
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetResultsDataSource	Gets the current results as a data source. (Inherited from FittingModel.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Forces an update of this fitting model. Only allowed if ManualUpdate is set to true. (Inherited from FittingModel.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	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

Reference

Spotfire.Dxp.Application.Visuals.FittingModels Namespace