commands.py 14.8 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
        
Daniel Brown's avatar
Daniel Brown committed
38
39
40
41
42
    def getFinesseText(self):
        """ Base class for individual finesse optical components """
        raise NotImplementedError("This function is not implemented")

    @staticmethod
43
    def parseFinesseText(line, kat):
Daniel Brown's avatar
Daniel Brown committed
44
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
55
    def remove(self):
        self._kat.remove(self)
        self.__removed = True
    
56
57
58
    @property
    def name(self): return self.__name
    
59
60
    @property
    def removed(self): return self.__removed
61
62
63
64
65
66
67
68
69
70
71
72





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)
73
    
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
    @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
97
98
        self.noplot = False
        
99
    def getFinesseText(self):
100
101
102
103
104
105
106
107
        rtn = []

        if self.noplot:
            rtn.append("noplot " + self.name)
        
        rtn.append("func {name} = {value}".format(name=self.name, value=str(self.value)))

        return rtn
108
109
110
111

    @staticmethod
    def parseFinesseText(line, kat):
        v = line.split(None, 3)
112
        v2 = line.split("=", 2)
113
114
115
        
        if "=" in v and len(v) == 4:
            v.remove("=")
116
117
118
            return func(v[1], v[2]) 
        if len(v2) == 2:
            return func(v2[0].split()[1], v2[1]) 
119
120
121
        else:
            raise pkex.BasePyKatException("'{0}' not a valid Finesse func command".format(line))
        
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
        


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


    @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
178
179
class cavity(Command):
    def __init__(self, name, c1, n1, c2, n2):
180
        Command.__init__(self, name, False)
181
        
Daniel Brown's avatar
Daniel Brown committed
182
183
184
185
        self.__c1 = c1
        self.__c2 = c2
        self.__n1 = n1
        self.__n2 = n2
186
187
        
        self.enabled = True
Daniel Brown's avatar
Daniel Brown committed
188
189

    def getFinesseText(self):
190
191
192
193
        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
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
    @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
229
230
231
class gauss(object):
    @staticmethod
    def parseFinesseText(text, kat):
232
        
233
        values = text.split()
234
        if not values[0].startswith("gauss") or (len(values) != 6 and len(values) != 8):
235
            raise pkex.BasePyKatException("'{0}' not a valid Finesse gauss command".format(text))        
236
        
237
238
239
240
        name = values[1]
        component = values[2]
        node = values[3]
        
Daniel Brown's avatar
Daniel Brown committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
        # 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))        
        
256
        if not values[0].endswith("*"):
257
            if len(values) == 6:
258
                gp = beam_param(kat.lambda0, w0=values[-2], z=values[-1])
259
            elif len(values) == 8:
260
261
                gpx = beam_param(kat.lambda0, w0=values[-4], z=values[-3])
                gpy = beam_param(kat.lambda0, w0=values[-2], z=values[-1])
262
263
        elif values[0].endswith("*"):
            if len(values) == 6:
264
                gp = beam_param(kat.lambda0, z=values[-2], zr=values[-1])
265
            elif len(values) == 8:
266
267
                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
268
        elif values[0].endswith("**"):
269
            if len(values) == 6:
270
                gp = beam_param(kat.lambda0, w=values[-2], rc=values[-1])
271
            elif len(values) == 8:
272
273
                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
274
275
276
        else:
            raise pkex.BasePyKatException("Unexpected ending to gauss command '{0}'".format(text))
            
Daniel Brown's avatar
Daniel Brown committed
277
278
279
280
        if len(values) == 6:
            kat.nodes[node].setGauss(kat.components[component], gp)
        else:
            kat.nodes[node].setGauss(kat.components[component], gpx, gpy)
281
            
Daniel Brown's avatar
Daniel Brown committed
282
283
class tf(Command):
    
Daniel Brown's avatar
Daniel Brown committed
284
285
286
287
288
289
    class fQ(object):
        def __init__(self, f, Q):
            self.f = f
            self.Q = Q
            
    def __init__(self, name):
290
        Command.__init__(self, name, False)
Daniel Brown's avatar
Daniel Brown committed
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
        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
