Experiment module

Manage domain concept about experimentation on the instrument.

class backscattermeter_analyzer.experiment.Acquisition(protocol: dataclasses.InitVar[ForwardRef('Protocol', is_class=True, owner=<class 'backscattermeter_analyzer.experiment.acquisition.acquisition.Acquisition'>)], data: dataclasses.InitVar[ForwardRef('TimeSeriesDict', is_class=True, owner=<class 'backscattermeter_analyzer.experiment.acquisition.acquisition.Acquisition'>)])

Acquisition result, associated to a protocol.

It defines data which have been acquired, and the change made during the acquisition.

class backscattermeter_analyzer.experiment.Analysis(representation: Representation)

Analysis task.

It defines a set of analysis to do from Result or Acquisition. It does not store result data, that can be generated using the analysis.run(), which will generate a Result.

run() → Result

Run the analysis and return a Result object.

backscattermeter_analyzer.experiment.AnalysisBuilder

alias of Builder

class backscattermeter_analyzer.experiment.Protocol(representation: Representation)

Description of required/wanted item for an acquisition.

It defines what channel should be acquired, what change should be made during the acquisition and the context required by the acquisition.

backscattermeter_analyzer.experiment.ProtocolBuilder

alias of Builder

class backscattermeter_analyzer.experiment.Result(representation: Representation)

Result associated to an analysis.

It defines all the values computed from other results/acquisitions through an analysis.