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.
Reference¶
-
class
smif.convert.adaptor.
Adaptor
(name)[source]¶ Bases:
smif.model.model.Model
Abstract Adaptor, to convert inputs/outputs between other Models
-
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:
-
convert
(data, from_spec, to_spec, coefficients)[source]¶ Convert a dataset between
Spec
definitionsParameters: - data (numpy.ndarray) –
- from_spec (smif.metadata.spec.Spec) –
- to_spec (smif.metadata.spec.Spec) –
- coefficients (numpy.ndarray) –
Returns: Return type:
-
static
convert_with_coefficients
(data, coefficients, axis)[source]¶ Unchecked conversion, given data, coefficients and axis
Parameters: - data (numpy.ndarray) –
- coefficients (numpy.ndarray) –
- axis (integer) – Axis along which to apply conversion coefficients
Returns: Return type:
-