Skip to content

Codi

CoDI

Source code in dod/codi.py 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
class CoDI: 
    def __init__(self, reload_presets = False):
        """
        Class definition of the DoD codi injector 
        Parameters
        reload_presets : Boolean
            force resetting the presets (overwriting existing hutch presets)
        ----------
        """

        from pcdsdevices.device import ObjectComponent as OCpt
        from pcdsdevices.epics_motor import SmarAct, Motor
        import time

        # CoDI motor PVs loading 
        self.CoDI_rot_left = SmarAct('MFX:MCS2:01:m3', name='CoDI_rot_left')
        self.CoDI_rot_right = SmarAct('MFX:MCS2:01:m1', name='CoDI_rot_right')
        self.CoDI_rot_base = SmarAct('MFX:MCS2:01:m2', name='CoDI_rot_base')
        self.CoDI_trans_z = SmarAct('MFX:MCS2:01:m4', name='CoDI_trans_z')

        #Predefined positions CoDI
        self.CoDI_pos_predefined = dict()

        if reload_presets == True: 
            # self.CoDI_pos_predefined['aspiration'] = (0.0,0.0,0.0,0.0) 
            # self.CoDI_pos_predefined['angled_vert'] = (0.0,45.0,45.0,0.0)
            # self.CoDI_pos_predefined['angled_hor'] = (90.0,45.0,45.0,0.0)

            self.set_CoDI_predefined('aspiration',0.0,0.0,0.0,0.0)
            self.set_CoDI_predefined('angled_vert',0.0,45.0,45.0,0.0)
            self.set_CoDI_predefined('angled_hor',90.0,45.0,45.0,0.0)
        else: 
            all_presets = vars(self.CoDI_rot_left.presets.positions) #Needs to be fixed
            for preset, preset_value in all_presets.items(): 
                try: 
                    # get preset position
                    exec_base = "preset_rot_base = self.CoDI_rot_base.presets.positions." + preset + '.pos'
                    exec_rot_left = "preset_rot_left = self.CoDI_rot_left.presets.positions." + preset + '.pos'
                    exec_rot_right = "preset_rot_right = self.CoDI_rot_right.presets.positions." + preset + '.pos'
                    exec_trans_z = "preset_trans_z = self.CoDI_trans_z.presets.positions." + preset + '.pos'
                    exec(exec_base)
                    exec(exec_rot_left)
                    exec(exec_rot_right)
                    exec(exec_trans_z)

                    # Save to local database
                    print(preset)
                    self.set_CoDI_predefined(preset, preset_rot_base, preset_rot_left, preset_rot_right, preset_trans_z)
                except: 
                    print('skipping preset '+ preset + ', as it is not defined in all motors')    


        # # create config parser handler
        # json_handler = JsonFileHandler(supported_json)
        # # load configs and launch web server
        # json_handler.reload_endpoints()

        # Flag that can be used later on for safety aborts during task execution
        self.safety_abort = False


    def get_CoDI_predefined(self):


        return self.CoDI_pos_predefined


    def update_CoDI_predefined(self): 
        'reloads all the hutch python presets for motors and overwrites local position preset dict'

        #Predefined positions CoDI
        self.CoDI_pos_predefined = dict()

        all_presets = vars(self.CoDI_rot_left.presets.positions) #Needs to be fixed
        for preset in all_presets.keys(): 
            # try: 
            # get preset position
            self.exec_base = "preset_rot_base = self.CoDI_rot_base.presets.positions." + preset + '.pos'
            self.exec_rot_left = "preset_rot_left = self.CoDI_rot_left.presets.positions." + preset + '.pos'
            self.exec_rot_right = "preset_rot_right = self.CoDI_rot_right.presets.positions." + preset + '.pos'
            self.exec_trans_z = "preset_trans_z = self.CoDI_trans_z.presets.positions." + preset + '.pos'
            print(self.exec_base)
            exec(self.exec_base)

            exec(self.exec_rot_left)
            print(self.exec_rot_left)

            exec(self.exec_rot_right)
            print(self.exec_rot_left)

            exec(self.exec_trans_z)
            print(self.exec_trans_z)
            print(preset_trans_z)

            # Save to local database
            print(preset)
            self.set_CoDI_predefined(preset, preset_rot_base, preset_rot_left, preset_rot_right, preset_trans_z)
            # except: 
            #     print('skipping preset '+ preset + ', as it is not defined in all motors')    

    def set_CoDI_predefined(self, name, base, left, right, z):
        """
        defines or updates a predefined combination for CoDI

        Parameters
        name : str
            name of the pre-definition
        base : float
            rotation of base
        left : float
            rotation of left injector
        right : float
            rotation of right injector
        z : float
            translation of right injector
        ----------

        """
        self.CoDI_pos_predefined.update({name: (base,left, right, z)})

        # Presets using MFX presets functionalities 
        self.CoDI_rot_left.presets.add_hutch(name, value = left)
        self.CoDI_rot_right.presets.add_hutch(name, value = right)
        self.CoDI_rot_base.presets.add_hutch(name, value = base)
        self.CoDI_trans_z.presets.add_hutch(name, value = z)



    def get_CoDI_pos(self, precision_digits = 1): 
        """
        gets the colliding droplet injector motor positions as tuple

        Parameters
        precision_digits : int
            precision with which the pre-defined positions are checked 

        ----------
        Return : (tuple, 5)
            motor positions of the CoDI motors. (name of preset, rot_base, rot_left, rot_right, trans_z)
        """
        pos_rot_base  = self.CoDI_rot_base.wm()
        pos_rot_left  = self.CoDI_rot_left.wm()
        pos_rot_right = self.CoDI_rot_right.wm()
        pos_trans_z   = self.CoDI_trans_z.wm()

        # # for testing purposes
        # pos_rot_base  = 0
        # pos_rot_left  = 45
        # pos_rot_right = 45
        # pos_trans_z   = 0

        pos_tuple = (pos_rot_base,pos_rot_left, pos_rot_right,pos_trans_z)

        pos_rounded = tuple([float(round(each_pos,1)) for each_pos in pos_tuple])

        # Test if this is one of the preset positions: 
        pos_name = 'undefined'
        for preset in self.CoDI_pos_predefined:
            preset_rounded = tuple([float(round(each_pos,1)) for each_pos in self.CoDI_pos_predefined[preset]])
            if preset_rounded[:-1] == pos_rounded[:-1]: 
                pos_name = preset

        return pos_name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z


    def set_CoDI_pos(self, pos_name, wait = True): 
        """
        Moves the colliding droplet injector into a pre-defined position. 

        Parameters
        pos_name : string
            name of the pre-defined position
        wait : boolean
            if the robot waits before continuing further steps

        ----------
        Return : 

        """
        # pos_rot_base  = CoDI_base.wm()
        # pos_rot_left  = CoDI_left.wm()
        # pos_rot_right = CoDI_right.wm()
        # pos_trans_z   = CoDI_z.wm()
        import time

        # get target positions
        pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z = self.CoDI_pos_predefined[pos_name]

        # Move motors

        # Old wayy 
        # self.CoDI_rot_base.mv(pos_rot_base, wait=False)
        # self.CoDI_rot_left.mv(pos_rot_left,  wait=False)
        # self.CoDI_rot_right.mv(pos_rot_right, wait=False)
        # self.CoDI_trans_z.mv(pos_trans_z, wait=False)

        # Move using hutch python presets
        exec_base = "self.CoDI_rot_base.mv_" + pos_name + '()'
        exec(exec_base)
        exec_left = "self.CoDI_rot_left.mv_" + pos_name + '()'
        exec(exec_left)
        exec_right = "self.CoDI_rot_right.mv_" + pos_name + '()'
        exec(exec_right)
        exec_z = "self.CoDI_trans_z.mv_" + pos_name + '()'
        exec(exec_z)

        if wait == True: 
            test_name, test_pos_rot_base, test_pos_rot_left, test_pos_rot_right, test_pos_trans_z = self.get_CoDI_pos()
            i = 0
            while pos_name != test_name: 
                time.sleep(1)
                print('\r waiting for motion to end: %i s' %i, end="\r")
                i = i+1
                test_name, test_pos_rot_base, test_pos_rot_left, test_pos_rot_right, test_pos_trans_z = self.get_CoDI_pos()
            print('Motion ended')


    def set_CoDI_current_pos(self, name):
        """
        defines or updates the current motor combination for CoDI

        Parameters
        name : str
            name of the pre-definition
        ----------

        """
        pos_name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z = self.get_CoDI_pos()
        self.set_CoDI_predefined(name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z)


    def set_CoDI_current_z(self, verbose = True):
        """
        sets the current z position to all preloaded positions
        Useful for global change of z after aligning

        Parameters
        verbose : Boolean
            prints the new positions as a sanity check if True
        ----------

        """
        # get current z position:
        pos_trans_z_new  = self.CoDI_trans_z.wm()

        # get all keys from the positions
        position_keys = self.CoDI_pos_predefined.keys

        #go through all positions and change the z-value to the current z value
        for key in position_keys: 
            pos_name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z = self.CoDI_pos_predefined[key]
            self.set_CoDI_predefined(pos_name,pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z_new)

        #Print the new predefined positions as a sanity check
        if verbose == True:
            print(self.get_CoDI_predefined)


    def remove_CoDI_pos(self, name):
        """
        removes the defined motor combination for CoDI from local database

        Parameters
        name : str
            name of the pre-definition to be deleted
        ----------

        """
        del self.CoDI_pos_predefined[name]


    def move_z_rel(self, z_rel):
        """
        moves the z position relative to the current position 

        Parameters
        z_rel : float
            relative motion in mm
        ----------

        """
        # get current z position:
        pos_trans_z  = self.CoDI_trans_z.wm()

        # set new position
        self.CoDI_trans_z.umvr(z_rel)

    def move_rot_left_rel(self, rot_rel):
        """
        moves the rotation of the left nozzle relative to the current position in degree

        Parameters
        rot_rel : float
            relative motion in degree
        ----------

        """
        # get current position:
        pos_rot_left  = self.CoDI_rot_left.wm()

        # set new position: 
        self.CoDI_rot_left.umvr(rot_rel)


    def move_rot_right_rel(self, rot_rel):
        """
        moves the rotation of the right nozzle relative to the current position in degree

        Parameters
        rot_rel : float
            relative motion in degree
        ----------

        """
        # get current position:
        pos_rot_right  = self.CoDI_rot_right.wm()

        # set new position: 
        self.CoDI_rot_right.umvr(rot_rel)


    def move_rot_base_rel(self, rot_rel):
        """
        moves the rotation of the base relative to the current position in degree

        Parameters
        rot_rel : float
            relative motion in degree
        ----------

        """
        # get current position:
        pos_rot_base  = self.CoDI_rot_base.wm()

        # set new position: 
        self.CoDI_rot_base.umvr(rot_rel)


    def move_z_abs(self, z_abs):
        """
        moves the z position to the absolute position in mm

        Parameters
        z_abs : float
            absolute motion in mm
        ----------

        """
        # move z position:
        self.CoDI_trans_z.umv(z_abs)


    def move_rot_left_abs(self, rot_abs):
            """
            moves the rotation of the left nozzle to the absolute position in degree

            Parameters
            rot_abs : float
                abs motion in degree
            ----------

            """

            # set new position: 
            self.CoDI_rot_left.umv(rot_abs)


    def move_rot_right_abs(self, rot_abs):
            """
            moves the rotation of the right nozzle to the absolute position in degree

            Parameters
            rot_abs : float
                abs motion in degree
            ----------

            """

            # set new position: 
            self.CoDI_rot_right.umv(rot_abs)


    def move_rot_base_abs(self, rot_abs):
            """
            moves the rotation of the base to the absolute position in degree

            Parameters
            rot_abs : float
                abs motion in degree
            ----------

            """

            # set new position: 
            self.CoDI_rot_base.umv(rot_abs)

