commands.py 19.5 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
# -*- coding: utf-8 -*-
"""
Created on Mon Jan 28 11:58:09 2013

@author: Daniel
"""
7
8
9
10
11
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals

Daniel Brown's avatar
Daniel Brown committed
12
import numpy
13
import warnings
14
import pykat.external.six as six
15
16
import pykat.exceptions as pkex

17
18
if six.PY2:
	import exceptions
19
    
20
21
from pykat.components import *
from pykat.structs import *
22
from numpy import min, max
Daniel Brown's avatar
Daniel Brown committed
23
from pykat.param import Param, putter
Daniel Brown's avatar
Daniel Brown committed
24
from collections import namedtuple
25
from pykat.optics.gaussian_beams import BeamParam
Daniel Brown's avatar
Daniel Brown committed
26

27

Daniel Brown's avatar
Daniel Brown committed
28
class Command(object):
29
30
    __metaclass__ = abc.ABCMeta
    
31
    def __init__(self, name, unique):
32
33
        self.__dict__["____FROZEN____"] = False
        self._kat = None
34
        self.__unique = unique
35
36
        self.tag = None
        self.__removed = False
37
        self.__name = name.strip("*")
38
39
        self._putters = []
    
40
        
41
42
43
44
45
46
47
48
49
50
51
52
    def __deepcopy__(self, memo):
        """
        When deep copying a kat object we need to take into account
        the instance specific properties.
        """

        cls = self.__class__
        result = cls.__new__(cls)
        result.__dict__ = copy.deepcopy(self.__dict__, memo)
        
        for _ in result._putters:
            _._updateOwner(result)
53
        
54
        return result
55
56
57
58
59
60
61
62
63
64
    
    def _freeze(self): self.__dict__["____FROZEN____"] = True
    def _unfreeze(self): self.__dict__["____FROZEN____"] = False
        
    def __setattr__(self, name, value):
        if self.__dict__["____FROZEN____"] and not hasattr(self, name):
            warnings.warn("'%s' does not have attribute called '%s'" % (self.__name, name), stacklevel=2)
            
        if hasattr(self, name) and hasattr(self.__class__, name):
            prop = getattr(self.__class__, name)
65
            
66
67
68
69
70
71
            if isinstance(prop, property):
                prop.fset(self, value)
                return
                
        self.__dict__[name] = value
                       
Daniel Brown's avatar
Daniel Brown committed
72
73
74
75
76
    def getFinesseText(self):
        """ Base class for individual finesse optical components """
        raise NotImplementedError("This function is not implemented")

    @staticmethod
77
    def parseFinesseText(line, kat):
Daniel Brown's avatar
Daniel Brown committed
78
79
80
81
82
83
84
        raise NotImplementedError("This function is not implemented")

    def _on_kat_add(self, kat):
        """
        Called when this component has been added to a kat object
        """
        self._kat = kat
85
        
86
        for _ in self._putters:
87
            kat.registerVariable(_.name, _)
Daniel Brown's avatar
Daniel Brown committed
88

89
    def _on_kat_remove(self):
90
        self.__removed = True
91
        
92
93
        for i in range(len(self._putters)):
            _ = self._putters[i]
94
95
96
            
            self._kat.unregisterVariable(_.name)
            _.clearPuts()
Daniel Brown's avatar
Daniel Brown committed
97
98
99
        
        for i in range(len(self._putters)):  
            del self._putters[0]
100
            
101
        del self._putters[:]
102
103
104
105
106
107
108
        
        
    def remove(self):
        if self.__removed:
            raise pkex.BasePyKatException("{0} has already been marked as removed".format(self.name))
        else:
            self._kat.remove(self)
109
    
110
111
112
    @property
    def name(self): return self.__name
    
113
114
    @property
    def removed(self): return self.__removed
115
116
117
118
119
120
121
122
123





