components.py 30.8 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# -*- coding: utf-8 -*-
"""
Created on Mon Jan 28 11:10:01 2013

@author: Daniel
"""
import exceptions
import pykat.exceptions as pkex
import pykat
from pykat.node_network import *
from pykat.exceptions import *
import abc

import pykat.gui.resources
import pykat.gui.graphics
from pykat.gui.graphics import *
from pykat.SIfloat import *
from pykat.param import Param, AttrParam
19
import weakref
20
21
import pykat.exceptions as pkex

Daniel Brown's avatar
Daniel Brown committed
22
23
24
25
next_component_id = 1

class NodeGaussSetter(object):
    def __init__(self, component, node):                
26
27
        self.__comp = weakref.ref(component)
        self.__node = weakref.ref(node)
Daniel Brown's avatar
Daniel Brown committed
28
29
30
    
    @property
    def node(self):
31
        return self.__node()
Daniel Brown's avatar
Daniel Brown committed
32
33
34
    
    @property
    def q(self):
35
        return self.__node().qx
Daniel Brown's avatar
Daniel Brown committed
36
37
38
        
    @q.setter
    def q(self, value):
39
        self.__node().setGauss(self.__comp(), complex(value))
Daniel Brown's avatar
Daniel Brown committed
40
41
42
        
    @property
    def qx(self):
43
        return self.__node().qx
Daniel Brown's avatar
Daniel Brown committed
44
45
    @qx.setter
    def qx(self, value):
46
        self.__node().setGauss(self.__comp(), complex(value))
Daniel Brown's avatar
Daniel Brown committed
47
48
49
    
    @property
    def qy(self):
50
        return self.__node().qy
Daniel Brown's avatar
Daniel Brown committed
51
52
    @qy.setter
    def qy(self, value):
53
        self.__node().setGauss(self.__comp(), self.qx, complex(value))
Daniel Brown's avatar
Daniel Brown committed
54
55
56
57
58
59
60
61
62
63
64
        
class Component(object):
    __metaclass__ = abc.ABCMeta
    
    def __init__(self, name):
        self.__name = name
        self._svgItem = None
        self._requested_node_names = []
        self._kat = None
        self.tag = None
        self._params = []
65
        self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
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
        
        # store a unique ID for this component
        global next_component_id
        self.__id = next_component_id
        next_component_id += 1
        
        # This creates an instance specific class for the component
        # this enables us to add properties to instances rather than
        # all classes
        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
    
    def _register_param(self, param):
        self._params.append(param)
        
    def _on_kat_add(self, kat):
        """
        Called when this component has been added to a kat object.
        kat is the finesse.kat object which it now belongs to and
        node_array is an array specific to this object which contains
        references to the nodes that are attached to it.
        """
        if self._kat != None:
            raise pkex.BasePyKatException("Component has already been added to a finesse.kat object")
            
        self._kat = kat
        
        kat.nodes.registerComponentNodes(self, self._requested_node_names, self.__on_node_change)
        
    def __on_node_change(self):
        # need to update the node gauss parameter setter members 
        self.__update_node_setters()
        
    def __update_node_setters(self):
        # check if any node setters have already been added. If so we
        # need to remove them. This function should get called if the nodes
        # are updated, either by some function call or the GUI
        key_rm = [k for k in self.__dict__ if k.startswith("__nodesetter_", 0, 13)]
        
        # now we have a list of which to remove
        for key in key_rm:
            ns = self.__dict__[key]
            delattr(self, '__nodesetter_' + ns.node.name)
            delattr(self.__class__, ns.node.name)
110
            
Daniel Brown's avatar
Daniel Brown committed
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
        for node in self.nodes:
            if type(node) != pykat.node_network.DumpNode:
                ns = NodeGaussSetter(self, node)
                self.__add_node_setter(ns)
        
    def __add_node_setter(self, ns):

        if not isinstance(ns, NodeGaussSetter):
            raise exceptions.ValueError("Argument is not of type NodeGaussSetter")
        
        name = ns.node.name
        fget = lambda self: self.__get_node_setter(name)
        
        setattr(self.__class__, name, property(fget))
        setattr(self, '__nodesetter_' + name, ns)                   

    def __get_node_setter(self, name):
        return getattr(self, '__nodesetter_' + name)   
        
    @staticmethod
    @abc.abstractmethod
    def parseFinesseText(text):
        """Parses Finesse syntax"""
        raise NotImplementedError("This function is not implemented")

    @abc.abstractmethod
    def getFinesseText(self):
        """ Base class for individual Finesse optical components """    
        raise NotImplementedError("This function is not implemented")

    @abc.abstractmethod
    def getQGraphicsItem(self):    
        return None      
    