__init__(reload_presets=False)

Class definition of the DoD codi injector Parameters reload_presets : Boolean

force resetting the presets (overwriting existing hutch presets)
Source code in dod/codi.py 
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def __init__(self, reload_presets = False):
    """
    Class definition of the DoD codi injector 
    Parameters
    reload_presets : Boolean
        force resetting the presets (overwriting existing hutch presets)
    ----------
    """

    from pcdsdevices.device import ObjectComponent as OCpt
    from pcdsdevices.epics_motor import SmarAct, Motor
    import time

    # CoDI motor PVs loading 
    self.CoDI_rot_left = SmarAct('MFX:MCS2:01:m3', name='CoDI_rot_left')
    self.CoDI_rot_right = SmarAct('MFX:MCS2:01:m1', name='CoDI_rot_right')
    self.CoDI_rot_base = SmarAct('MFX:MCS2:01:m2', name='CoDI_rot_base')
    self.CoDI_trans_z = SmarAct('MFX:MCS2:01:m4', name='CoDI_trans_z')

    #Predefined positions CoDI
    self.CoDI_pos_predefined = dict()

    if reload_presets == True: 
        # self.CoDI_pos_predefined['aspiration'] = (0.0,0.0,0.0,0.0) 
        # self.CoDI_pos_predefined['angled_vert'] = (0.0,45.0,45.0,0.0)
        # self.CoDI_pos_predefined['angled_hor'] = (90.0,45.0,45.0,0.0)

        self.set_CoDI_predefined('aspiration',0.0,0.0,0.0,0.0)
        self.set_CoDI_predefined('angled_vert',0.0,45.0,45.0,0.0)
        self.set_CoDI_predefined('angled_hor',90.0,45.0,45.0,0.0)
    else: 
        all_presets = vars(self.CoDI_rot_left.presets.positions) #Needs to be fixed
        for preset, preset_value in all_presets.items(): 
            try: 
                # get preset position
                exec_base = "preset_rot_base = self.CoDI_rot_base.presets.positions." + preset + '.pos'
                exec_rot_left = "preset_rot_left = self.CoDI_rot_left.presets.positions." + preset + '.pos'
                exec_rot_right = "preset_rot_right = self.CoDI_rot_right.presets.positions." + preset + '.pos'
                exec_trans_z = "preset_trans_z = self.CoDI_trans_z.presets.positions." + preset + '.pos'
                exec(exec_base)
                exec(exec_rot_left)
                exec(exec_rot_right)
                exec(exec_trans_z)

                # Save to local database
                print(preset)
                self.set_CoDI_predefined(preset, preset_rot_base, preset_rot_left, preset_rot_right, preset_trans_z)
            except: 
                print('skipping preset '+ preset + ', as it is not defined in all motors')    


    # # create config parser handler
    # json_handler = JsonFileHandler(supported_json)
    # # load configs and launch web server
    # json_handler.reload_endpoints()

    # Flag that can be used later on for safety aborts during task execution
    self.safety_abort = False

