commands.py 15.9 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 pykat.external.six as six
14
15
import pykat.exceptions as pkex

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

26
27
28



Daniel Brown's avatar
Daniel Brown committed
29
class Command(object):
30
31
    __metaclass__ = abc.ABCMeta
    
32
33
    def __init__(self, name, unique):
        self.__unique = unique
34
35
        self.tag = None
        self.__removed = False
36
        self.__name = name.strip("*")
37
        self._putters_to_register = []
38
        
Daniel Brown's avatar
Daniel Brown committed
39
40
41
42
43
    def getFinesseText(self):
        """ Base class for individual finesse optical components """
        raise NotImplementedError("This function is not implemented")

    @staticmethod
44
    def parseFinesseText(line, kat):
Daniel Brown's avatar
Daniel Brown committed
45
46
47
48
49
50
51
        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
52
53
54
        
        for _ in self._putters_to_register:
            kat.registerVariable(_.name, _)
Daniel Brown's avatar
Daniel Brown committed
55

56
    def _on_kat_remove(self):
57
        self.__removed = True
58
        
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
        for i in range(len(self._putters_to_register)):
            _ = self._putters_to_register[i]
            
            self._kat.unregisterVariable(_.name)
            _.clearPuts()
            
            del self._putters_to_register[i]
            
        del self._putters_to_register[:]
        
        
    def remove(self):
        if self.__removed:
            raise pkex.BasePyKatException("{0} has already been marked as removed".format(self.name))
        else:
            self._kat.remove(self)
75
    
76
77
78
    @property
    def name(self): return self.__name
    
79
80
    @property
    def removed(self): return self.__removed
81
82
83
84
85
86
87
88
89
90
91
92





class variable(Command):
    def __init__(self, name, value):
        Command.__init__(self, name, False)
        self.__value = value
    
    def getFinesseText(self):
        return "variable {name} {value}".format(name=self.name, value=self.value)
93
    
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
    @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
117
        self.noplot = False
118
119
120
121
        self.enabled = True
        
        self.output = putter(name, self)
        self._putters_to_register.append(self.output)
122
        
123
    def getFinesseText(self):
124
125
        rtn = []

126
127
128
        if self.enabled:
            if self.noplot:
                rtn.append("noplot " + self.name)
129
        
130
            rtn.append("func {name} = {value}".format(name=self.name, value=str(self.value)))
131
132

        return rtn
133
134
135
136

    @staticmethod
    def parseFinesseText(line, kat):
        v = line.split(None, 3)
137
        v2 = line.split("=", 2)
138
139
140
        
        if "=" in v and len(v) == 4:
            v.remove("=")
141
142
143
            return func(v[1], v[2]) 
        if len(v2) == 2:
            return func(v2[0].split()[1], v2[1]) 
144
145
        else:
            raise pkex.BasePyKatException("'{0}' not a valid Finesse func command".format(line))
146
            
147
148
149
150
151
152
153
154
155
156

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
157
158
159
160
        
        
        self.output = putter(name, self)
        self._putters_to_register.append(self.output)
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


    @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
204
205
class cavity(Command):
    def __init__(self, name, c1, n1, c2, n2):
206
        Command.__init__(self, name, False)
207
        
Daniel Brown's avatar
Daniel Brown committed
208
209
210
211
        self.__c1 = c1
        self.__c2 = c2
        self.__n1 = n1
        self.__n2 = n2
212
213
        
        self.enabled = True
Daniel Brown's avatar
Daniel Brown committed
214
215

    def getFinesseText(self):
216
217
218
219
        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
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
    @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
255
256
257
class gauss(object):
    @staticmethod
    def parseFinesseText(text, kat):
258
        
259
        values = text.split()
260
        if not values[0].startswith("gauss") or (len(values) != 6 and len(values) != 8):
261
            raise pkex.BasePyKatException("'{0}' not a valid Finesse gauss command".format(text))        
262
        
263
264
265
266
        name = values[1]
        component = values[2]
        node = values[3]
        
Daniel Brown's avatar
Daniel Brown committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
        # 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))        
        
282
        if not values[0].endswith("*"):
283
            if len(values) == 6:
284
                gp = beam_param(kat.lambda0, w0=values[-2], z=values[-1])
285
            elif len(values) == 8:
286
287
                gpx = beam_param(kat.lambda0, w0=values[-4], z=values[-3])
                gpy = beam_param(kat.lambda0, w0=values[-2], z=values[-1])
288
289
        elif values[0].endswith("*"):
            if len(values) == 6:
290
                gp = beam_param(kat.lambda0, z=values[-2], zr=values[-1])
291
            elif len(values) == 8:
292
293
                gpx = beam_param(kat.lambda0, z=values[-4], zr=values[-3])
                gpy = beam_param(kat.lambda0, z=values[-2], zr=values[-1])
Daniel Brown's avatar
Daniel Brown committed
294
        elif values[0].endswith("**"):
295
            if len(values) == 6:
296
                gp = beam_param(kat.lambda0, w=values[-2], rc=values[-1])
297
            elif len(values) == 8:
298
299
                gpx = beam_param(kat.lambda0, w=values[-4], rc=values[-3])
                gpy = beam_param(kat.lambda0, w=values[-2], rc=values[-1])
Daniel Brown's avatar
Daniel Brown committed
300
301
302
        else:
            raise pkex.BasePyKatException("Unexpected ending to gauss command '{0}'".format(text))
            