class variable(Command):
    def __init__(self, name, value):
        Command.__init__(self, name, False)
        self.__value = value
124
125
        self._freeze()
        
126
127
    def getFinesseText(self):
        return "variable {name} {value}".format(name=self.name, value=self.value)
128
    
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
    @staticmethod
    def parseFinesseText(line, kat):
        v = line.split()
        
        if len(v) != 3:
            raise pkex.BasePyKatException("'{0}' not a valid Finesse variable command".format(line))
        
        return variable(v[1], SIfloat(v[2]))
    
    @property
    def value(self): return self.__value
    @value.setter
    def value(self, Value): self.__value = SIfloat(Value)





class func(Command):
    def __init__(self, name, value):
        Command.__init__(self, name, False)
        
        self.value = value
152
        self.noplot = False
153
154
155
        self.enabled = True
        
        self.output = putter(name, self)
156
        self._putters.append(self.output)
157
158

        self._freeze()
159
        
160
    def getFinesseText(self):
161
162
        rtn = []

163
164
165
        if self.enabled:
            if self.noplot:
                rtn.append("noplot " + self.name)
166
        
167
            rtn.append("func {name} = {value}".format(name=self.name, value=str(self.value)))
168
169

        return rtn
170
171
172
173

    @staticmethod
    def parseFinesseText(line, kat):
        v = line.split(None, 3)
174
        v2 = line.split("=", 2)
175
176
177
        
        if "=" in v and len(v) == 4:
            v.remove("=")
178
179
180
            return func(v[1], v[2]) 
        if len(v2) == 2:
            return func(v2[0].split()[1], v2[1]) 
181
182
        else:
            raise pkex.BasePyKatException("'{0}' not a valid Finesse func command".format(line))
183
            
184
185
186
187
188
189
190
191
192
193

class lock(Command):
    def __init__(self, name, variable, gain, accuracy, singleLock=False):
        Command.__init__(self, name, False)
        
        self.__variable = variable
        self.__gain = gain
        self.__accuracy = accuracy
        self.singleLock = singleLock
        self.enabled = True
Daniel Brown's avatar
Daniel Brown committed
194
        self.noplot = False
195
196
        
        self.output = putter(name, self)
197
        self._putters.append(self.output)
198

199
200
        self._freeze()
        
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
    @staticmethod
    def parseFinesseText(line, kat):
        v = line.split()
        
        if len(v) != 5:
            raise pkex.BasePyKatException("'{0}' not a valid Finesse lock command".format(line))
            
        return lock(v[1], v[2], SIfloat(v[3]), SIfloat(v[4]), "*" in v[0])


    def getFinesseText(self):
        if self.enabled:
            cmds = "{name} {var} {gain} {accuracy}".format( name=self.name,
                                                            var=str(self.variable),
                                                            gain=str(self.gain),
                                                            accuracy=str(self.accuracy))
            
            if self.singleLock:
                return "lock* %s" % cmds
            else:
                return "lock %s" % cmds
        else:
            return None

    @property
    def variable(self): return self.__variable
    @variable.setter
    def variable(self, value): self.__variable = value

    @property
    def gain(self): return self.__gain
    @gain.setter
    def gain(self, value): self.__gain = SIfloat(value)

    @property
    def accuracy(self): return self.__accuracy
    @accuracy.setter
    def accuracy(self, value): self.__accuracy = SIfloat(value)



Daniel Brown's avatar
Daniel Brown committed
242
243
class cavity(Command):
    def __init__(self, name, c1, n1, c2, n2):
244
        Command.__init__(self, name, False)
245
        
Daniel Brown's avatar
Daniel Brown committed
246
247
248
249
        self.__c1 = c1
        self.__c2 = c2
        self.__n1 = n1
        self.__n2 = n2
250
251
        
        self.enabled = True
Daniel Brown's avatar
Daniel Brown committed
252

253
254
        self._freeze()
        
