IModelling.InterpolateP

InterpolateP(Input: Prognoz.Platform.Interop.Ms.TimeSeries;
             TargetFrequency: Prognoz.Platform.Interop.Ms.MsFrequency;
             Pattern: Prognoz.Platform.Interop.Ms.TimeSeries;
             PatternType: Prognoz.Platform.Interop.Ms.MsPatternType;
             Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext;
             Period: Prognoz.Platform.Interop.Ms.IMsPeriod): object;

Parameters

Pattern. Pattern variable, on which the interpolation is based. It must contain output frequency.

PatternType. Pattern type, on which the interpolation is based. Optional parameter. The default value of the MsPatternType.Average is average by elements.

Period. Period, at which the method is calculated. If the parameter is set to Null, the method is calculated at the entire time period.

Description

Comments

On data disaggregation the following calendar frequency settings are taken into account: start period offset relative to its start/end.

The period under consideration: first two weeks of May 2012.

Interpolation method: uniform.

Calendar frequency settings: input variable contains weekly and daily frequencies; week start offset is not used; daily frequency contains days from Monday to Friday. Disaggregation result:

Week	Period start date	Day of the week	Raw data	Calculated value
1st week	May 7 2012	Monday	1
	May 7 2012	Monday		0.20
	May 8 2012	Tuesday		0.20
	May 9 2012	Wednesday		0.20
	May 10 2012	Thursday		0.20
	May 11 2012	Friday		0.20
2nd week	May 14 2012	Monday	2
	May 14 2012	Monday		0.40
	May 15 2012	Tuesday		0.40
	May 16 2012	Wednesday		0.40
	May 17 2012	Thursday		0.40
	May 18 2012	Friday		0.40

Calendar frequency settings: input variable contains weekly and daily frequencies; week start is offset on 3 days forward; daily frequency contains days from Monday to Friday. Disaggregation result:

Week	Period start date	Day of the week	Raw data	Calculated value
1st week	May 2 2012	Wednesday	1
	May 2 2012	Wednesday		0.20
	May 3 2012	Thursday		0.20
	May 4 2012	Friday		0.20
	May 7 2012	Monday		0.20
	May 8 2012	Tuesday		0.20
2nd week	May 9 2012	Wednesday	2
	May 9 2012	Wednesday		0.40
	May 10 2012	Thursday		0.40
	May 11 2012	Friday		0.40
	May 14 2012	Monday		0.40
	May 15 2012	Tuesday		0.40

Fore Example

Executing the example requires that the repository contains a modeling container with the MS identifier. This container contains a model with the MODEL_D identifier (annual frequency). This model should contain several factors. Each factor should contain annual and quarterly frequency.

Sub UserProc;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    InputTerm, PatternTerm: IMsFormulaTermInfo;
    Expr: IExpression;
Begin
    Mb := MetabaseClass.Active;
    ModelSpace := Mb.ItemById("CONT_MODEL").Bind;
    ModelObj := Mb.ItemByIdNamespace("M_DETERM", ModelSpace.Key).Edit;
    Model := ModelObj As IMsModel;
    Transf := Model.Transform;
    Formula := Transf.FormulaItem(0);
    Determ := Formula.Method As IMsDeterministicTransform;
    TransVar := Transf.Inputs.Item(0);
    Slice := TransVar.Slices.Item(0);
    InputTerm := Transf.CreateTermInfo;
    InputTerm.Slice := Slice;
    TransVar := Transf.Inputs.Item(1);
    Slice := TransVar.Slices.Item(0);
    PatternTerm := Transf.CreateTermInfo;
    Slice.Level := DimCalendarLevel.Quarter;
    PatternTerm.Slice := Slice;
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := "InterpolateP(" + InputTerm.TermInnerText + ",MsFrequency.Quarterly," +
        PatternTerm.TermInnerText + ",MsPatternType.First,SetPeriod(" +
        """" + "01.01.2000" + """" + "," + """" + "01.01.2015" + """" + "))";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("Model is not saved: error in equation");
   End If;
End Sub UserProc;

After executing the example the model interpolates the first input variable data from annual frequency to quarterly for the period from 2000 to 2015. A pattern, set by the second input variable, is used for interpolation.

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;
Imports Prognoz.Platform.Interop.Dimensions;
Imports Prognoz.Platform.Interop.ForeSystem;
…
Public Shared Sub Main(Params: StartParams);
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    InputTerm, PatternTerm: IMsFormulaTermInfo;
    Expr: IExpression;
Begin
    Mb := Params.Metabase;
    ModelSpace := Mb.ItemById["MS"].Bind();
    ModelObj := Mb.ItemByIdNamespace["MODEL_D", ModelSpace.Key].Edit();
    Model := ModelObj As IMsModel;
    Transf := Model.Transform;
    Formula := Transf.FormulaItem[0];
    Determ := Formula.Method As IMsDeterministicTransform;
    TransVar := Transf.Inputs.Item[0];
    Slice := TransVar.Slices.Item[0];
    InputTerm := Transf.CreateTermInfo();
    InputTerm.Slice := Slice;
    TransVar := Transf.Inputs.Item[1];
    Slice := TransVar.Slices.Item[0];
    PatternTerm := Transf.CreateTermInfo();
    Slice.Level := DimCalendarLevel.dclQuarter;
    PatternTerm.Slice := Slice;
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := "InterpolateP(" + InputTerm.TermInnerText + ",MsFrequency.Quarterly," +
        PatternTerm.TermInnerText + ",MsPatternType.First,SetPeriod(" +
        """" + "01.01.2000" + """" + "," + """" + "01.01.2015" + """" + "))";
    If Expr.Valid
        Then ModelObj.Save();
        Else System.Diagnostics.Debug.WriteLine("Model is not saved: error in equation");
    End If;
End Sub;

Example of Use in Expressions

Result: the Brazil|BCA series data will be disaggregated to quarter frequency by template set by the China|BCA series for the entire time period.

InterpolateP(X1,MsFrequency.Monthly,X2,MsPatternType.Last, SetPeriod("01.01.2000","01.01.2015"))

Result: the X1 factor data will be disaggregated to monthly frequency by the last template element set by the X2 factor for the period from 2000 to 2015.