dash.stateVectorVariable.dimensions
List the dimensions of a state vector variable
Syntax
Description
dimensions = obj.dimensions
Return the list of all dimensions in the variable.
dimensions = obj.dimensions(type)dimensions = obj.dimensions(‘all’ | ‘state’ | ‘ensemble’)
Return a list of dimension of a specific type. If ‘all’, returns the list of all dimensions in the variable. If ‘state’, returns the list of state dimensions for the variable. If ‘ensemble’, returns the list of ensemble dimensions for the variable.
Input Arguments
type
string scalar
Indicates the type of dimensions to return
[‘all’ (default]: Return all dimensions for the variable
[‘state’]: Return the state dimensions for the variable
[‘ensemble’]: Return the ensemble dimensions for the variable
Output Arguments
dimensions
string vector [nDimensions]
The list of dimensions of the requested type for the variable.