Quanta Ray laser module

QuantaRay module for PLACE.

This module is designed to automate the process of turning the INDI laser on at the start of an experiment and turn it off at the end of the experiment.

class place.plugins.quanta_ray.quanta_ray.QuantaRayINDI(config, plotter)[source]

Device class for the QuantaRay INDI laser.

Warning

This automated module is not intended to replace any existing safety procedures. Please exercise caution so that unexpected behavior by this module does not pose a safety risk to yourself or others.

This class provides very basic automation of the INDI laser. The laser is turned on at the start of the experiment and it is not turned off until the cleanup method is called (typically at the end of an experiement).

The watchdog parameter can (and should) be used as a safety precaution, but understand that if the other steps of the experiment exceed the watchdog time, the laser will shut off, likely aborting the experiment. Therefore, in situations where the other steps of the experiment exceed 110 seconds (the watchdog maximum), the watchdog can be disabled by setting it to 0. However, please exercise extra caution when operating the laser without a watchdog, as a program error could cause the laser to run continuously until manually turned off.

QuantaRayINDI requires the following configuration data (accessible as self._config[‘key’]):

Key Type Meaning
power_percentage int the power setting for the laser
watchdog_time int the maximum number of seconds other tasks can be performed before the next laser command must be issued, or zero to disable watchdog

QuantaRayINDI will produce the following experimental metadata:

Key Type Meaning
oscillator_power int the oscillator power level returned from the device
repeat_rate int the repeat rate of laser pulses

QuantaRayINDI does not produce any experimental data.

config(metadata, total_updates)[source]

Configure the laser - turning off watchdog until repeat mode is selected.

Parameters:
  • metadata (dict) – metadata for the experiment
  • total_updates (int) – number of update that will be performed
update(update_number, progress)[source]

Do nothing. But send a command to the laser to reset the watchdog.

Parameters:
  • update_number (int) – the count of the current update (0-indexed)
  • progress (dict) – progress data that is sent to the web app
cleanup(abort=False)[source]

Turn off the laser.

Parameters:abort (bool) – flag indicating if the experiment is being aborted