dash.stateVectorVariable.parametersForBuild
Organize and return parameters needed to build ensemble members for a variable
Syntax
Description
parameters = obj.parametersForBuild
Organizes parameters needed to build ensemble members for a state vector variable into a struct.
Input Arguments
loadAllMembers
scalar logical
Whether the variable should attempt to load all ensemble members simultaneously.
Output Arguments
parameters
scalar struct
.rawSize (vector, positive integers): The size of a raw ensemble member. This is the size of the ensemble member before any means are taken. Mean and sequence elements are separated from one another.
.meanDims (vector, linear index): The index of the dimension containing mean elements in the raw ensemble member. (Because mean and sequence elements are separated from one another, variable dimensions may actually span 2 dimensions of the loaded ensemble member).
.nState (scalar positive integer): The number of state vector elements in the final ensemble member