Source code for prsctrl_gui.measurement.settings

"""Measurement settings dataclass for prsctrl-gui."""
from typing import Optional
from prsctrl.measurement.settings import PrsSettings, dataclass, field



@dataclass
class PrsGuiSettings(PrsSettings):
    """Main measurement settings dataclass for prsctrl-gui.

    Inherits `.PrsSettings` and only adds GUI-specific fields.

    This class is is used a base for the :py:class:`~prsctrl_gui.task.tasks.MeasurementTask`.
    """
    sample_key: Optional[str] = field(
        default=None,
        metadata={"doc": "Key of a sample in the sample database.\nSample information is added as metadata to the measurement data."}
    )
    power_calibration_key: Optional[str] = field(
        default=None,
        metadata={"doc": "Key of a power calibration in the database.\nOnly used when `pump_source` is 'laser' or 'led' and `pump_power_mWcm2` is given."}
    )
    setup_info_key: Optional[str] = field(
        default=None,
        metadata={"doc": "Key of a setup information entry in the database."}
    )
    additional_metadata: dict[str, str] = field(
        default_factory=dict,
        metadata={"doc": "Additional metadata for this measurement."}
    )