145
146
147
    @property
    def removed(self): return self.__removed
    
Daniel Brown's avatar
Daniel Brown committed
148
149
150
151
152
153
154
155
156
157
158
    @property
    def nodes(self): return self._kat.nodes.getComponentNodes(self) 
    
    @property    
    def name(self): return self.__name      
    
    @property
    def id(self): return self.__id
    
    def __str__(self): return self.name
    
159
160
161
162
163
164
165
    def remove(self):
        self._kat.remove(self)
        
        del self._params[:]

        self.__removed = True
        
Daniel Brown's avatar
Daniel Brown committed
166
167
168
class AbstractMirrorComponent(Component):
    __metaclass__ = abc.ABCMeta
    
Daniel Brown's avatar
Daniel Brown committed
169
    def __init__(self, name, R=None, T=None, L=None, phi=0, Rcx=None, Rcy=None, xbeta=None, ybeta=None, mass=None, r_ap=None, Ix=None, Iy=None, zmech=None, rxmech=None, rymech=None):
Daniel Brown's avatar
Daniel Brown committed
170
        super(AbstractMirrorComponent, self).__init__(name)
171
 
Daniel Brown's avatar
Daniel Brown committed
172
        if (L != None and R != None and T != None) and SIfloat(R)+SIfloat(T)+SIfloat(L) != 1: 
173
            raise pkex.BasePyKatException('L+R+T must equal 1 if all are specified at {0}'.format(self.name))
174
        elif (R != None and L is None and T != None):
Daniel Brown's avatar
Daniel Brown committed
175
            L = 1- (SIfloat(R)+SIfloat(T))
176
        elif (R is None and L != None and T != None):
Daniel Brown's avatar
Daniel Brown committed
177
            R = 1 - (SIfloat(L)+SIfloat(T))
178
        elif (R != None and L != None and T is None):
Daniel Brown's avatar
Daniel Brown committed
179
            T = 1 - (SIfloat(L)+SIfloat(R))
180
        elif (L is None and R is None and T is None):
181
182
            raise pkex.BasePyKatException('Must specify at least two of L, R or T')
        
Daniel Brown's avatar
Daniel Brown committed
183
184
        self.__R = Param("R", self, SIfloat(R))
        self.__T = Param("T", self, SIfloat(T))
185
186
        self.__L = Param("L", self, SIfloat(L))
        
187
        self.__phi = Param("phi", self, SIfloat(phi), canFsig=True, fsig_name="phase")
Daniel Brown's avatar
Daniel Brown committed
188
189
        self.__Rcx = AttrParam("Rcx", self, SIfloat(Rcx))
        self.__Rcy = AttrParam("Rcy", self, SIfloat(Rcy))
190
191
        self.__xbeta = AttrParam("xbeta", self, SIfloat(xbeta), canFsig=True, fsig_name="x")
        self.__ybeta = AttrParam("ybeta", self, SIfloat(ybeta), canFsig=True, fsig_name="y")
Daniel Brown's avatar
Daniel Brown committed
192
        self.__mass = AttrParam("mass", self, SIfloat(mass))
Daniel Brown's avatar
Daniel Brown committed
193
194
        self.__Ix = AttrParam("Ix", self, SIfloat(Ix))
        self.__Iy = AttrParam("Iy", self, SIfloat(Iy))
Daniel Brown's avatar
Daniel Brown committed
195
        self.__r_ap = AttrParam("r_ap", self, SIfloat(r_ap))
196
    
Daniel Brown's avatar
Daniel Brown committed
197
198
199
200
        self.__zmech = AttrParam("zmech", self, zmech)
        self.__rxmech = AttrParam("rxmech", self, rxmech)
        self.__rymech = AttrParam("rymech", self, rymech)
        
201
202
203
    @property
    def L(self): return self.__L
    @L.setter
204
    def L(self,value): self.__L.value = SIfloat(value)       
Daniel Brown's avatar
Daniel Brown committed
205
206
207
208
209
210
211
212
213
214
215
        
    @property
    def r_ap(self): return self.__r_ap
    @r_ap.setter
    def r_ap(self,value): self.__r_ap.value = SIfloat(value)

    @property
    def mass(self): return self.__mass
    @mass.setter
    def mass(self,value): self.__mass.value = SIfloat(value)
    