get_CoDI_pos(precision_digits=1)

gets the colliding droplet injector motor positions as tuple

Parameters precision_digits : int precision with which the pre-defined positions are checked

Return : (tuple, 5) motor positions of the CoDI motors. (name of preset, rot_base, rot_left, rot_right, trans_z)

Source code in dod/codi.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def get_CoDI_pos(self, precision_digits = 1): 
    """
    gets the colliding droplet injector motor positions as tuple

    Parameters
    precision_digits : int
        precision with which the pre-defined positions are checked 

    ----------
    Return : (tuple, 5)
        motor positions of the CoDI motors. (name of preset, rot_base, rot_left, rot_right, trans_z)
    """
    pos_rot_base  = self.CoDI_rot_base.wm()
    pos_rot_left  = self.CoDI_rot_left.wm()
    pos_rot_right = self.CoDI_rot_right.wm()
    pos_trans_z   = self.CoDI_trans_z.wm()

    # # for testing purposes
    # pos_rot_base  = 0
    # pos_rot_left  = 45
    # pos_rot_right = 45
    # pos_trans_z   = 0

    pos_tuple = (pos_rot_base,pos_rot_left, pos_rot_right,pos_trans_z)

    pos_rounded = tuple([float(round(each_pos,1)) for each_pos in pos_tuple])

    # Test if this is one of the preset positions: 
    pos_name = 'undefined'
    for preset in self.CoDI_pos_predefined:
        preset_rounded = tuple([float(round(each_pos,1)) for each_pos in self.CoDI_pos_predefined[preset]])
        if preset_rounded[:-1] == pos_rounded[:-1]: 
            pos_name = preset

    return pos_name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z

