smif.convert.unit module¶
Handles conversion between units used in the SosModel
Reference¶
-
class
smif.convert.unit.
UnitAdaptor
(name)[source]¶ Bases:
smif.convert.adaptor.Adaptor
Scalar conversion of units
-
simulate
(data_handle: smif.data_layer.data_handle.DataHandle)[source]¶ Register unit definitions in registry for model run
-
convert
(data_array, to_spec, coefficients)[source]¶ Convert a dataset between
Spec
definitionsParameters: - data (smif.data_layer.data_array.DataArray) –
- to_spec (smif.metadata.spec.Spec) –
- coefficients (numpy.ndarray) –
Returns: Return type:
-
get_coefficients
(data_handle, from_spec, to_spec)[source]¶ Read coefficients, or generate and save if necessary
Parameters: - data_handle (smif.data_layer.data_handle.DataHandle) –
- from_spec (smif.metadata.spec.Spec) –
- to_spec (smif.metadata.spec.Spec) –
Returns: Return type:
-
generate_coefficients
(from_spec, to_spec)[source]¶ Generate coefficients for a pair of
Spec
definitionsParameters: - from_spec (smif.metadata.spec.Spec) –
- to_spec (smif.metadata.spec.Spec) –
Returns: Return type:
-