Daniel Brown's avatar
Daniel Brown committed
303
304
305
306
        if len(values) == 6:
            kat.nodes[node].setGauss(kat.components[component], gp)
        else:
            kat.nodes[node].setGauss(kat.components[component], gpx, gpy)
307
            
Daniel Brown's avatar
Daniel Brown committed
308
309
class tf(Command):
    
Daniel Brown's avatar
Daniel Brown committed
310
311
312
313
314
315
    class fQ(object):
        def __init__(self, f, Q):
            self.f = f
            self.Q = Q
            
    def __init__(self, name):
316
        Command.__init__(self, name, False)
Daniel Brown's avatar
Daniel Brown committed
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
        self.zeros = []
        self.poles = []
        self.gain = 1
        self.phase = 0
    
    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)))
        
    @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
363
class xaxis(Command):
364
365
366
367
368
    """
    The xaxis object is a unique object to each pykat.finesse.kat instance. It provides
    and interface to the xaxis command in FINESSE.
    """
    
369
    def __init__(self, scale, limits, param, steps, comp=None, axis_type="xaxis"):
370
371
372
373
374
375
376
377
378
        """
        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.
        """
379
        Command.__init__(self, axis_type, True)
380
        
Daniel Brown's avatar
Daniel Brown committed
381
382
        self._axis_type = axis_type

383
384
        self.x = putter("x1", self)
        self.mx = putter("mx1", self)
Daniel Brown's avatar
Daniel Brown committed
385

386
387
388
        self._putters_to_register.append(self.x)
        self._putters_to_register.append(self.mx)
        
Daniel Brown's avatar
Daniel Brown committed
389
        if scale == "lin":
390
            scale = Scale.linear
Daniel Brown's avatar
Daniel Brown committed
391
392
        elif scale == "log":
            scale = Scale.logarithmic
393
        elif isinstance(scale, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
394
            # else we have a string but not a recognisable one
395
            raise pkex.BasePyKatException("scale argument '{0}' is not valid, must be 'lin' or 'log'".format(scale))
Daniel Brown's avatar
Daniel Brown committed
396
397

        if scale != Scale.linear and scale != Scale.logarithmic:
398
            raise pkex.BasePyKatException("scale is not Scale.linear or Scale.logarithmic")
Daniel Brown's avatar
Daniel Brown committed
399
400
401
402

        self.scale = scale

        if numpy.size(limits) != 2 :
403
            raise pkex.BasePyKatException("limits input should be a 2x1 vector of limits for the xaxis")
Daniel Brown's avatar
Daniel Brown committed
404
405
406

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

407
        if int(steps) <= 0 :
408
            raise pkex.BasePyKatException("steps value should be > 0")
Daniel Brown's avatar
Daniel Brown committed
409
410
411

        self.steps = int(steps)

412
        if isinstance(param, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
413
            self.__param = param
414
415
416
417
            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
418
        elif not isinstance(param, Param) :
419
            raise pkex.BasePyKatException("param argument is not of type Param")
Daniel Brown's avatar
Daniel Brown committed
420
421
        else:
            self.__param = param
422
            self.__comp = param._owner()
Daniel Brown's avatar
Daniel Brown committed
423

424
425
426
427
    @property
    def param(self): return self.__param
    @param.setter
    def param(self, value):
428
429
430
431
432
433
        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
434
435
    @staticmethod
    def parseFinesseText(text):
436
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
437
438

        if values[0] != "xaxis" and values[0] != "xaxis*":
439
            raise pkex.BasePyKatException("'{0}' not a valid Finesse xaxis command".format(text))
Daniel Brown's avatar
Daniel Brown committed
440
441
442
443
444
445

        axis_type = values[0]

        values.pop(0) # remove initial value

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

448
        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
449
450

    def getFinesseText(self):
451
452
        if(self._kat.noxaxis):
            return '# noaxis is true, switching xaxis off'
Daniel Brown's avatar
Daniel Brown committed
453
        
Daniel Brown's avatar
Daniel Brown committed
454
        # store either the component name of the string provided
455
        comp_name = self.__comp.name if hasattr(self.__comp, "name") else self.__comp
Daniel Brown's avatar
Daniel Brown committed
456
        param_name = self.__param.name if isinstance(self.__param, Param) else self.__param
457
        
458
        return '{axis_type} {0} {1} {2} {3:.16g} {4:.16g} {5}'.format(
Daniel Brown's avatar
Daniel Brown committed
459
                comp_name, param_name, self.scale,
Daniel Brown's avatar
Daniel Brown committed
460
                self.limits[0], self.limits[1], self.steps, axis_type=self._axis_type);
Daniel Brown's avatar
Daniel Brown committed
461
462

class x2axis(xaxis):
463
464
    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)
465
466
467
468
469
        self.x = putter("x2", self)
        self.mx = putter("mx2", self)

        self._putters_to_register.append(self.x)
        self._putters_to_register.append(self.mx)
Daniel Brown's avatar
Daniel Brown committed
470
471
472

    @staticmethod
    def parseFinesseText(text):
473
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
474
475

        if values[0] != "x2axis" and values[0] != "x2axis*":
476
            raise pkex.BasePyKatException("'{0}' not a valid Finesse xaxis command".format(text))
Daniel Brown's avatar
Daniel Brown committed
477
478
479
480
481
482

        axis_type = values[0]

        values.pop(0) # remove initial value

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

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