Skip to content

Data records

RealTimeData dataclass

RealTimeData(
    dt: datetime,
    count_rate: float,
    count_rate_err: float,
    dose_rate: float,
    dose_rate_err: float,
    flags: int,
    real_time_flags: int,
)

Real-time radiation measurement data from the device.

Attributes:

Name Type Description
dt datetime

Timestamp of the measurement

count_rate float

Number of counts per second

count_rate_err float

Count rate error percentage

dose_rate float

Radiation dose rate in device protocol units

dose_rate_err float

Dose rate measurement error percentage

flags int

Status flags for the measurement

real_time_flags int

Real-time status flags

RawData dataclass

RawData(dt: datetime, count_rate: float, dose_rate: float)

Raw radiation measurement data without error calculations.

Attributes:

Name Type Description
dt datetime

Timestamp of the measurement

count_rate float

Number of counts per second

dose_rate float

Radiation dose rate in device protocol units

DoseRateDB dataclass

DoseRateDB(
    dt: datetime,
    count: int,
    count_rate: float,
    dose_rate: float,
    dose_rate_err: float,
    flags: int,
)

Database record for dose rate measurements.

Attributes:

Name Type Description
dt datetime

Timestamp of the measurement

count int

Total number of counts in the measurement period

count_rate float

Number of counts per second

dose_rate float

Radiation dose rate in device protocol units

dose_rate_err float

Dose rate measurement error percentage

flags int

Status flags for the measurement

RareData dataclass

RareData(
    dt: datetime,
    duration: int,
    dose: float,
    temperature: float,
    charge_level: float,
    flags: int,
)

Periodic device status and accumulated dose data.

Attributes:

Name Type Description
dt datetime

Timestamp of the status reading

duration int

Duration of dose accumulation in seconds

dose float

Accumulated dose in device protocol units

temperature float

Device temperature in degrees Celsius

charge_level float

Battery charge level as a percentage

flags int

Status flags

Event dataclass

Event(
    dt: datetime,
    event: EventId,
    event_param1: int,
    flags: int,
)

Device event record.

Attributes:

Name Type Description
dt datetime

Timestamp of the event

event int

Event type identifier

event_param1 int

Event-specific parameter

flags int

Event flags

Spectrum dataclass

Spectrum(
    duration: timedelta,
    a0: float,
    a1: float,
    a2: float,
    counts: list[int],
)

Radiation energy spectrum measurement data.

Attributes:

Name Type Description
duration timedelta

Measurement duration

a0 float

Energy calibration coefficient (offset)

a1 float

Energy calibration coefficient (linear)

a2 float

Energy calibration coefficient (quadratic)

counts list[int]

List of counts per energy channel

AlarmLimits dataclass

AlarmLimits(
    l1_count_rate: float,
    l2_count_rate: float,
    count_unit: str,
    l1_dose_rate: float,
    l2_dose_rate: float,
    l1_dose: float,
    l2_dose: float,
    dose_unit: str,
)

Count-rate, dose-rate, and accumulated-dose alarm limits.

The count rate may be per second or per minute depending on device configuration. The count_unit attribute indicates which.

Dose rate is in micro-units (Sv or R) per hour, and accumulated dose is in micro-units (Sv or R). dose_unit identifies the configured unit. The device appears to use a fixed 100 Sv/R conversion internally.

Attributes:

Name Type Description
l1_count_rate float

Count-rate threshold for the level-one alarm.

l2_count_rate float

Count-rate threshold for the level-two alarm.

count_unit str

Count-rate unit, either "cps" or "cpm".

l1_dose_rate float

Dose-rate threshold for the level-one alarm.

l2_dose_rate float

Dose-rate threshold for the level-two alarm.

l1_dose float

Accumulated-dose threshold for the level-one alarm.

l2_dose float

Accumulated-dose threshold for the level-two alarm.

dose_unit str

Dose unit, either "Sv" or "R".