b22ao: API for B22 adaptive optics operations

This package provides the basic API for Adaptive Optics scripts running at beamline B22 in Diamond Light Source.

Adaptive Optics operations must implement b22ao.base.BaseOperation, which provides methods for deforming mirrors and capturing images. The implementation is run by the AO manager which will inject any given JSON configuration file.

Example:

from b22ao.base import BaseOperation
import numpy

class MyAO(BaseOperation):
    def start(self):
        max_iter = self.config['max_iter']

        self.select_dm(self.config['mirror'])

        self.stopping = False
        for iter in range(max_iter):
            if self.stopping:
                self.stopping = False
                break
            self.deform(numpy.zeros(97))
            self.capture()
    
        print("Finished!")

    def stop(self):
        self.stopping = True

And the configuration file:

{
  "max_iter": 300,
  "mirror": 2
}

Gotchas

1. The ZMQ_SERVER address

The ZMQ_SERVER global variable needs to point to the maching currently running pywincam, which will send the images over. When the workstation is changed/upgraded, the zmq server address needs to be updated too. It is currently using the b22-down-11 endstation (as of Jan. 26), thus the configuration is:

ZMQ_SERVER = "b22-down-11.diamond.ac.uk" 
ZMQ_DATA_PORT = 1515
ZMQ_CAMERA_TRIGGER_PORT = 1516