move_rot_base_abs(rot_abs)

moves the rotation of the base to the absolute position in degree

Parameters rot_abs : float

abs motion in degree
Source code in dod/codi.py 
383
384
385
386
387
388
389
390
391
392
393
394
395
def move_rot_base_abs(self, rot_abs):
        """
        moves the rotation of the base to the absolute position in degree

        Parameters
        rot_abs : float
            abs motion in degree
        ----------

        """

        # set new position: 
        self.CoDI_rot_base.umv(rot_abs)

move_rot_base_rel(rot_rel)

moves the rotation of the base relative to the current position in degree

Parameters rot_rel : float

relative motion in degree
Source code in dod/codi.py 
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
def move_rot_base_rel(self, rot_rel):
    """
    moves the rotation of the base relative to the current position in degree

    Parameters
    rot_rel : float
        relative motion in degree
    ----------

    """
    # get current position:
    pos_rot_base  = self.CoDI_rot_base.wm()

    # set new position: 
    self.CoDI_rot_base.umvr(rot_rel)

move_rot_left_abs(rot_abs)

moves the rotation of the left nozzle to the absolute position in degree

Parameters rot_abs : float

abs motion in degree
Source code in dod/codi.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
def move_rot_left_abs(self, rot_abs):
        """
        moves the rotation of the left nozzle to the absolute position in degree

        Parameters
        rot_abs : float
            abs motion in degree
        ----------

        """

        # set new position: 
        self.CoDI_rot_left.umv(rot_abs)

