sitem1d.iqspace module

The iqspace module is implements the parameter/uncertainty estimation from annotated I/Q model curves

class sitem1d.iqspace.IQModelResult(value: ndarray, value_attr: IQSpaceModelVariableAttr, offset: ndarray, misfit: ndarray, value_bounds: ndarray, annotation: ndarray | None = None, annotation_attr: IQSpaceModelVariableAttr | None = None, annotation_bounds: ndarray | None = None)

Bases: object

Data Container for the result of the IQ-space solver

class sitem1d.iqspace.IQObservation(channel: ChannelData, noise_power: float64 = nan)

Bases: object

Container for observed IQ values with additional information

class sitem1d.iqspace.IQObservationList(channels: List[ChannelData])

Bases: object

Container for a list of IQ observations, e.g. for a sensor with multiple channels

classmethod from_sensor_data(sensor_data: EMSensorData, noise_powers: Dict | None = None) → IQObservationList

Parameters:

• sensor_data –

• noise_powers –

Returns:

class sitem1d.iqspace.IQSpace(iq_models: IQSpaceModel | IQSpaceModelList | None = None, variant_max_misfit=None)

Bases: object

Contains the data and methods to retrieve information from annotated IQ model curves

add_iq_model(iq_model)

Add an iq model to the model pool :param iq_model: :return:

solve(observations: IQObservationList) → IQSpace

Solve the IQspace for a set of (inphase, quadrature) observations. :param observations: :return:

class sitem1d.iqspace.IQSpaceModel(channel: ChannelData, variable_value: ndarray, variable_attr: IQSpaceModelVariableAttr, annotation_value: ndarray | None = None, annotation_attr: IQSpaceModelVariableAttr | None = None)

Bases: object

This class is a data container for the model curves used in IQSpace to retrieve parameter by associated to the Inphase/Quadrature model by (Inphase, Quadrature) observations

classmethod from_ppm(ppm: ndarray, *args, **kwargs) → IQSpaceModel

A shortcut if inphase & quadrature exist in complex ppm annotation :param ppm: :param args: :param kwargs: :return:

class sitem1d.iqspace.IQSpaceModelList(models: List[IQSpaceModel] | None = None)

Bases: object

class sitem1d.iqspace.IQSpaceModelVariableAttr(long_name: str, units: str, standard_name: str | None = None)

Bases: object