IMsCollapseTransform

Assembly: Ms;

Description

The IMsCollapseTransform interface contains properties and methods that determine parameters of the Collapse model.

Inheritance Hierarchy

          IMsMethod

          IMsVectorMethod

          IMsCollapseTransform

Comments

This model aggregates lower level data to upper level; it is used to calculate problems that require data aggregation. For example, data calculated by months must be summed for quarterly frequency.

On data aggregation the following calendar frequency settings are taken into account by the model: shifting start period relative to its start/end.

Example of data aggregation from daily to weekly frequency

Properties

  Property name Brief description
Input The Input property determines the term corresponding to input variable.
InputLevel The InputLevel property determines original frequency.
MethodType The MethodType property determines the aggregation method to be applied to output variable.
MissingData The MissingData property determines parameters of missing data treatment in the source data.
Result The Result property returns the term corresponding to output variable.
Tolerance The Tolerance property determines the number of skipped values in output series, which is regarded as acceptable when aggregating data.

Properties inherited from IMsMethod

  Property name Brief description
CalculateSeries The CalculateSeries property returns results of model calculation.
InversionInfo The InversionInfo property returns parameters of initial transformation applied to variable.
ObservationsCount The ObservationsCount property returns the number of model observations.
PeriodAlignment The PeriodAlignment property returns type of model calculation relative to period.
Series The Series property returns a set of available series used by current method in calculations.
StatMethod The StatMethod property returns information on statistical method used for model calculation.
Summary The Summary property returns summary statistics calculated for model.
SupportsR The SupportsR property determines whether calculation by R is enabled.
Type The Type property returns type of method used for model calculation.
UseR The UseR property determines whether connection to R is used on method calculation.

Methods inherited from IMsMethod

  Method name Brief description
Execute The Execute method calculates model and returns calculation results.

See also:

Ms Assembly Interfaces