IModelling.Bpf

Bpf(Input: ITimeSeries;
    Period: IMsPeriod;
    Lag: Integer;
    Low: Integer;
    High: Integer;
    [Output: MsBPFOutputType = 0]): Variant;

Синтаксис Fore.NET

Bpf(Input: Prognoz.Platform.Interop.Ms.ITimeSeries;
    Period: Prognoz.Platform.Interop.Ms.IMsPeriod;
    Lag: Integer;
    Low: Integer;
    High: Integer;
    Output: Prognoz.Platform.Interop.Ms.MsBPFOutputType;
    Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext): object;

Параметры

Period. Период, на котором рассчитывается метод. Если значение параметра Null, то метод рассчитывается на всём временном периоде;

Context. Контекст. Параметр используется только в Fore.NET.

Описание

Метод Bpf моделирует значения переменной фильтром Бакстера-Кинга.

Комментарии

Значения опережения/лага и границ периода цикличности устанавливаются в зависимости от календарной динамики исходной переменной. Базовые значения:

Пример Fore

Для выполнения примера предполагается наличие в репозитории контейнера моделирования с идентификатором «MS». В данном контейнере содержится модель с идентификатором «MODEL_D», рассчитываемая методом детерминированного уравнения и содержащая хотя бы одну входную переменную. Модель должна иметь годовую динамику.

Добавьте ссылки на системные сборки: Metabase, Ms.

Sub UserBpf;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    TermInfo: IMsFormulaTermInfo;
    Expr: IExpression;
Begin
    // Получаем репозиторий
    Mb := MetabaseClass.Active;
    // Получаем контейнер моделирования
    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);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    // Задаем режим передачи переменной в расчет
    TermInfo.Type := MsFormulaTermType.Pointwise;
    // Получаем выражение расчета модели
    Expr := Determ.Expression;
    Expr.References := "Ms";
    // Задаем выражение расчета модели
    Expr.AsString := "Bpf(" + TermInfo.TermInnerText +", SetPeriod(" +
        """" + "01.01.2000" + """" + "," + """" + "01.01.2015" + """" +
        "), 3, 2, 8,MsBPFOutputType.NonCyclicalSeries)";
    // Проверяем корректность выражения
    If Expr.Valid
        // Если выражение задано корректно, то сохраняем модель
        Then ModelObj.Save;
        // Если выражение некорректное, то выводим сообщение в окно консоли
        Else Debug.WriteLine("Модель не сохранена: ошибка в формуле");
    End If;
End Sub UserBpf;

После выполнения примера модель будет рассчитывать значения на основе первой входной переменной фильтром Бакстера-Кинга на периоде с 2000 по 2015 год. В моделируемую переменную будет выгружаться нециклическая составляющая входной переменной.

Пример Fore.NET

Необходимые требования и результат выполнения примера Fore.NET совпадают с примером Fore.

Imports Prognoz.Platform.Interop.Ms;
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;
    TermInfo: 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];
    TermInfo := Transf.CreateTermInfo();
    TermInfo.Slice := Slice;
    // Задаем режим передачи переменной в расчет
    TermInfo.Type := MsFormulaTermType.mfttPointwise;
    // Получаем выражение расчета модели
    Expr := Determ.Expression;
    Expr.References := "Ms";
    // Задаем выражение расчета модели
    Expr.AsString := "Bpf(" + TermInfo.TermInnerText + ", SetPeriod(" +
        """" + "01.01.2000" + """" + "," + """" + "01.01.2015" + """" +
        "), 3, 2, 8,MsBPFOutputType.NonCyclicalSeries)";
    // Проверяем корректность выражения
    If Expr.Valid
        // Если выражение задано корректно, то сохраняем модель
        Then ModelObj.Save();
        // Если выражение некорректное, то выводим сообщение в окно консоли
        Else System.Diagnostics.Debug.WriteLine("Модель не сохранена: ошибка в формуле");
    End If;
End Sub;

Пример использования в выражениях

Bpf({Чикаго - население[t]}, NULL, 3, 2, 8, MsBPFOutputType.NonCyclicalSeries)

Результат: для временного ряда «Чикаго - население» будет применен фильтр Бакстера-Кинга на всем временном периоде. Параметры фильтра: фильтр рассчитывается на всем периоде данных, значения опережения/лага и границ периода сезонности заданы для годовых данных, после расчёта будет выгружаться несезонная компонента исходного ряда.

Применение: можно использовать в формулах вычисляемых рядов базы данных временных рядов и в формулах моделей контейнера моделирования, основанных на атрибутах.

Bpf(X1, SetPeriod("01.01.2000", "01.01.2015"), 13, 6, 32, MsBPFOutputType.NonCyclicalSeries)

Результат: для фактора «X1» будет применен фильтр Бакстера-Кинга на периоде с 2000 по 2015 год. Параметры фильтра: указан период расчета, значения опережения/лага и границ периода сезонности заданы для квартальных данных, после расчёта будет выгружаться сезонная компонента исходного ряда.

Применение: можно использовать в формулах моделей контейнера моделирования, основанных на переменных.

Динамика	Опережение/лаг	Нижняя граница	Верхняя граница
Годовая	3	2	8
Полугодовая	6	3	16
Квартальная	12	6	32
Месячная	36	18	96
Недельная	156	78	416
5-дневная	783	391,5	2088
7-дневная	1095	547,5	2920