Daniel Brown's avatar
Daniel Brown committed
255
    def getFinesseText(self):
256
257
258
259
        if self.enabled:
            return 'cav {0} {1} {2} {3} {4}'.format(self.name, self.__c1.name, self.__n1.name, self.__c2.name, self.__n2.name);
        else:
            return None
Daniel Brown's avatar
Daniel Brown committed
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
    @staticmethod
    def parseFinesseText(line, kat):
        v = line.split()
        
        if len(v) != 6:
            raise pkex.BasePyKatException("cav command format `{0}` is incorrect".format(line))
        
        if v[2] not in kat.components:
            raise pkex.BasePyKatException("cav command `{0}` refers to component `{1}` which does not exist".format(line, v[2]))
        
        if v[4] not in kat.components:
            raise pkex.BasePyKatException("cav command `{0}` refers to component `{1}` which does not exist".format(line, v[4]))
        
        if v[3] not in kat.nodes.getNodes():
            raise pkex.BasePyKatException("cav command `{0}` refers to node `{1}` which does not exist".format(line, v[3]))
        
        if v[5] not in kat.nodes.getNodes():
            raise pkex.BasePyKatException("cav command `{0}` refers to node `{1}` which does not exist".format(line, v[5]))
        
        c1 = getattr(kat, v[2])
        c2 = getattr(kat, v[4])
        
        n1 = getattr(kat.nodes, v[3])
        n2 = getattr(kat.nodes, v[5])
        
        if not hasattr(c1, n1.name):
            raise pkex.BasePyKatException("cav command `{0}`: node `{1}` is not attached to `{2}`".format(line, n1.name, c1.name))
        
        if not hasattr(c2, n2.name):
            raise pkex.BasePyKatException("cav command `{0}`: node `{1}` is not attached to `{2}`".format(line, n2.name, c2.name))
            
        return pykat.commands.cavity(v[1], c1, n1, c2, n2)
        
        
Daniel Brown's avatar
Daniel Brown committed
295
296
297
class gauss(object):
    @staticmethod
    def parseFinesseText(text, kat):
298
        
299
        values = text.split()
300
        if not values[0].startswith("gauss") or (len(values) != 6 and len(values) != 8):
301
            raise pkex.BasePyKatException("'{0}' not a valid Finesse gauss command".format(text))        
302
        
303
304
305
306
        name = values[1]
        component = values[2]
        node = values[3]
        
Daniel Brown's avatar
Daniel Brown committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
        # setting the name of the gauss parameter is slightly convoluted
        # as we don't explicitly store gauss paramters as an object, they
        # are simply just complex numbers stored at each node. To fix this
        # the name is stored in the NodeGaussSetter object for each component
        
        if component in kat.components:
            c = kat.components[component]
            if hasattr(c, node):
                ns = getattr(c, node)
                ns.name = name
            else:
                raise pkex.BasePyKatException("Component '{0}' is not attached to node {1}".format(component, node))        
        else:
            raise pkex.BasePyKatException("Component '{0}' was not found".format(component))        
        
322
        if not values[0].endswith("*"):
323
            if len(values) == 6:
324
                gp = BeamParam(kat.lambda0, w0=values[-2], z=values[-1])
325
            elif len(values) == 8:
326
327
                gpx = BeamParam(kat.lambda0, w0=values[-4], z=values[-3])
                gpy = BeamParam(kat.lambda0, w0=values[-2], z=values[-1])
328
329
        elif values[0].endswith("*"):
            if len(values) == 6:
330
                gp = BeamParam(kat.lambda0, z=values[-2], zr=values[-1])
331
            elif len(values) == 8:
332
333
                gpx = BeamParam(kat.lambda0, z=values[-4], zr=values[-3])
                gpy = BeamParam(kat.lambda0, z=values[-2], zr=values[-1])
Daniel Brown's avatar
Daniel Brown committed
334
        elif values[0].endswith("**"):
