Collapse(Input: ITimeSeries;
Method: MsCollapseType;
TargetFrequency: MsFrequency;
[MissingData: MissingDataMethod =16;]
[NumberOfPoints: Integer = 1;]
[SpecifiedValue: Double = 0;]
[AdditionalSeries: ITimeSeries = Null]): Variant;
Input. Исходная переменная;
Method. Метод агрегации;
TargetFrequency. Результирующая динамика;
MissingData. Метод обработки пропусков;
NumberOfPoints. Дополнительный параметр для метода обработки пропусков;
SpecifiedValue. Значение, которым будут заполняться пропуски методом MissingDataMethod.SpecifiedValue «Указанное значение»;
AdditionalSeries. Ряд, который используется для заполнении пропусков методами MissingDataMethod.Pattern «По шаблону» и MissingDataMethod.Overlay «Значениями заданного ряда».
Метод Collapse осуществляет агрегацию значений переменной.
Параметр NumberOfPoints может принимать только положительные значения. Используется для следующих методов обработки пропусков:
MissingDataMethod.NPointsAverage. «Среднее по N соседним точкам». Параметр определяет количество соседних точек;
PreviousGrowthRate, SucceedingGrowthRate. «Темп роста к предыдущему периоду», «Темп роста к следующему периоду». Параметр определяет число периодов.
Метод выполняет агрегацию данных с нижнего уровня на верхний и необходим при расчёте задачи, требующей агрегации данных. Например, данные, рассчитанные по месяцам, необходимо просуммировать для квартальной динамики.
При агрегации данных учитываются настройки календарной динамики: смещение начала периода относительно его начала/конца.
Пример агрегации данных с дневной на недельную динамику
Для выполнения примера в репозитории предполагается наличие контейнера моделирования с идентификатором MS. В данном контейнере содержится модель с идентификатором MODEL_D_Q и квартальной динамикой, рассчитываемая методом детерминированного уравнения и содержащая не менее одного фактора.
Добавьте ссылки на системные сборки: Metabase, Ms.
Sub UserProc;
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_Q", 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;
// Получаем выражение для расчета модели
Expr := Determ.Expression;
// Задаем выражение для расчета модели
Expr.AsString := "Collapse(" + TermInfo.TermInnerText + ", MsCollapseType.Total, " +
"MsFrequency.Annual, MissingDataMethod.NPointsAverage, 4)";
// Проверяем корректность выражения
If Expr.Valid
// Если выражение корректное, то сохраняем изменения
Then ModelObj.Save;
// Если выражение некорректное, то выводим сообщение в окно консоли
Else Debug.WriteLine("Модель не сохранена: ошибка в формуле");
End If;
End Sub UserProc;
В результате выполнения примера модель будет агрегировать данные первой входной переменной с квартальной динамики на годовую с применением обработки пропусков методом «Среднее по N соседним точкам», где N = 4.
Выражение 1:
collapse({Brazil|BCA}, MsCollapseType.Total, MsFrequency.Annual, MissingDataMethod.NPointsAverage, 4)
Результат: для временного ряда «Brazil|BCA» будет произведена агрегация данных на годовую динамику методом суммирования с применением обработки пропусков методом «Среднее по N соседним точкам», где N = 4.
Применение: можно использовать в формулах универсального редактора выражения в любом инструменте платформы, где он доступен.
Выражение 2:
Collapse(X1,MsCollapseType.Average,MsFrequency.Annual, MissingDataMethod.LinTrend)
Результат: для фактора «X1» будет произведена агрегация данных на годовую динамику методом вычисления среднего значения с применением метода обработки пропусков «Линейный тренд».
Применение: можно использовать в формулах моделей контейнера моделирования, основанных на переменных.
См. также:
IModelling | База данных временных рядов: калькулятор, агрегация | Контейнер моделирования: модели «Коллапс (векторный расчет)», «Коллапс (поточечный расчет)», редактирование регрессора/формулы