Daniel Brown's avatar
Daniel Brown committed
216
217
218
219
220
221
222
223
224
225
    @property
    def Ix(self): return self.__Ix
    @Ix.setter
    def Ix(self,value): self.__Ix.value = SIfloat(value)
    
    @property
    def Iy(self): return self.__Iy
    @Iy.setter
    def Iy(self,value): self.__Iy.value = SIfloat(value)
    
Daniel Brown's avatar
Daniel Brown committed
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
    @property
    def R(self): return self.__R
    @R.setter
    def R(self,value): self.__R.value = SIfloat(value)
    
    @property
    def T(self): return self.__T
    @T.setter
    def T(self,value): self.__T.value = SIfloat(value)
        
    @property
    def phi(self): return self.__phi
    @phi.setter
    def phi(self,value): self.__phi.value = SIfloat(value)
    
    @property
    def Rcx(self): return self.__Rcx
    @Rcx.setter
    def Rcx(self,value): self.__Rcx.value = SIfloat(value)
    
    @property
    def Rcy(self): return self.__Rcy
    @Rcy.setter
    def Rcy(self,value): self.__Rcy.value = SIfloat(value)
    
    @property
    def xbeta(self): return self.__xbeta
    @xbeta.setter
    def xbeta(self,value): self.__xbeta.value = SIfloat(value)
    
    @property
    def ybeta(self): return self.__ybeta
    @ybeta.setter
    def ybeta(self,value): self.__ybeta.value = SIfloat(value)
    
Daniel Brown's avatar
Daniel Brown committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
    @property
    def zmech(self): return self.__zmech
    @zmech.setter
    def zmech(self,value): self.__zmech.value = value
    
    @property
    def rxmech(self): return self.__rxmech
    @rxmech.setter
    def rxmech(self,value): self.__rxmech.value = value
    
    @property
    def rymech(self): return self.__rymech
    @rymech.setter
    def rymech(self,value): self.__rymech.value = value
    
Daniel Brown's avatar
Daniel Brown committed
276
277
278
279
280
281
282
283
284
285
286
287
    @property
    def Rc(self):
        if self.Rcx == self.Rcy:
            return self.Rcx
        else:
            return [self.Rcx, self.Rcy]
    
    @Rc.setter
    def Rc(self,value):
        self.Rcx.value = SIfloat(value)
        self.Rcy.value = SIfloat(value)

Daniel Brown's avatar
Daniel Brown committed
288
289
290
291
292
293
294
    def parseAttribute(self, key, value):
        if key in ["Rcx", "Rx", "ROCx", "rx", "rcx", "rocx"]:
            self.Rcx = value
        elif key in ["Rcy", "Ry", "ROCy", "ry", "rcy", "rocy"]:
            self.Rcy = value
        elif key in ["Rc", "ROC", "r", "rc", "roc"]:
            self.Rc = value
Daniel Brown's avatar
Daniel Brown committed
295
        elif key in ["M","m", "Mass", "mass"]:
Daniel Brown's avatar
Daniel Brown committed
296
            self.mass = value
Daniel Brown's avatar
Daniel Brown committed
297
        elif key in ["xbeta", "xBeta"]:
Daniel Brown's avatar
Daniel Brown committed
298
            self.xbeta = value
Daniel Brown's avatar
Daniel Brown committed
299
        elif key in ["ybeta","yBeta"]:
Daniel Brown's avatar
Daniel Brown committed
300
301
302
303
304
305
306
            self.ybeta = value
        elif key in ["x_off"]:
            self.x_offset = value
        elif key in ["y_off"]:
            self.y_offset = value
        elif key in ["r_ap"]:
            self.r_ap = value
Daniel Brown's avatar
Daniel Brown committed
307
308
309
310
        elif key in ["Ix","ix"]:
            self.Ix = value
        elif key in ["Iy","iy"]:
            self.Iy = value
Daniel Brown's avatar
Daniel Brown committed
311
312
313
314
315
316
        elif key in ["zmech", "mech"]:
            self.zmech = value
        elif key in ["rxmech"]:
            self.rxmech = value
        elif key in ["rymech"]:
            self.rymech = value
Daniel Brown's avatar
Daniel Brown committed
317
318
319
320
321
        else:
            return False
            
        return True
        