move_rot_left_rel(rot_rel)

moves the rotation of the left nozzle relative to the current position in degree

Parameters rot_rel : float

relative motion in degree
Source code in dod/codi.py 
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
def move_rot_left_rel(self, rot_rel):
    """
    moves the rotation of the left nozzle relative to the current position in degree

    Parameters
    rot_rel : float
        relative motion in degree
    ----------

    """
    # get current position:
    pos_rot_left  = self.CoDI_rot_left.wm()

    # set new position: 
    self.CoDI_rot_left.umvr(rot_rel)

move_rot_right_abs(rot_abs)

moves the rotation of the right nozzle to the absolute position in degree

Parameters rot_abs : float

abs motion in degree
Source code in dod/codi.py 
368
369
370
371
372
373
374
375
376
377
378
379
380
def move_rot_right_abs(self, rot_abs):
        """
        moves the rotation of the right nozzle to the absolute position in degree

        Parameters
        rot_abs : float
            abs motion in degree
        ----------

        """

        # set new position: 
        self.CoDI_rot_right.umv(rot_abs)

move_rot_right_rel(rot_rel)

moves the rotation of the right nozzle relative to the current position in degree

Parameters rot_rel : float

relative motion in degree
Source code in dod/codi.py 
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
def move_rot_right_rel(self, rot_rel):
    """
    moves the rotation of the right nozzle relative to the current position in degree

    Parameters
    rot_rel : float
        relative motion in degree
    ----------

    """
    # get current position:
    pos_rot_right  = self.CoDI_rot_right.wm()

    # set new position: 
    self.CoDI_rot_right.umvr(rot_rel)

