Data

Module for QOSST data specific to Bob.

class qosst_bob.data.ElectronicNoise(data: List[ndarray], detector: str | None = None, comment: str | None = None)

QOSST data class to hold electronic noise data.

Parameters:

data (List[np.ndarray]) – list of data, each element is a ndarray corresponding to a channel.
detector (Optional[str], optional) – name of the detector. Defaults to None.
comment (Optional[str], optional) – comment on the acquisition. Defaults to None.

data: List[ndarray]: The actual data that was acquired.

detector: str | None: Optional detector that was used for this electronic noise.

comment: str | None: Optional comment.

date: datetime: Datetime of the electronic noise acquisition.

class qosst_bob.data.ElectronicShotNoise(data: List[ndarray], detector: str | None = None, power: float | None = None, comment: str | None = None)

QOSST data class to hold electronic and shot noise data.

Parameters:

data (List[np.ndarray]) – list of data, each element is a ndarray corresponding to a channel.
detector (Optional[str], optional) – name of the detector. Defaults to None.
comment (Optional[str], optional) – comment on the acquisition. Defaults to None.

data: List[ndarray]: The actual data that was acquired.

detector: str | None: Optional detector that was used for this electronic noise.

power: float | None: Optional power.

comment: str | None: Optional comment.

date: datetime: Datetime of the electronic nois acquisition.

class qosst_bob.data.ExcessNoiseResults(configuration: Configuration, num_rep: int, excess_noise_bob: ndarray, transmittance: ndarray, photon_number: ndarray, datetimes: ndarray, electronic_noise: ndarray, shot_noise: ndarray, source_script: str, command_line: str)

Data class for the results of a qosst-bob-excess-noise measurement.

Parameters:

configuration (Configuration) – configuration that was used for the experiment.
num_rep (int) – number of repetitions in the experiment.
excess_noise_bob (np.ndarray) – array of estimated excess noise bob results (in SNU).
transmittance (np.ndarray) – array of estimated transmittance.
photon_number (np.ndarray) – array of photon numbers.
datetimes (np.ndarray) – list of datetime for each point.
electronic_noise (np.ndarray) – array of estimated electronic noise (in SNU).
shot_noise (np.ndarray) – array of estimated shot noise (in SNU).
source_script (str) – source script that was used for the experiment.
command_line (str) – command line that was used for the experiment.

configuration: Configuration: Configuration that was used for the experiment.

num_rep: int: Number of repetitions for this experiment.

excess_noise_bob: ndarray: Array of excess noise results.

transmittance: ndarray: Array of transmittance results.

photon_number: ndarray: Array of photon numbers.

datetimes: ndarray: List of datetimes for each point of the experiment.

electronic_noise: ndarray: Array of electronic noise (in SNU).

shot_noise: ndarray: Array of shot noise (in SNU).

source_script: str: Script that was used for this experiment.

command_line: str: Command line that was used for this experiment.

date: datetime: Datetime of the experiment.

class qosst_bob.data.TransmittanceResults(configuration: Configuration, num_rep: int, excess_noise_bob: ndarray, transmittance: ndarray, photon_number: ndarray, datetimes: ndarray, electronic_noise: ndarray, shot_noise: ndarray, source_script: str, command_line: str, attenuation_values: ndarray)

Data class for the results of a qosst-bob-transmittance measurement.

Parameters:

configuration (Configuration) – configuration that was used for the experiment.
num_rep (int) – number of repetitions in the experiment.
excess_noise_bob (np.ndarray) – array of estimated excess noise bob results (in SNU).
transmittance (np.ndarray) – array of estimated transmittance.
photon_number (np.ndarray) – array of photon numbers.
datetimes (np.ndarray) – list of datetime for each point.
electronic_noise (np.ndarray) – array of estimated electronic noise (in SNU).
shot_noise (np.ndarray) – array of estimated shot noise (in SNU).
source_script (str) – source script that was used for the experiment.
command_line (str) – command line that was used for the experiment.
attenuation_values (np.ndarray) – array of attenuation values for the tranmisttance experiment.

attenuation_values: ndarray: Array of attenuations for this particular experiment.

class qosst_bob.data.OptimizationResults(configuration: Configuration, num_rep: int, excess_noise_bob: ndarray, transmittance: ndarray, photon_number: ndarray, datetimes: ndarray, electronic_noise: ndarray, shot_noise: ndarray, source_script: str, command_line: str, parameters: Dict)

Data class for the results of a qosst-bob-optimize measurement.

Parameters:

configuration (Configuration) – configuration that was used for the experiment.
num_rep (int) – number of repetitions in the experiment.
excess_noise_bob (np.ndarray) – array of estimated excess noise bob results (in SNU).
transmittance (np.ndarray) – array of estimated transmittance.
photon_number (np.ndarray) – array of photon numbers.
datetimes (np.ndarray) – list of datetime for each point.
electronic_noise (np.ndarray) – array of estimated electronic noise (in SNU).
shot_noise (np.ndarray) – array of estimated shot noise (in SNU).
source_script (str) – source script that was used for the experiment.
command_line (str) – command line that was used for the experiment.
parameters (Dict) – dict of updated parameters.

parameters: Dict: Dict of updated parameters.