percival package

The Percival User Interface consist of a number of python classes which can be used to control and read out data from the Percival detector system.

The following document the API for these classes. The classes can also be used in interactive python sessions where users directly call the relevant functions to control the system. In fact this use-case is recommended to begin with.

percival.percivalui module

The main PercivalUI module

class percival.percivalui.CarrierBoard

Bases: object

Implements the percival.detector.interface.IControl interface for the Percival Carrier Board

class percival.percivalui.MezzanineBoard

Bases: percival.detector.interface.IData

Model the hardware Mezzanine Board

start_capture(filename, nframes)

Implements interface: detector.interface.IData.start_capture()

wait_complete(timeout)

Implements interface: detector.interface.IData.wait_complete()

class percival.percivalui.PercivalSimulator

Top-level simulator of the Percival system

Mostly just used for demo purposes as it has very little functionality in itself

class percival.percivalui.PercivalUI

Bases: object

Top-level class which allow control and monitoring of the entire Percival detector system.

Internally maintains objects that implement control and data monitoring.

acquire(exposure, nframes=1, wait=True)

Start the detector acquiring data