Daniel Brown's avatar
Daniel Brown committed
322
class mirror(AbstractMirrorComponent):
323
    def __init__(self,name,node1,node2,R=None,T=None,L=None,phi=0,Rcx=None,Rcy=None,xbeta=None,ybeta=None,mass=None, r_ap=None):
Daniel Brown's avatar
Daniel Brown committed
324
        super(mirror, self).__init__(name, R, T, L, phi, Rcx, Rcy, xbeta, ybeta, mass, r_ap)
Daniel Brown's avatar
Daniel Brown committed
325
326
327
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
328
329
330
331
332
333
334

    def parseAttributes(self, values):
        
        for key in values.keys():
            if not self.parseAttribute(key, values[key]):
                raise pkex.BasePyKatException("No attribute {0} for mirrors".format(key))
        
Daniel Brown's avatar
Daniel Brown committed
335
336
    @staticmethod
    def parseFinesseText(text):
337
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
338
339

        if values[0] != "m" and values[0] != "m1" and values[0] != "m2":
340
            raise pkex.BasePyKatException("'{0}' not a valid Finesse mirror command".format(text))
Daniel Brown's avatar
Daniel Brown committed
341
342
        
        if len(values) != 7:
343
            raise pkex.BasePyKatException("Mirror Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
344
345
346

        if len(values[0])==1:
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
347
            return mirror(values[0], values[4], values[5], L=None, R=values[1], T=values[2], phi=values[3])
Daniel Brown's avatar
Daniel Brown committed
348
349
350
        else:
            if values[0][1]=="1":
                values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
351
                return mirror(values[0], values[4], values[5], R=None, L=values[2], T=values[1], phi=values[3])
Daniel Brown's avatar
Daniel Brown committed
352
353
            else:
                values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
354
                return mirror(values[0], values[4], values[5], T=None, R=values[1], L=values[2], phi=values[3])
Daniel Brown's avatar
Daniel Brown committed
355

356
    def getFinesseText(self):
Daniel Brown's avatar
Daniel Brown committed
357
        if self.R+self.T+self.L > 1:
358
359
            raise pkex.BasePyKatException("Mirror {0} has R+T+L > 1".format(self.name))        
        
Daniel Brown's avatar
Daniel Brown committed
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
        rtn = []
            
        rtn.append('m {0} {1} {2} {3} {4} {5}'.format(
                self.name, self.R.value, self.T.value, self.phi.value,
                self.nodes[0].name, self.nodes[1].name))

        for p in self._params:
            rtn.extend(p.getFinesseText())
                    
        return rtn
        
    def getQGraphicsItem(self):
        if self._svgItem == None:
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/mirror_flat.svg", self ,[(-4,15,self.nodes[0]), (14,15,self.nodes[1])])
            
        return self._svgItem

class beamSplitter(AbstractMirrorComponent):
378
379
    def __init__(self, name, node1, node2, node3, node4, R = None, T = None, L=None, phi = 0, alpha = 0, Rcx = None, Rcy = None, xbeta = None, ybeta = None, mass = None, r_ap = None):
        super(beamSplitter, self).__init__(name, R, T, L, phi, Rcx, Rcy, xbeta, ybeta, mass, r_ap)
Daniel Brown's avatar
Daniel Brown committed
380
381
382
383
384
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
        self._requested_node_names.append(node3)
        self._requested_node_names.append(node4)
Daniel Brown's avatar
Daniel Brown committed
385
        self.__alpha = Param("alpha", self, SIfloat(alpha))
386
        
Daniel Brown's avatar
Daniel Brown committed
387
388
389
390
391
    @property
    def alpha(self): return self.__alpha
    @alpha.setter
    def alpha(self,value): self.__alpha.value = SIfloat(value)
    
Daniel Brown's avatar
Daniel Brown committed
392
393
394
395
396
397
398
399
400
    def parseAttributes(self, values):
        
        for key in values.keys():
            if not self.parseAttribute(key, values[key]):
                if key == "alpha":
                    self.alpha = values[key]
                else:
                    raise pkex.BasePyKatException("No attribute {0} for mirrors".format(key))
                
Daniel Brown's avatar
Daniel Brown committed
401
402
    @staticmethod
    def parseFinesseText(text):
403
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
404
405

        if values[0] != "bs" and values[0] != "bs1" and values[0] != "bs2":
406
            raise pkex.BasePyKatException("'{0}' not a valid Finesse beam splitter command".format(text))
Daniel Brown's avatar
Daniel Brown committed
407
408
        
        if len(values) != 10:
409
            raise pkex.BasePyKatException("Beam splitter Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
410

411
        if len(values[0])==2:
Daniel Brown's avatar
Daniel Brown committed
412
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
413
414
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                values[1], values[2], None, values[3], values[4])
415
416
        elif values[0][2]=="1":
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
417
418
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                None, values[1], values[2], values[3], values[4])
Daniel Brown's avatar
Daniel Brown committed
419
        else:
