ensembleMetadata.ensembleMetadata

Create a new ensembleMetadata object


Syntax



Description

obj = ensembleMetadata(svs)

Returns an array of ensembleMetadata objects for an array of stateVector objects. Each ensembleMetadata object organizes the metadata down the state vector, as well as the metadata for any built ensemble members. (Note that only stateVector objects produced as output from the “stateVector.build” and “stateVector.addMembers” will have ensemble members). The output array will match the size of the array of stateVector objects. The label of each ensembleMetadata object will match the label of the associated stateVector object.

obj = ensembleMetadata(sv, labels)

Specify the label that should be applied to the ensembleMetadata object


Input Arguments

svs

scalar stateVector objects
An array of stateVector objects for which to build ensembleMetadata objects.

labels

string scalar | cellstring scalar | char row vector
The labels to apply to the ensembleMetadata object. Must match the size of the array of stateVector objects.

Output Arguments

obj

scalar ensembleMetadata objects
The ensembleMetadata objects for the stateVector objects. The size will matcht the size of the input array of stateVector objects.