pycsamt.metadata.instrument.SensorSpec#

class pycsamt.metadata.instrument.SensorSpec(sensor_type='induction_coil', model='', frequency_range=None, notes='')[source]#

Bases: object

Specification for a single sensor (magnetic or electric).

Parameters:
  • sensor_type ({"induction_coil", "fluxgate", "electrode", "other"}) – Physical transducer principle.

  • model (str) – Manufacturer model string, e.g. "MTC-150H".

  • frequency_range (tuple[float, float] or None) – (f_min, f_max) in Hz that the sensor is rated for.

  • notes (str) – Free-text annotation (calibration file name, mounting details, etc.).

Examples

>>> s = SensorSpec("induction_coil", "MTC-150H", (1e-5, 1e4))
>>> s.covers(0.1)
True
>>> s.covers(1e6)
False
__init__(sensor_type='induction_coil', model='', frequency_range=None, notes='')#
Parameters:
  • sensor_type (Literal['induction_coil', 'fluxgate', 'electrode', 'other'])

  • model (str)

  • frequency_range (tuple[float, float] | None)

  • notes (str)

Return type:

None

Methods

__init__([sensor_type, model, ...])

covers(frequency_hz)

Return True if frequency_hz lies within the rated band.

Attributes

sensor_type: Literal['induction_coil', 'fluxgate', 'electrode', 'other'] = 'induction_coil'#
model: str = ''#
frequency_range: tuple[float, float] | None = None#
notes: str = ''#
covers(frequency_hz)[source]#

Return True if frequency_hz lies within the rated band.

Parameters:

frequency_hz (float)

Return type:

bool