resistics_readers.metronix.calibration module

pydantic model resistics_readers.metronix.calibration.SensorCalibrationMetronix

Bases: resistics.calibrate.SensorCalibrationReader

Metronix calibration data has the following units

• F [Hz]

• Magnitude [V/nT*Hz]

• Phase [deg]

For both chopper on and off.

Data is returned with units:

• F [Hz]

• Magnitude [mV/nT]

• Phase [radians]

Static gain is set to 1 as this is already included in the magnitude

It is recommended to do extension of the calibration data here as the calibration data should be extended in the original units.

Show JSON schema

{
   "title": "SensorCalibrationMetronix",
   "description": "Metronix calibration data has the following units\n\n- F [Hz]\n- Magnitude [V/nT*Hz]\n- Phase [deg]\n\nFor both chopper on and off.\n\nData is returned with units:\n\n- F [Hz]\n- Magnitude [mV/nT]\n- Phase [radians]\n\nStatic gain is set to 1 as this is already included in the magnitude\n\nIt is recommended to do extension of the calibration data here as the\ncalibration data should be extended in the original units.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "extension": {
         "title": "Extension",
         "default": ".TXT",
         "type": "string"
      },
      "file_str": {
         "title": "File Str",
         "default": "$sensor$serial$extension",
         "type": "string"
      },
      "extend": {
         "title": "Extend",
         "default": true,
         "type": "boolean"
      },
      "extend_low": {
         "title": "Extend Low",
         "default": 1e-05,
         "type": "number"
      },
      "extend_high": {
         "title": "Extend High",
         "default": 1000000,
         "type": "number"
      }
   }
}

field extension: str = '.TXT'

field file_str: str = '$sensor$serial$extension'

field extend: bool = True

field extend_low: float = 1e-05

field extend_high: float = 1000000

read_calibration_data(file_path: pathlib.Path, chan_metadata: resistics.time.ChanMetadata) → resistics.calibrate.CalibrationData

Read data from metronix calibration file

Parameters

• file_path (Path) – The file path of the calibration file

• chan_metadata (ChanMetadata) – The channel metadata for the channel to be calibrated

Returns

The calibration data

Return type

CalibrationData