smif.convert.adaptor module

Adaptor is a subclass of Model, to be used for converting data between units or dimensions.

The method to override is generate_coefficients, which accepts two Spec definitions.

Summary

Data:

Adaptor Abstract Adaptor, to convert inputs/outputs between other Models

Reference

class smif.convert.adaptor.Adaptor(name)[source]

Bases: smif.model.model.Model

Abstract Adaptor, to convert inputs/outputs between other Models

Override method generate_coefficients, which accepts two Spec definitions.

simulate(data_handle: smif.data_layer.data_handle.DataHandle)[source]

Convert from input to output based on matching variable names

get_coefficients(data_handle: smif.data_layer.data_handle.DataHandle, from_spec: smif.metadata.spec.Spec, to_spec: smif.metadata.spec.Spec) → <MagicMock id='139764766428944'>[source]

Read coefficients, or generate and save if necessary

Parameters:
Returns:
Return type:

numpy.ndarray
generate_coefficients(from_spec: smif.metadata.spec.Spec, to_spec: smif.metadata.spec.Spec) → <MagicMock id='139764766148640'>[source]

Generate coefficients for a pair of Spec definitions

Parameters:
Returns:
Return type:

numpy.ndarray
convert(data_array: smif.data_layer.data_array.DataArray, to_spec: smif.metadata.spec.Spec, coefficients: <MagicMock id='139764766168832'>)[source]

Convert a dataset between Spec definitions

Parameters:
Returns:
Return type:

numpy.ndarray
static convert_with_coefficients(data: <MagicMock id='139764766176880'>, coefficients: <MagicMock id='139764766192640'>, axis: int)[source]

Unchecked conversion, given data, coefficients and axis

Parameters:
Returns:
Return type:

numpy.ndarray
static get_convert_dims(from_spec, to_spec)[source]

Get dims for conversion from a pair of Spec, assuming only a single dimension will be converted.

Parameters:
  • from_spec (smif.metadata.Spec) –
  • to_spec (smif.metadata.Spec) –
Returns:
Return type:

tuple(str)