sitem1d.cal module

class sitem1d.cal.ChannelCalibration(channel_def: ChannelDefinition)

Bases: object

A Parent class for channel calibration data

calibrate_channel_data(*args, **kwargs)

class sitem1d.cal.ChannelCalibrationData(cal_obj, model=None, obs=None, obs_cal=None)

Bases: object

A data container for Channel Calibration Data

class sitem1d.cal.DeviceCalibrationData(channels, sensor_def, metadata=None)

Bases: object

Container for calibration data for :DEPR Is this still in use?

write_to_yaml(filepath): Create a yaml export file :param filepath: :return:

class sitem1d.cal.GainPhaseOffsetCal(offset: complex | None = None, gain: float | None = None, phase: float | None = None, channel_def: ChannelDefinition | None = None)

Bases: ChannelCalibration

A class calibrating a ppm signal by known offset (i0, q0) and gain/phase settings. Values can either by static or arrays. If calibration parameters are arrays then the dimension must be a match with the dimension of the channel.

property attribute_dict

calibrate_channel_data(channel_data: ChannelData | EMChannel) → ChannelData | EMChannel: Applies the calibration to a channel data data object :param channel_data: sitem1d.ChannelData :return:

class sitem1d.cal.ModelCurveCalibration(model, obs, channel_def=None)

Bases: object

This class contains the functionality to compute offset, gain and phase values to minimize the observed and reference observations.

property final_misfit

property final_params

property gain

minimize_func(params): The function to be called by scipy.optimize.minimize. It computes the cummulative distance between observed and modelled points as cost function (model misfit). :param params :return: misfit: (float) The model misfit

property n_iterations

property offset

property phase

class sitem1d.cal.NullCal(channel_def: ChannelDefinition)

Bases: ChannelCalibration

Calibration class that leaves ppms unchanged

calibrate_channel_data(channel): API method

property channel_ids

class sitem1d.cal.SensorCalibration(channel_calibrations: Dict | None = None, sensor_def: EMSensorDefinition | None = None)

Bases: object

add(channel_calibration: ChannelCalibration) → None: Add a channel calibration :param channel_calibration: :return:

get(channel_id: str) → ChannelCalibration: Get the channel calibration for a specific channel :param channel_id: :return: