dash.stateVectorVariable.metadata

Sets metadata options for dimensions of a state vector variable

Syntax



obj = obj.metadata(dims, 0, [], [], header)


obj = obj.metadata(dims, 1, metadata, [], header)


obj = obj.metadata(dims, 2, conversionFunctions, conversionArgs, header)

Description



obj = obj.metadata(dims, 0, [], [], header)

Use raw gridfile metadata for the indicated dimensions.



obj = obj.metadata(dims, 1, metadata, [], header)

Use user-provided metadata for the indicated dimensions.

Convert metadata for the indicated dimensions using the specified functions and inputs.

Input Arguments

dims

vector, linear indices [nDimensions]
The dimensions that should have their metadata options updated.

metadata

cell vector [nDimensions] {metadata matrix}
Alternate metadata to use for each dimension.

conversionFunctions

cell vector [nDimensions] {function*_*handle}
Handle to the conversion function to use for each dimension.

conversionArgs

cell vector [nDimensions] {cell vector}
Additional input arguments to the conversion function for each dimension.

Output Arguments

obj

scalar dash.*stateVectorVariable* object
The variable with updated metadata parameters.