335
            if len(values) == 6:
336
                gp = BeamParam(kat.lambda0, w=values[-2], rc=values[-1])
337
            elif len(values) == 8:
338
339
                gpx = BeamParam(kat.lambda0, w=values[-4], rc=values[-3])
                gpy = BeamParam(kat.lambda0, w=values[-2], rc=values[-1])
Daniel Brown's avatar
Daniel Brown committed
340
341
342
        else:
            raise pkex.BasePyKatException("Unexpected ending to gauss command '{0}'".format(text))
            
Daniel Brown's avatar
Daniel Brown committed
343
344
345
346
        if len(values) == 6:
            kat.nodes[node].setGauss(kat.components[component], gp)
        else:
            kat.nodes[node].setGauss(kat.components[component], gpx, gpy)
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# class tf(Command):
#
#     class fQ(object):
#         def __init__(self, f, Q, tf):
#             assert(tf is not None)
#             self._tf = tf
#             self.__f = Param("f", self, None, canFsig=False, isPutable=True, isPutter=False, isTunable=True)
#             self.__Q = Param("Q", self, None, canFsig=False, isPutable=True, isPutter=False, isTunable=True)
#
#         def _register_param(self, param):
#             self._tf._params.append(param)
#
#         @property
#         def f(self): return self.__f
#         @f.setter
#         def f(self,value): self.__f.value = SIfloat(value)
#
#         @property
#         def Q(self): return self.__Q
#         @Q.setter
#         def Q(self,value): self.__Q.value = SIfloat(value)
#
#     def __init__(self, name):
#         Command.__init__(self, name, False)
#         self.zeros = []
#         self.poles = []
#         self.gain = 1
#         self.phase = 0
#         self._params = []
#
#     def addPole(self,f, Q):
#         self.poles.append(tf.fQ(SIfloat(f), SIfloat(Q), self))
#
#     def addZero(self,f, Q):
#         self.zeros.append(tf.fQ(SIfloat(f), SIfloat(Q), self))
#
#     @staticmethod
#     def parseFinesseText(text):
#         values = text.split()
#
#         if ((len(values)-4) % 3) != 0:
#             raise pkex.BasePyKatException("Transfer function Finesse code format incorrect '{0}'".format(text))
#
#         _tf = tf(values[1])
#
#         _tf.gain = SIfloat(values[2])
#         _tf.phase = SIfloat(values[3])
#
#         N = int((len(values)-4) / 3)
#
#         for i in range(1,N+1):
#             if values[i*3+1] == 'p':
#                 _tf.addPole(SIfloat(values[i*3+2]), SIfloat(values[i*3+3]))
#             elif values[i*3+1] == 'z':
#                 _tf.addZero(SIfloat(values[i*3+2]), SIfloat(values[i*3+3]))
#             else:
#                 raise pkex.BasePyKatException("Transfer function pole/zero Finesse code format incorrect '{0}'".format(text))
#
#         return _tf
#
#     def getFinesseText(self):
#         rtn = "tf {name} {gain} {phase} ".format(name=self.name,gain=self.gain,phase=self.phase)
#
#         for p in self.poles:
#             rtn += "p {f} {Q} ".format(f=p.f, Q=p.Q)
#
#         for z in self.zeros:
#             rtn += "p {f} {Q} ".format(f=z.f, Q=z.Q)
#
#         return rtn
                   
Daniel Brown's avatar
Daniel Brown committed
419
420
class tf(Command):
    
Daniel Brown's avatar
Daniel Brown committed
421
422
423
424
425
426
    class fQ(object):
        def __init__(self, f, Q):
            self.f = f
            self.Q = Q
            
    def __init__(self, name):
427
        Command.__init__(self, name, False)
Daniel Brown's avatar
Daniel Brown committed
428
429
430
431
        self.zeros = []
        self.poles = []
        self.gain = 1
        self.phase = 0
