dash.stateVectorVariable
Implement a variable in a state vector
Description
The stateVectorVariable class implements an object that describes a variable in a state vector. Each object holds the design parameters for a single variable. These design parameters include:
State and ensemble dimensions
Sequences
Means and totals, and
Metadata options.
The class also implements a number of utilities for building state vector ensembles; these include removing ensemble members with incomplete sequences/means, removing ensemble members that overlap previously built members, and processing metadata options.
The stateVectorVariable class is designed to build variables from data catalogued in a gridfile. However, methods that update the variable’s design parameters do not require gridfile access. The gridfile is only required to initially create a variable, and when building a state vector ensemble.
The class framework allows multiple stateVectorVariable objects to be stored as a vector, which is utilized by the stateVector class. However, such vectors are highly nested and can be slow to save directly. Instead, these vectors should be serialized before saving, and deserialized upon load. See the “serialize” and “deserialize” commands to implement these options.