Main Content

readMember

Return ensemble member data based on the member index

Description

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

data = readMember(wensemble,index) reads the workspace ensemble wensemble member identified by index and returns member data in data. readMember reads only variables that the 'SelectedVariables' property of wensemble specifies.

Code that is generated by Diagnostic Feature Designer uses writeMember, readMember, and findIndex under the following conditions:

  • The input data is an ensemble datastore, such as a file or simulation ensemble datastore.

  • The computation option during code generation specified storing results in local memory rather than writing results back to the ensemble datastore.

Explicitly specifying a member index when reading and writing within the local version of the data, which the code manages using a workspaceEnsemble object, ensures member synchronization with the original ensemble datastore. This synchronization is necessary when you have sequential member-processing loops, such as when you compute ensemble statistics as a precursor to computing signal residues.

  • During the first member-processing loop, which starts with an empty ensemble, no indexing is needed. The code appends each new member result to the end of the ensemble.

  • During the second loop, the index enables the code to write updated member results to the correct location within the now-populated ensemble.

For more information about the dual processing loop for ensemble statistics, see Anatomy of App-Generated MATLAB Code.

Input Arguments

collapse all

Ensemble object, specified as a workspaceEnsemble object. wensemble contains ensemble data and specifies the variable names and types within the ensemble, such as data variables and condition variables.

Member index, specified as a positive integer. index identifies the ensemble member to read new data from.

Output Arguments

collapse all

Member data that readMember extracts, returned as a single-row table.

Introduced in R2020a