420
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
421
422
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                values[1], None, values[2], values[3], values[4])
423
        
Daniel Brown's avatar
Daniel Brown committed
424
    def getFinesseText(self):
Daniel Brown's avatar
Daniel Brown committed
425
426
427
        if self.R+self.T+self.L > 1:
            raise pkex.BasePyKatException("Beamsplitter {0} has R+T+L > 1".format(self.name))

Daniel Brown's avatar
Daniel Brown committed
428
429
430
        rtn = []
            
        rtn.append('bs {0} {1} {2} {3} {4} {5} {6} {7} {8}'.format(
431
432
                self.name, self.R.value, self.T.value, self.phi.value,
                self.alpha.value, self.nodes[0].name,
Daniel Brown's avatar
Daniel Brown committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
                self.nodes[1].name, self.nodes[2].name,
                self.nodes[3].name))

        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn
        
    def getQGraphicsItem(self):
        if self._svgItem == None:
            # FIXME: make proper SVG component for beam splitter
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/mirror_flat.svg", self ,[(-4,15,self.nodes[0]), (14,15,self.nodes[1])])
            
        return self._svgItem
   
class space(Component):
449
    def __init__(self, name, node1, node2, L = 0, n = 1, g = None, gx = None, gy = None):
Daniel Brown's avatar
Daniel Brown committed
450
451
452
453
454
455
456
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
        self._QItem = None
        self.__L = Param("L", self, SIfloat(L))
        self.__n = Param("n", self, SIfloat(n))
457

458
459
        self.__gx = AttrParam("gx", self, gx)
        self.__gy = AttrParam("gy", self, gy)
Daniel Brown's avatar
Daniel Brown committed
460
461
462
463
        
    @property
    def L(self): return self.__L
    @L.setter
Andreas Freise's avatar
Andreas Freise committed
464
    def L(self,value): self.__L.value = SIfloat(value)
Daniel Brown's avatar
Daniel Brown committed
465
466
467
468
    @property
    def n(self): return self.__n
    @n.setter
    def n(self,value): self.__n.value = SIfloat(value)
469
470

    @property
Daniel Brown's avatar
Daniel Brown committed
471
472
473
474
475
476
    def g(self):
        if self.__gx.value == self.__gy.value: 
            return self.__g
        else:
            raise pkex.BasePyKatException("Gouy phase in x and y directions are different, use gx and gy properties instead")
            
477
    @g.setter
Daniel Brown's avatar
Daniel Brown committed
478
479
480
481
    def g(self,value):
        self.__gx.value = SIfloat(value)
        self.__gy.value = SIfloat(value)
        
482
483
484
485
486
487
488
489
490
    @property
    def gx(self): return self.__gx
    @gx.setter
    def gx(self,value): self.__gx.value = SIfloat(value)

    @property
    def gy(self): return self.__gy
    @gy.setter
    def gy(self,value): self.__gy.value = SIfloat(value)
Daniel Brown's avatar
Daniel Brown committed
491
    
Daniel Brown's avatar
Daniel Brown committed
492
493
494
495
496
497
498
499
500
501
502
503
504
    def parseAttributes(self, values):
        
        for key in values.keys():
            if key in ["gx","gouyx"]:
                self.__gx.value = values[key]
            elif key in ["gy", "gouyy"]:
                self.__gy.value = values[key]
            elif key in ["g, gouy"]:
                self.__gx.value = values[key]
                self.__gy.value = values[key]
            else:
                raise pkex.BasePyKatException("No attribute {0} for spaces".format(key))
                
Daniel Brown's avatar
Daniel Brown committed
505
506
    @staticmethod
    def parseFinesseText(text):
507
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
508
509

        if values[0] != "s":
510
            raise pkex.BasePyKatException("'{0}' not a valid Finesse space command".format(text))
