IMsModelPeriod.AutoPeriod

The AutoPeriod property determines the conditions that are used to calculate start and end dates of sample and forecasting periods.

Comments

The value is determined by combinations of the MsAutoPeriodOptions enumeration elements. AutoPeriod is taken into account if the IMsModel.UseModelPeriod property is set to True.

If AutoPeriod uses the value of the MsAutoPeriodOptions enumeration, which requires setting additional number of periods, for example, MsAutoPeriodOptions.IdentStartByIdentEnd or MsAutoPeriodOptions.ForecastEndByFact, specify additional parameters in the corresponding property:

When forming of sample and forecasting periods using actual data, the model specific is taken into account:
- Actual data of input series used to form the sample period is taken from input variable for the following models: linear regression (OLS, instrumental variables estimation), binary choice model, non-linear regression, trend with selection of functional dependency, all smoothing methods, ARIMA, error correction model, cumulative method, missing data treatment.
- For the Collapse (series calculation), Collapse (pointwise calculation) and Interpolation methods the actual data for the input series to form the sample period is taken from the input variable, by the source frequency.
- If the model does not require the input variable (for example, in a determinate equation and custom methods), sample period start is equal to the minimum date corresponding to the first non-empty values of model operands, sample and forecasting period end is formed according to the maximum date corresponding to the last non-empty values of model operands.
- For the Aggregation model, limits of the sample and forecasting periods are based on the output variable (if the variable does not have slices), or based on the values of the variable by the slices (if the variable has slices).
- Sample start and end dates and forecast end dates are set equal to the calendar start of the modeling container for the models that allow for the use of empty series as the input or input variable and factors.
- On calculating the forecasting period end date equal to last actual date of model factors, the data of output variable is taken into account. If the forecasting period end date is less than the forecasting period start date, the sample period end date is specified as the forecasting period end date.
- For Aggregation (Extended) and Aggregation (Basic) models, the conditions of setting sample and forecasting periods by actual data of variables are not used. Other conditions are implemented in the same way as the ordinary models.
- For non-linear equation systems, input-output balance model, vector error correction model, models on panel data, and the Value-at-Risk model, no conditions of setting sample and forecasting periods by actual data of variables are used. Other conditions are implemented in the same way as the ordinary models.
- If the model has through dimension, the calculation period for it is formed by the first element of the dimension.
On forming the periods using start/end of the sample/forecasting dates the settings of the calendar frequency are taken into account: offset of the period start relative to its start/end.
If the current date is used on forming the period, the end dates of the sample and forecasting are offset to the period end. It is relevant for the monthly frequency and higher.
For example, sample period end is April 2012 (IdentEndAsNow), and the calculation end date is equal to the sample period end date (ForecastEndByIdentEnd). Thus, on calculating the model the calculation end date is 30.04.2012.

Fore Example

Executing the example requires a modeling container with the MS identifier that contains a model with the MODEL identifier.

Sub UserProc;
Var
    mb: IMetabase;
    MsKey: Integer;
    ModelObj: IMetabaseObject;
    Model: IMsModel;
    ModelPeriod: IMsModelPeriod;
Begin
    mb := MetabaseClass.Active;
    MsKey := mb.ItemById("MS").Key;
    ModelObj := mb.ItemByIdNamespace("MODEL", MsKey).Edit;
    Model := ModelObj As IMsModel;
    Model.UseModelPeriod := True;
    ModelPeriod := Model.Period;
    ModelPeriod.AutoPeriod := MsAutoPeriodOptions.IdentStartAsNow +
        MsAutoPeriodOptions.IdentEndAsNow +
        MsAutoPeriodOptions.ForecastStartAsNow +
        MsAutoPeriodOptions.ForecastEndByIdentEnd;
    ModelPeriod.IdentificationStartOffset := -10;
    ModelPeriod.IdentificationEndOffset := -1;
    ModelPeriod.UseForecastStart := True;
    ModelPeriod.ForecastStartOffset := 1;
    ModelPeriod.ForecastEndOffset := 5;
    ModelObj.Save;
End Sub UserProc;

After executing the example the conditions that determine model calculation periods are set:

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.Ms;
…
Public Shared Sub Main(Params: StartParams);
Var
    mb: IMetabase;
    MsKey: uinteger;
    ModelObj: IMetabaseObject;
    Model: IMsModel;
    ModelPeriod: IMsModelPeriod;
    AutoPeriod: integer;
Begin
    mb := Params.Metabase;
    MsKey := mb.ItemById["MS"].Key;
    ModelObj := mb.ItemByIdNamespace["MODEL", MsKey].Edit();
    Model := ModelObj As IMsModel;
    Model.UseModelPeriod := True;
    ModelPeriod := Model.Period;
    ModelPeriod.AutoPeriod := (MsAutoPeriodOptions.msapoIdentStartAsNow As integer) +
        (MsAutoPeriodOptions.msapoIdentEndAsNow As integer) +
        (MsAutoPeriodOptions.msapoForecastStartAsNow As integer) +
        (MsAutoPeriodOptions.msapoForecastEndByIdentEnd As integer);
    ModelPeriod.IdentificationStartOffset := -10;
    ModelPeriod.IdentificationEndOffset := 0;
    ModelPeriod.UseForecastStart := True;
    ModelPeriod.ForecastStartOffset := 1;
    ModelPeriod.ForecastEndOffset := 5;
    ModelObj.Save();
End Sub;

IMsModelPeriod.AutoPeriod

Fore Syntax

Fore.NET Syntax

Description

Comments

Fore Example

Fore.NET Example