432
433
        
        self._freeze()
Daniel Brown's avatar
Daniel Brown committed
434
435
436
437
438
439
    
    def addPole(self,f, Q):
        self.poles.append(tf.fQ(SIfloat(f), SIfloat(Q)))
    
    def addZero(self,f, Q):
        self.zeros.append(tf.fQ(SIfloat(f), SIfloat(Q)))
440
    
Daniel Brown's avatar
Daniel Brown committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
    @staticmethod
    def parseFinesseText(text):
        values = text.split()
        
        if ((len(values)-4) % 3) != 0:
            raise pkex.BasePyKatException("Transfer function Finesse code format incorrect '{0}'".format(text))

        _tf = tf(values[1])
        
        _tf.gain = SIfloat(values[2])
        _tf.phase = SIfloat(values[3])
        
        N = int((len(values)-4) / 3)
        
        for i in range(1,N+1):
            if values[i*3+1] == 'p':
                _tf.addPole(SIfloat(values[i*3+2]), SIfloat(values[i*3+3]))
            elif values[i*3+1] == 'z':
                _tf.addZero(SIfloat(values[i*3+2]), SIfloat(values[i*3+3]))
            else:
                raise pkex.BasePyKatException("Transfer function pole/zero Finesse code format incorrect '{0}'".format(text))
    
        return _tf
        
    def getFinesseText(self):
        rtn = "tf {name} {gain} {phase} ".format(name=self.name,gain=self.gain,phase=self.phase)
        
        for p in self.poles:
            rtn += "p {f} {Q} ".format(f=p.f, Q=p.Q)
        
        for z in self.zeros:
            rtn += "p {f} {Q} ".format(f=z.f, Q=z.Q)
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
476
class xaxis(Command):
477
478
479
480
481
    """
    The xaxis object is a unique object to each pykat.finesse.kat instance. It provides
    and interface to the xaxis command in FINESSE.
    """
    
482
    def __init__(self, scale, limits, param, steps, comp=None, axis_type="xaxis"):
483
484
485
486
487
488
489
490
491
        """
        Typical usage:
            xaxis(["lin" or "log"], [upper, lower], param, steps)
            
        param must be an object of the type pykat.param.Param whose
        isPutable() member returns true.
        
        steps is the number of points to compute between upper and lower limits.
        """
492
        Command.__init__(self, axis_type, True)
493
        
Daniel Brown's avatar
Daniel Brown committed
494
        self._axis_type = axis_type
495
496
        
        self._set_variables()
497
        
Daniel Brown's avatar
Daniel Brown committed
498
        if scale == "lin":
499
            scale = Scale.linear
Daniel Brown's avatar
Daniel Brown committed
500
501
        elif scale == "log":
            scale = Scale.logarithmic