move_z_abs(z_abs)

moves the z position to the absolute position in mm

Parameters z_abs : float

absolute motion in mm
Source code in dod/codi.py 
339
340
341
342
343
344
345
346
347
348
349
350
def move_z_abs(self, z_abs):
    """
    moves the z position to the absolute position in mm

    Parameters
    z_abs : float
        absolute motion in mm
    ----------

    """
    # move z position:
    self.CoDI_trans_z.umv(z_abs)

move_z_rel(z_rel)

moves the z position relative to the current position

Parameters z_rel : float

relative motion in mm
Source code in dod/codi.py 
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
def move_z_rel(self, z_rel):
    """
    moves the z position relative to the current position 

    Parameters
    z_rel : float
        relative motion in mm
    ----------

    """
    # get current z position:
    pos_trans_z  = self.CoDI_trans_z.wm()

    # set new position
    self.CoDI_trans_z.umvr(z_rel)

remove_CoDI_pos(name)

removes the defined motor combination for CoDI from local database

Parameters name : str

name of the pre-definition to be deleted
Source code in dod/codi.py 
259
260
261
262
263
264
265
266
267
268
269
def remove_CoDI_pos(self, name):
    """
    removes the defined motor combination for CoDI from local database

    Parameters
    name : str
        name of the pre-definition to be deleted
    ----------

    """
    del self.CoDI_pos_predefined[name]

set_CoDI_current_pos(name)

defines or updates the current motor combination for CoDI

Parameters name : str

name of the pre-definition
Source code in dod/codi.py 
218
219
220
221
222
223
224
225
226
227
228
229
def set_CoDI_current_pos(self, name):
    """
    defines or updates the current motor combination for CoDI

    Parameters
    name : str
        name of the pre-definition
    ----------

    """
    pos_name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z = self.get_CoDI_pos()
    self.set_CoDI_predefined(name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z)

set_CoDI_current_z(verbose=True)

sets the current z position to all preloaded positions Useful for global change of z after aligning

Parameters verbose : Boolean

prints the new positions as a sanity check if True
Source code in dod/codi.py 
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def set_CoDI_current_z(self, verbose = True):
    """
    sets the current z position to all preloaded positions
    Useful for global change of z after aligning

    Parameters
    verbose : Boolean
        prints the new positions as a sanity check if True
    ----------

    """
    # get current z position:
    pos_trans_z_new  = self.CoDI_trans_z.wm()

    # get all keys from the positions
    position_keys = self.CoDI_pos_predefined.keys

    #go through all positions and change the z-value to the current z value
    for key in position_keys: 
        pos_name, pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z = self.CoDI_pos_predefined[key]
        self.set_CoDI_predefined(pos_name,pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z_new)

    #Print the new predefined positions as a sanity check
    if verbose == True:
        print(self.get_CoDI_predefined)

set_CoDI_pos(pos_name, wait=True)

Moves the colliding droplet injector into a pre-defined position.

Parameters pos_name : string name of the pre-defined position wait : boolean if the robot waits before continuing further steps

Return :