Daniel Brown's avatar
Daniel Brown committed
511
512
513
514
515
516
517
518

        values.pop(0) # remove initial value
        
        if len(values) == 5:
            return space(values[0], values[3], values[4], values[1], values[2])
        elif len(values) == 4:
            return space(values[0], values[2], values[3], values[1])
        else:
519
            raise pkex.BasePyKatException("Space Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
        
    def getFinesseText(self):
        rtn = []
        
        if self.__n == 1:
            rtn.append('s {0} {1} {2} {3}'.format(self.name, self.__L.value, self.nodes[0].name, self.nodes[1].name))
        else:
            rtn.append('s {0} {1} {2} {3} {4}'.format(self.name, self.__L.value, self.__n.value, self.nodes[0].name, self.nodes[1].name))
       
        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn
        
    def getQGraphicsItem(self):
        if self._QItem == None:
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self)
        
        return self._QItem

class grating(Component):
541
    def __init__(self, name, node1, node2, node3 = None, node4 = None, n = 2, d = 0, eta_0 = None, eta_1 = None, eta_2 = None, eta_3 = None, rho_0 = None, alpha = None): # TODO: implement Rcx, Rcy and Rc
Daniel Brown's avatar
Daniel Brown committed
542
543
544
545
546
547
548
549
550
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)

        if n > 2:
            if node3 != None:
                self._requested_node_names.append(node3)
            else:
551
                raise pkex.BasePyKatException("Grating node 3 not specified")
Daniel Brown's avatar
Daniel Brown committed
552
553
554
555
556

        if n > 3:
            if node4 != None:
                self._requested_node_names.append(node4)
            else:
557
                raise pkex.BasePyKatException("Grating node 4 not specified")
Daniel Brown's avatar
Daniel Brown committed
558
559

        if n > 4 or n < 2:
560
            raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
        
        self.__n = n
        self.__d = Param("d", self, SIfloat(d))
        self.__eta_0 = AttrParam("eta_0", self, SIfloat(eta_0))
        self.__eta_1 = AttrParam("eta_1", self, SIfloat(eta_1))
        self.__eta_2 = AttrParam("eta_2", self, SIfloat(eta_2))
        self.__eta_3 = AttrParam("eta_3", self, SIfloat(eta_3))
        self.__rho_0 = AttrParam("rho_0", self, SIfloat(rho_0))
        self.__alpha = AttrParam("alpha", self, SIfloat(alpha))
    
    @property
    def n(self): return Param('n', self.__n)
    @n.setter
    def n(self, value):
        if value < 2 or value > 4:
576
            raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
        else:
            self.__n = value
    
    @property
    def d(self): return self.__d
    @d.setter
    def d(self, value): self.__d.value = SIfloat(value)
    
    @property
    def eta_0(self): return self.__eta_0
    @eta_0.setter
    def eta_0(self, value): self.__eta_0.value = SIfloat(value)
    
    @property
    def eta_1(self): return self.__eta_1
    @eta_1.setter
    def eta_1(self, value): self.__eta_1.value = SIfloat(value)
    
    @property
    def eta_2(self): return self.__eta_2
    @eta_2.setter
    def eta_2(self, value): self.__eta_2.value = SIfloat(value)
    
    @property
    def eta_3(self): return self.__eta_3
    @eta_3.setter
    def eta_3(self, value): self.__eta_3.value = SIfloat(value)
    
    @property
    def rho_0(self): return self.__rho_0
    @rho_0.setter
    def rho_0(self, value): self.__rho_0.value = SIfloat(value)
    
    @property
    def alpha(self): return self.__alpha
    @alpha.setter
    def alpha(self, value): self.__alpha.value = SIfloat(value)
    
    @staticmethod
    def parseFinesseText(text):
617
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
618
619

        if values[0][0 : 2] != "gr":
620
            raise pkex.BasePyKatException("'{0}' not a valid Finesse grating command".format(text))
Daniel Brown's avatar
Daniel Brown committed
621
622
623

        if len(values[0]) > 2:
            if int(values[0][2]) > 4 or int(values[0][2]) < 2:
624
                raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
625
626
627
628
629
630
631
632
633
            else:
                n = int(values[0][2])
        else:
            n = 2

        values.pop(0) # remove initial value
        
        if n == 2:
            if len(values) != 4:
