MATLAB reference: ofxLinkedStatistics

The class ofxLinkedStatistics encapsulates the following functions from the C API:

Construction

This class is not created directly but is returned by a call to the ofxObject function LinkedStatistics, for example:

linkedstats = line.LinkedStatistics({'Effective Tension', 'Bend Moment'}, ofx.oeArcLength(32.5))

Functions

Query

queryStats = linkedstats.Query(varName, linkedVarName)

So, for the linkedstats object constructed above:

queryStats = linkedstats.Query('Effective Tension', 'Bend Moment')

The parameters varName and linkedVarName are result names that must have been included in the list of varnames passed to the LinkedStatistics function. This function calls the C API function C_QueryLinkedStatistics. The Query function returns a structure that represents the C API structure TStatisticsQuery and has the same fields.

TimeSeriesStatistics

timeseriesStats = linkedstats.TimeSeriesStatistics(varName)

timeseriesStats = linkedstats.TimeSeriesStatistics('Bend Moment')

The varName parameter must be one of the result names included in the list of varnames passed to the LinkedStatistics function. This function calls the C API function C_CalculateLinkedStatisticsTimeSeriesStatistics function and returns a structure which represents the C API structure TTimeSeriesStatistics and has the same fields.