502
        elif isinstance(scale, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
503
            # else we have a string but not a recognisable one
504
            raise pkex.BasePyKatException("scale argument '{0}' is not valid, must be 'lin' or 'log'".format(scale))
Daniel Brown's avatar
Daniel Brown committed
505
506

        if scale != Scale.linear and scale != Scale.logarithmic:
507
            raise pkex.BasePyKatException("scale is not Scale.linear or Scale.logarithmic")
Daniel Brown's avatar
Daniel Brown committed
508
509
510
511

        self.scale = scale

        if numpy.size(limits) != 2 :
512
            raise pkex.BasePyKatException("limits input should be a 2x1 vector of limits for the xaxis")
Daniel Brown's avatar
Daniel Brown committed
513
514
515

        self.limits = numpy.array(SIfloat(limits)).astype(float)

516
        if int(steps) <= 0 :
517
            raise pkex.BasePyKatException("steps value should be > 0")
Daniel Brown's avatar
Daniel Brown committed
518
519
520

        self.steps = int(steps)

521
        if isinstance(param, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
522
            self.__param = param
523
524
525
526
            if comp == None:
                raise pkex.BasePyKatException("If parameter is set with a string, the comp argument must set the component name")
                
            self.__comp = comp
Daniel Brown's avatar
Daniel Brown committed
527
        elif not isinstance(param, Param) :
528
            raise pkex.BasePyKatException("param argument is not of type Param")
Daniel Brown's avatar
Daniel Brown committed
529
530
        else:
            self.__param = param
531
            self.__comp = param._owner()
Daniel Brown's avatar
Daniel Brown committed
532

533
534
        self._freeze()
        
535
536
537
538
539
540
541
    def _set_variables(self):
        self.x = putter("x1", self)
        self.mx = putter("mx1", self)

        self._putters.append(self.x)
        self._putters.append(self.mx)
        
542
543
544
545
    @property
    def param(self): return self.__param
    @param.setter
    def param(self, value):
546
547
548
549
550
551
        if not isinstance(value, Param):
            raise pkex.BasePyKatException("param argument is not of type Param")
        else:
            self.__param = value
            self.__comp = value._owner()
            
Daniel Brown's avatar
Daniel Brown committed
552
553
    @staticmethod
    def parseFinesseText(text):
554
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
555
556

        if values[0] != "xaxis" and values[0] != "xaxis*":
557
            raise pkex.BasePyKatException("'{0}' not a valid Finesse xaxis command".format(text))
Daniel Brown's avatar
Daniel Brown committed
558
559
560
561
562
563

        axis_type = values[0]

        values.pop(0) # remove initial value

        if len(values) != 6:
564
            raise pkex.BasePyKatException("xaxis Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
565

566
        return xaxis(values[2], [values[3], values[4]], values[1], values[5], comp=values[0], axis_type=axis_type)
Daniel Brown's avatar
Daniel Brown committed
567
568

    def getFinesseText(self):
569
570
        if(self._kat.noxaxis):
            return '# noaxis is true, switching xaxis off'
Daniel Brown's avatar
Daniel Brown committed
571
        
Daniel Brown's avatar
Daniel Brown committed
572
        # store either the component name of the string provided
573
        comp_name = self.__comp.name if hasattr(self.__comp, "name") else self.__comp
Daniel Brown's avatar
Daniel Brown committed
574
        param_name = self.__param.name if isinstance(self.__param, Param) else self.__param
575
        
576
        return '{axis_type} {0} {1} {2} {3:.16g} {4:.16g} {5}'.format(
Daniel Brown's avatar
Daniel Brown committed
577
                comp_name, param_name, self.scale,
Daniel Brown's avatar
Daniel Brown committed
578
                self.limits[0], self.limits[1], self.steps, axis_type=self._axis_type);
Daniel Brown's avatar
Daniel Brown committed
579
580

class x2axis(xaxis):
581
582
    def __init__(self, scale, limits, param, steps, comp=None, axis_type="x2axis"):
        xaxis.__init__(self, scale, limits, param, steps, comp=comp, axis_type=axis_type)
583
584

    def _set_variables(self):
585
586
587
        self.x = putter("x2", self)
        self.mx = putter("mx2", self)

588
589
        self._putters.append(self.x)
        self._putters.append(self.mx)
590
        
Daniel Brown's avatar
Daniel Brown committed
591
592
    @staticmethod
    def parseFinesseText(text):
593
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
594
595

        if values[0] != "x2axis" and values[0] != "x2axis*":
596
            raise pkex.BasePyKatException("'{0}' not a valid Finesse xaxis command".format(text))
Daniel Brown's avatar
Daniel Brown committed
597
598
599
600
601
602

        axis_type = values[0]

        values.pop(0) # remove initial value

        if len(values) != 6:
603
            raise pkex.BasePyKatException("xaxis Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
604

605
        return x2axis(values[2], [values[3], values[4]], values[1], values[5], comp=values[0],axis_type=axis_type)
606