resistics_readers.spam.calibration module¶

pydantic model resistics_readers.spam.calibration.SensorCalibration_RSP_RSPX_Base[source]¶

Bases: resistics.calibrate.SensorCalibrationReader

Base class for RSP and RSPX calibration data readers

Show JSON schema

{
   "title": "SensorCalibration_RSP_RSPX_Base",
   "description": "Base class for RSP and RSPX calibration data readers",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "extension": {
         "title": "Extension",
         "type": "string"
      },
      "file_str": {
         "title": "File Str",
         "default": "Metronix_Coil-----TYPE-$sensor_$chopper-ID-$serial$extension",
         "type": "string"
      }
   }
}

field file_str: str = 'Metronix_Coil-----TYPE-$sensor_$chopper-ID-$serial$extension'¶: The file string to search for. Various parameters will be substituted

pydantic model resistics_readers.spam.calibration.SensorCalibrationRSP[source]¶

Bases: resistics_readers.spam.calibration.SensorCalibration_RSP_RSPX_Base

Reader for RSP calibration files

RSP data is in units:

F [Hz]
Magnitude [mv/nT]
Phase [deg]

Data is returned with units:

F [Hz]
Magnitude [mV/nT]
Phase [radians]

The static gain for RSP files is applied to the magnitude as it is read in

Show JSON schema

{
   "title": "SensorCalibrationRSP",
   "description": "Reader for RSP calibration files\n\nRSP data is in units:\n\n- F [Hz]\n- Magnitude [mv/nT]\n- Phase [deg]\n\nData is returned with units:\n\n- F [Hz]\n- Magnitude [mV/nT]\n- Phase [radians]\n\nThe static gain for RSP files is applied to the magnitude as it is read in",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "extension": {
         "title": "Extension",
         "default": ".RSP",
         "type": "string"
      },
      "file_str": {
         "title": "File Str",
         "default": "Metronix_Coil-----TYPE-$sensor_$chopper-ID-$serial$extension",
         "type": "string"
      }
   }
}

field extension: str = '.RSP'¶

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

Read data from a RSP 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

pydantic model resistics_readers.spam.calibration.SensorCalibrationRSPX[source]¶

Bases: resistics_readers.spam.calibration.SensorCalibration_RSP_RSPX_Base

Read data from RSPX calibration file

RSPX data is in units:

F [Hz]
Magnitude [mv/nT]
Phase [deg]

Data is returned with units:

F [Hz]
Magnitude [mV/nT]
Phase [radians]

Static gain is applied to the magnitude

Show JSON schema

{
   "title": "SensorCalibrationRSPX",
   "description": "Read data from RSPX calibration file\n\nRSPX data is in units:\n\n- F [Hz]\n- Magnitude [mv/nT]\n- Phase [deg]\n\nData is returned with units:\n\n- F [Hz]\n- Magnitude [mV/nT]\n- Phase [radians]\n\nStatic gain is applied to the magnitude",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "extension": {
         "title": "Extension",
         "default": ".RSPX",
         "type": "string"
      },
      "file_str": {
         "title": "File Str",
         "default": "Metronix_Coil-----TYPE-$sensor_$chopper-ID-$serial$extension",
         "type": "string"
      }
   }
}

field extension: str = '.RSPX'¶

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

Read RSPX 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