337
class xaxis(Command):
338
339
340
341
342
    """
    The xaxis object is a unique object to each pykat.finesse.kat instance. It provides
    and interface to the xaxis command in FINESSE.
    """
    
343
    def __init__(self, scale, limits, param, steps, comp=None, axis_type="xaxis"):
344
345
346
347
348
349
350
351
352
        """
        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.
        """
353
        Command.__init__(self, axis_type, True)
354
        
Daniel Brown's avatar
Daniel Brown committed
355
356
357
358
359
360
        self._axis_type = axis_type

        self.x = putter("x1")
        self.mx = putter("mx1")

        if scale == "lin":
361
            scale = Scale.linear
Daniel Brown's avatar
Daniel Brown committed
362
363
        elif scale == "log":
            scale = Scale.logarithmic
364
        elif isinstance(scale, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
365
            # else we have a string but not a recognisable one
366
            raise pkex.BasePyKatException("scale argument '{0}' is not valid, must be 'lin' or 'log'".format(scale))
Daniel Brown's avatar
Daniel Brown committed
367
368

        if scale != Scale.linear and scale != Scale.logarithmic:
369
            raise pkex.BasePyKatException("scale is not Scale.linear or Scale.logarithmic")
Daniel Brown's avatar
Daniel Brown committed
370
371
372
373

        self.scale = scale

        if numpy.size(limits) != 2 :
374
            raise pkex.BasePyKatException("limits input should be a 2x1 vector of limits for the xaxis")
Daniel Brown's avatar
Daniel Brown committed
375
376
377

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

378
        if int(steps) <= 0 :
379
            raise pkex.BasePyKatException("steps value should be > 0")
Daniel Brown's avatar
Daniel Brown committed
380
381
382

        self.steps = int(steps)

383
        if isinstance(param, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
384
            self.__param = param
385
386
387
388
            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
389
        elif not isinstance(param, Param) :
390
            raise pkex.BasePyKatException("param argument is not of type Param")
Daniel Brown's avatar
Daniel Brown committed
391
392
        else:
            self.__param = param
393
            self.__comp = param._owner()
Daniel Brown's avatar
Daniel Brown committed
394

395
396
397
398
    @property
    def param(self): return self.__param
    @param.setter
    def param(self, value):
399
400
401
402
403
404
        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
405
406
    @staticmethod
    def parseFinesseText(text):
407
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
408
409

        if values[0] != "xaxis" and values[0] != "xaxis*":
410
            raise pkex.BasePyKatException("'{0}' not a valid Finesse xaxis command".format(text))
Daniel Brown's avatar
Daniel Brown committed
411
412
413
414
415
416

        axis_type = values[0]

        values.pop(0) # remove initial value

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

419
        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
420
421

    def getFinesseText(self):
422
423
        if(self._kat.noxaxis):
            return '# noaxis is true, switching xaxis off'
Daniel Brown's avatar
Daniel Brown committed
424
        
Daniel Brown's avatar
Daniel Brown committed
425
        # store either the component name of the string provided
426
        comp_name = self.__comp.name if hasattr(self.__comp, "name") else self.__comp
Daniel Brown's avatar
Daniel Brown committed
427
        param_name = self.__param.name if isinstance(self.__param, Param) else self.__param
428
        
429
        return '{axis_type} {0} {1} {2} {3:.16g} {4:.16g} {5}'.format(
Daniel Brown's avatar
Daniel Brown committed
430
                comp_name, param_name, self.scale,
Daniel Brown's avatar
Daniel Brown committed
431
                self.limits[0], self.limits[1], self.steps, axis_type=self._axis_type);
Daniel Brown's avatar
Daniel Brown committed
432
433

class x2axis(xaxis):
434
435
    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)
Daniel Brown's avatar
Daniel Brown committed
436
437
438
439
440
        self.x = putter("x2")
        self.mx = putter("mx2")

    @staticmethod
    def parseFinesseText(text):
441
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
442
443

        if values[0] != "x2axis" and values[0] != "x2axis*":
444
            raise pkex.BasePyKatException("'{0}' not a valid Finesse xaxis command".format(text))
Daniel Brown's avatar
Daniel Brown committed
445
446
447
448
449
450

        axis_type = values[0]

        values.pop(0) # remove initial value

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

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