A model contining the parameters for a Holt-Winters forecast. Usually applied to time series data,
but it can be used with any discrete set of repeated measurements.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.Visuals.FittingModelsFittingModel
Spotfire.Dxp.Application.Visuals.FittingModelsForecastHoltWintersFittingModel
Namespace: Spotfire.Dxp.Application.Visuals.FittingModels
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(13, 0)] public sealed class ForecastHoltWintersFittingModel : FittingModel
The ForecastHoltWintersFittingModel type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | ConfigureModelCore |
Override this method to configure the fitting model.
(Inherited from FittingModel.) |
![]() | CreateCurve |
Creates a new curve.
(Inherited from FittingModel.) |
![]() | CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
![]() | CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
![]() | CreatePoint |
Creates a new point.
(Inherited from FittingModel.) |
![]() | CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
![]() | CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
![]() | CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
![]() | CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
![]() | CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
![]() | CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
![]() | CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
![]() | DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
![]() | DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
![]() | DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
![]() | DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | Fit | Performs the fitting operation.
(Inherited from FittingModel.) |
![]() | GetConfigureModelTriggerCore | Override this method to provide a Trigger that
fires when the fitting model needs to be reconfigured.
(Inherited from FittingModel.) |
![]() | GetCurve |
Gets the curve with the specified name.
(Inherited from FittingModel.) |
![]() | GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
![]() | GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
![]() | GetPoint |
Gets the point with the specified name.
(Inherited from FittingModel.) |
![]() | GetResultsDataSource | Gets the current results as a data source.
(Inherited from FittingModel.) |
![]() | GetResultTriggerCore |
Method called by the framework to get a Trigger that fires when the results become invalid.
Subclasses should override this method if they declare properties that affect the result.
(Inherited from FittingModel.) |
![]() | GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
![]() | OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
![]() | OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
![]() | OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
![]() | SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
![]() | SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
![]() | SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
![]() | SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
![]() | SupportsVisualConfigurationCore | Tells whether a class implementing FittingModel
supports the specified VisualContent instance.
(Inherited from FittingModel.) |
![]() | Update |
Forces an update of this fitting model. Only allowed if ManualUpdate is set to true.
(Inherited from FittingModel.) |
![]() | ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Properties
Name | Description | |
---|---|---|
![]() | AllowEmptyValueReplacement |
Gets or sets a value indicating whether this Holt Winters model allows interpolation to replace missing values.
Setting this to true will mean that an empty value in the time series will be replaced by linear interpolation between
the values before and after it. If there are multiple empty values in a row then no curve fit is computed.
Setting this value to false will mean that if empty values are found in the time series, no curve fit is computed.
|
![]() | AutomaticFrequency |
Gets or sets a value indicating whether the frequency parameter is deduced from the visualization.
|
![]() | ConfidenceCurve |
Gets the confidence curve.
|
![]() | ConfidenceLevel |
Gets or sets the confidence level for the prediction intervals. Must be within the half-open unit interval [0, 1),
but is typically close to 1.
|
![]() | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
![]() | Enabled |
Gets or sets a value indicating whether this FittingModel is enabled.
(Inherited from FittingModel.) |
![]() | FittedCurve |
Gets the fitted curve.
|
![]() | ForecastCurve |
Gets the forecast curve.
|
![]() | Frequency |
Gets or sets the frequency (the number of observations per sampling period). For example, monthly data have frequency=12.
This must be greater than 1 to fit a seasonal component. This is a convenience wrapper of FrequencyExpression. If this property is read when preprocessor expression does not evaluate to a positive integer, -1 is returned. |
![]() | FrequencyExpression |
Gets or sets the frequency expression (the number of observations per sampling period). For example, monthly data have frequency=12.
This string is preprocessed and should evaluate to a positive integer.
This must be greater than 1 to fit a seasonal component. |
![]() | 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.) |
![]() | Level |
Gets or sets the level (alpha) parameter of Holt-Winters specifying how to smooth the level component. Must be within the half-open unit interval (0, 1].
A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight.
NULL means that the HoltWinters function should find the optimal value of alpha.
|
![]() | ManualUpdate |
Gets or sets a value indicating whether to use manual updates.
(Inherited from FittingModel.) |
![]() | Seasonal |
Gets or sets the seasonal (gamma) parameter of Holt-Winters specifying how to smooth the seasonal component.
Must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily.
Values near 1.0 mean that the latest value has more weight.
NULL means that the HoltWinters function should find the optimal value of gamma.
|
![]() | SeasonalModelType |
Gets or sets the seasonal parameter.
|
![]() | TimePointsAhead |
Gets or sets the number of time points in the future at which to predict the values of the time series.
This is a convenience wrapper of TimePointsAheadExpression. If this property is read when the preprocessor expression
does not evaluate to a positive integer, -1 is returned.
|
![]() | TimePointsAheadExpression |
Gets or sets the number of time points in the future at which to predict the values of the time series
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | Trend |
Gets or sets the trend (beta) parameter of Holt-Winters specifying how to smooth the trend component. Must be within the unit interval [0, 1].
A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight.
NULL means that the HoltWinters function should find the optimal value of beta.
|
![]() | 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.) |
![]() | UseSeasonal |
Gets or sets a value indicating whether the seasonal component should be included or not.
|
![]() | UseTrend |
Gets or sets a value indicating whether the trend component should be included or not.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
![]() ![]() | 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.) |
![]() ![]() | ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Remarks
Version Information
See Also