634
                raise pkex.BasePyKatException("Two port grating must have 2 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
635
636
637
638

            return grating(values[0], values[2], values[3], None, None, n, values[1])
        elif n == 3:
            if len(values) != 5:
639
                raise pkex.BasePyKatException("Three port grating must have 3 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
640
641
642
643
            
            return grating(values[0], values[2], values[3], values[4], None, n, values[1])
        else:
            if len(values) != 6:
644
                raise pkex.BasePyKatException("Four port grating must have 4 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
            
            return grating(values[0], values[2], values[3], values[4], values[5], n, values[1])
        
    def getFinesseText(self):
        rtn = []
        
        if self.__n == 2:
            rtn.append('gr{0} {1} {2} {3} {4}'.format(self.__n, self.name, self.__d.value, self.nodes[0].name, self.nodes[1].name))
        elif self.__n == 3:
            rtn.append('gr{0} {1} {2} {3} {4} {5}'.format(self.__n, self.name, self.__d.value, self.nodes[0].name, self.nodes[1].name, self.nodes[2].name))
        else:
            rtn.append('gr{0} {1} {2} {3} {4} {5} {6}'.format(self.__n, self.name, self.__d.value, self.nodes[0].name, self.nodes[1].name, self.nodes[2].name, self.nodes[3].name))
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
       
    def getQGraphicsItem(self):
        if self._QItem == None:
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self) # TODO: make SVG graphic for grating
        
        return self._QItem

class isolator(Component):
670
    def __init__(self, name, node1, node2, node3="dump", S = 0):
Daniel Brown's avatar
Daniel Brown committed
671
672
673
674
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
675
        self._requested_node_names.append(node3)
Daniel Brown's avatar
Daniel Brown committed
676
677
678
679
680
681
682
683
684
685
        
        self.__S = Param("S",self,SIfloat(S))
        
    @property
    def S(self): return self.__S
    @S.setter
    def S(self, value): self.__S.value = SIfloat(value)
    
    @staticmethod
    def parseFinesseText(text):
686
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
687
688

        if values[0] != "isol":
689
            raise pkex.BasePyKatException("'{0}' not a valid Finesse isolator command".format(text))
Daniel Brown's avatar
Daniel Brown committed
690
691
692
693
694

        values.pop(0) # remove initial value
        
        if len(values) == 4:
            return isolator(values[0], values[2], values[3], values[1])
695
696
        elif len(values) == 5:
            return isolator(values[0], values[2], values[3], values[4], values[1])
Daniel Brown's avatar
Daniel Brown committed
697
        else:
698
            raise pkex.BasePyKatException("Isolator Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
699
700
        
    def getFinesseText(self):
701
        rtn = ['isol {0} {1} {2} {3} {4}'.format(self.name, self.S.value, self.nodes[0].name, self.nodes[1].name, self.nodes[2].name)]
Daniel Brown's avatar
Daniel Brown committed
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn

    def getQGraphicsItem(self):
        if self._QItem == None:
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self) # TODO: make isolator graphic
        
        return self._QItem

class lens(Component):
    def __init__(self, name, node1, node2, f):
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
        
        self.__f = Param("f", self, SIfloat(f))
        
    @property
    def f(self): return self.__f
    @f.setter
    def f(self, value): self.__f.value = SIfloat(value)
    
    @staticmethod
    def parseFinesseText(text):
730
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
731
732

        if values[0] != "lens":
733
            raise pkex.BasePyKatException("'{0}' not a valid Finesse lens command".format(text))
Daniel Brown's avatar
Daniel Brown committed
734
735
736
737
738
739

        values.pop(0) # remove initial value
        
        if len(values) == 4:
            return lens(values[0], values[2], values[3], values[1])
        else:
740
            raise pkex.BasePyKatException("Lens Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
        
    def getFinesseText(self):
        rtn = ['lens {0} {1} {2} {3}'.format(self.name, self.f.value, self.nodes[0].name, self.nodes[1].name)]
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn
        
    def getQGraphicsItem(self):
        if self._QItem == None:
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self) # TODO: make lens graphic
        
        return self._QItem
        
class modulator(Component):
    def __init__(self, name, f, midx, order, modulation_type, node1, node2, phase=0):
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
        
        self.__f = Param("f", self, SIfloat(f))
        self.__midx = Param("midx", self, SIfloat(midx))
        self.__phase = Param("phase", self, SIfloat(phase))
        self.__order = order
        self.type = modulation_type
        
            
    @property 
    def f(self): return self.__f
    @f.setter
    def f(self, value): self.__f.value = SIfloat(value)
    
    @property 
    def midx(self): return self.__midx
    @midx.setter
    def midx(self, value): self.__midx.value = SIfloat(value)
    
    @property 
    def phase(self): return self.__phase
    @phase.setter
    def phase(self, value): self.__phase.value = SIfloat(value)
    
    @property 
    def order(self): return self.__order
    @order.setter
    def order(self, value):
        if order <= 1 and order > 6:
            raise pkex.BasePyKatException("modulator order must be between 1 and 6")
            
        self.__order = int(value)
    
    @property 
    def type(self): return self.__type
    @type.setter
    def type(self, value):
        if value != "am" and value != "pm":
            raise pkex.BasePyKatException("Modulator type must be am (amplitude modulation) or pm (phase modulation)")
            
        self.__type = str(value)
    
    @staticmethod
    def parseFinesseText(text):
805
        v = text.split()
Daniel Brown's avatar
Daniel Brown committed
806
807

        if v[0] != "mod":
808
            raise pkex.BasePyKatException("'{0}' not a valid Finesse modulator command".format(text))
Daniel Brown's avatar
Daniel Brown committed
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838

        v.pop(0) # remove initial value
        
        if len(v) == 7:
            return modulator(v[0], v[1], v[2], v[3], v[4], v[5], v[6])
        if len(v) == 8:
            return modulator(v[0], v[1], v[2], v[3], v[4], v[6], v[7], phase=v[5])
        else:
            raise pkex.BasePyKatException("Modulator Finesse code format incorrect '{0}'".format(text))
        
    def getFinesseText(self):
        rtn = ['mod {0} {1} {2} {3} {4} {5} {6} {7}'.format(self.name, self.f, self.midx, self.order, self.type, self.phase, self.nodes[0].name, self.nodes[1].name)]
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn
        
    def getQGraphicsItem(self):
        if self._QItem == None:
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self) # TODO: make lens graphic
        
        return self._QItem

class laser(Component):
    def __init__(self,name,node,P=1,f_offset=0,phase=0):
        Component.__init__(self,name)
        
        self._requested_node_names.append(node)
        
839
840
        self.__power = Param("P", self, SIfloat(P), canFsig=True, fsig_name="amp")
        self.__f_offset = Param("f", self, SIfloat(f_offset), canFsig=True, fsig_name="f")
841
        self.__phase = Param("phase", self, SIfloat(phase), canFsig=True, fsig_name="phase")
842
        self.__noise = AttrParam("noise", self, None)
Daniel Brown's avatar
Daniel Brown committed
843
844
        
    @property
845
846
847
    def P(self): return self.__power
    @P.setter
    def P(self,value): self.__power.value = float(value)
Daniel Brown's avatar
Daniel Brown committed
848
849
850
851
852
853
854
855
856
857
858
    
    @property
    def f(self): return self.__f_offset
    @f.setter
    def f(self,value): self.__f_offset.value = float(value)
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase.value = float(value)
    
Daniel Brown's avatar
Daniel Brown committed
859
860
861
862
863
864
865
866
    def parseAttributes(self, values):
        
        for key in values.keys():
            if key == "noise":
                self.__noise.value = values[key]
            else:
                raise pkex.BasePyKatException("No attribute {0} at laser".format(key))
    
Daniel Brown's avatar
Daniel Brown committed
867
868
    @staticmethod
    def parseFinesseText(text):
869
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
870
871

        if values[0] != "l":
872
            raise pkex.BasePyKatException("'{0}' not a valid Finesse laser command".format(text))
Daniel Brown's avatar
Daniel Brown committed
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896

        values.pop(0) # remove initial value
        
        if len(values) == 5:
            return laser(values[0],values[4],P=values[1],f_offset=values[2],phase=values[3])
        elif len(values) == 4:
            return laser(values[0],values[3],P=values[1],f_offset=values[2], phase=0)
        else:
            raise exceptions.FinesseParse("Laser Finesse code format incorrect '{0}'".format(text))
    
    def getFinesseText(self):
        rtn = ['l {0} {1} {2} {3} {4}'.format(self.name, self.__power.value, self.__f_offset.value, self.__phase.value, self.nodes[0].name)]
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
         
    def getQGraphicsItem(self):
        if self._svgItem == None:
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/laser.svg", self, [(65,25,self.nodes[0])])
            
        return self._svgItem