pcdsutils.info.Instrument

class pcdsutils.info.Instrument(hutch: str, daq_base: str = '', instrument: str = '', station: int = 0, config_filename: str = '', nstations: int = 0, station_valid: bool = False, experiment: ~pcdsutils.info.Experiment = <factory>, run: ~pcdsutils.info.Run = <factory>)[source]

Per-instrument information.

Methods

fix_parameters([ended])

Based on user-provided experimental state information, adjust the instrument information.

from_hutch(hutch[, station])

Get Instrument information given a hutch and (optional) station number.

update_from_logbook([experiment_name])

Update information by querying the logbook.

__init__(hutch: str, daq_base: str = '', instrument: str = '', station: int = 0, config_filename: str = '', nstations: int = 0, station_valid: bool = False, experiment: ~pcdsutils.info.Experiment = <factory>, run: ~pcdsutils.info.Run = <factory>) None

Methods

__init__(hutch[, daq_base, instrument, ...])

fix_parameters([ended])

Based on user-provided experimental state information, adjust the instrument information.

from_hutch(hutch[, station])

Get Instrument information given a hutch and (optional) station number.

update_from_logbook([experiment_name])

Update information by querying the logbook.

Attributes

config_filename

The daq configuration file name.

daq_base

The daq base.

instrument

The instrument name.

nstations

The total number of stations.

station

The station number.

station_valid

Whether the station number is valid or not.

hutch

The hutch name.

experiment

Experiment-related information.

run

Run-related information.