Source code in dod/codi.py 
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
def set_CoDI_pos(self, pos_name, wait = True): 
    """
    Moves the colliding droplet injector into a pre-defined position. 

    Parameters
    pos_name : string
        name of the pre-defined position
    wait : boolean
        if the robot waits before continuing further steps

    ----------
    Return : 

    """
    # pos_rot_base  = CoDI_base.wm()
    # pos_rot_left  = CoDI_left.wm()
    # pos_rot_right = CoDI_right.wm()
    # pos_trans_z   = CoDI_z.wm()
    import time

    # get target positions
    pos_rot_base, pos_rot_left, pos_rot_right, pos_trans_z = self.CoDI_pos_predefined[pos_name]

    # Move motors

    # Old wayy 
    # self.CoDI_rot_base.mv(pos_rot_base, wait=False)
    # self.CoDI_rot_left.mv(pos_rot_left,  wait=False)
    # self.CoDI_rot_right.mv(pos_rot_right, wait=False)
    # self.CoDI_trans_z.mv(pos_trans_z, wait=False)

    # Move using hutch python presets
    exec_base = "self.CoDI_rot_base.mv_" + pos_name + '()'
    exec(exec_base)
    exec_left = "self.CoDI_rot_left.mv_" + pos_name + '()'
    exec(exec_left)
    exec_right = "self.CoDI_rot_right.mv_" + pos_name + '()'
    exec(exec_right)
    exec_z = "self.CoDI_trans_z.mv_" + pos_name + '()'
    exec(exec_z)

    if wait == True: 
        test_name, test_pos_rot_base, test_pos_rot_left, test_pos_rot_right, test_pos_trans_z = self.get_CoDI_pos()
        i = 0
        while pos_name != test_name: 
            time.sleep(1)
            print('\r waiting for motion to end: %i s' %i, end="\r")
            i = i+1
            test_name, test_pos_rot_base, test_pos_rot_left, test_pos_rot_right, test_pos_trans_z = self.get_CoDI_pos()
        print('Motion ended')

set_CoDI_predefined(name, base, left, right, z)

defines or updates a predefined combination for CoDI

Parameters name : str name of the pre-definition base : float rotation of base left : float rotation of left injector right : float rotation of right injector z : float

translation of right injector
Source code in dod/codi.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def set_CoDI_predefined(self, name, base, left, right, z):
    """
    defines or updates a predefined combination for CoDI

    Parameters
    name : str
        name of the pre-definition
    base : float
        rotation of base
    left : float
        rotation of left injector
    right : float
        rotation of right injector
    z : float
        translation of right injector
    ----------

    """
    self.CoDI_pos_predefined.update({name: (base,left, right, z)})

    # Presets using MFX presets functionalities 
    self.CoDI_rot_left.presets.add_hutch(name, value = left)
    self.CoDI_rot_right.presets.add_hutch(name, value = right)
    self.CoDI_rot_base.presets.add_hutch(name, value = base)
    self.CoDI_trans_z.presets.add_hutch(name, value = z)

update_CoDI_predefined()

reloads all the hutch python presets for motors and overwrites local position preset dict

Source code in dod/codi.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def update_CoDI_predefined(self): 
    'reloads all the hutch python presets for motors and overwrites local position preset dict'

    #Predefined positions CoDI
    self.CoDI_pos_predefined = dict()

    all_presets = vars(self.CoDI_rot_left.presets.positions) #Needs to be fixed
    for preset in all_presets.keys(): 
        # try: 
        # get preset position
        self.exec_base = "preset_rot_base = self.CoDI_rot_base.presets.positions." + preset + '.pos'
        self.exec_rot_left = "preset_rot_left = self.CoDI_rot_left.presets.positions." + preset + '.pos'
        self.exec_rot_right = "preset_rot_right = self.CoDI_rot_right.presets.positions." + preset + '.pos'
        self.exec_trans_z = "preset_trans_z = self.CoDI_trans_z.presets.positions." + preset + '.pos'
        print(self.exec_base)
        exec(self.exec_base)

        exec(self.exec_rot_left)
        print(self.exec_rot_left)

        exec(self.exec_rot_right)
        print(self.exec_rot_left)

        exec(self.exec_trans_z)
        print(self.exec_trans_z)
        print(preset_trans_z)

        # Save to local database
        print(preset)
        self.set_CoDI_predefined(preset, preset_rot_base, preset_rot_left, preset_rot_right, preset_trans_z)