readFeatureTable

Read feature values, independent variables, and condition variables from an ensemble data set into a table

Since R2020a

Syntax

ft = readFeatureTable(ensemble)

ft = readFeatureTable(ensemble,framepolid)

ft = readFeatureTable(___,Name,Value)

Description

readFeatureTable is a function used in code generated by Diagnostic Feature Designer.

ft = readFeatureTable(ensemble) extracts a feature table ft from ensemble ensemble for all features computed in full-signal mode. The feature table contains features, independent variables, and condition variables, and is the primary output of code generated by Diagnostic Feature Designer.

ft = readFeatureTable(ensemble,framepolid) uses the frame size and frame rate defined in FramePolicyID to read each frame interval when the function constructs the feature table. This syntax applies to frame-based—also known as segmented—signal and feature computation.

ft = readFeatureTable(___,Name,Value) specifies the features and variables to read using one or more name-value pair arguments. For instance, if you use ft = readFeatureTable(ensemble,'ConditionVariables','FaultCode'), ft contains only the 'FaultCode' condition variable but still includes all features and independent variables. You can use this syntax with any of the input argument combinations in previous syntaxes.

Input Arguments

ensemble — Ensemble of member data

workspaceEnsemble object | fileEnsembleDatastore object | simulationEnsembleDatastore object

Ensemble of member data, specified as a fileEnsembleDatastore object, a simulationEnsembleDatastore object, or a workspaceEnsemble object.

framepolid — Frame policy ID

string

Frame policy ID, specified as a string formatted as FRM_<frame policy index>. In code generated by Diagnostic Feature Designer, the frame policy reflects the choice of frame size and frame rate in segmented data.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'ConditionVariables','FaultCode'

Features — Features to read

string array

Features to read, specified as the comma-separated pair consisting of 'Features' and a string array of paths that point to the selected features. If you do not specify 'Features', the function reads all the features.

IndependentVariables — Independent variables to read

string array

Independent variables to read, specified as the comma-separated pair consisting of 'IndependentVariables' and a string array of paths that point to the selected variables. If you do not specify 'IndependentVariables', the function reads all the independent variables.

ConditionVariables — Condition variables to read

string array

Condition variables to read, specified as the comma-separated pair consisting of 'ConditionVariables' and a string array of paths that point to the selected variables. If you do not specify 'ConditionVariables', the function reads all the condition variables.

IncludeMemberID — Option to return member IDs

false (default) | true

Option to return ensemble member IDs, specified as the comma-separated pair consisting of 'IncludeMemberID' and a logical scalar. When you set 'IncludeMemberID' to true, the feature table ft includes a column of member IDs.

Output Arguments

ft — Feature table

table

Feature table, specified as a table. The table contains features, independent variables, and condition variables for each member. The features and condition variables are scalars. The independent variables are timetables, tables, or cell arrays.

Version History

Introduced in R2020a