components.py 15.5 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
# -*- coding: utf-8 -*-
"""
Created on Mon Jan 28 11:10:01 2013

@author: Daniel
"""
import exceptions
8
import pykat.exceptions as pkex
Daniel Brown's avatar
Daniel Brown committed
9
10
import pykat
from pykat.node_network import *
Andreas Freise's avatar
Andreas Freise committed
11
from pykat.exceptions import *
12
import abc
Daniel Brown's avatar
Daniel Brown committed
13
14
15
16

import pykat.gui.resources
import pykat.gui.graphics
from pykat.gui.graphics import *
Andreas Freise's avatar
Andreas Freise committed
17
from pykat.SIfloat import *
Daniel Brown's avatar
Daniel Brown committed
18

19
20
next_component_id = 1

21
22
class NodeGaussSetter(object):
    def __init__(self, component, node):                
Daniel Brown's avatar
Daniel Brown committed
23
24
25
26
        self.__comp = component
        self.__node = node
    
    @property
27
28
    def node(self):
        return self.__node
Daniel Brown's avatar
Daniel Brown committed
29
30
    
    @property
31
32
33
    def q(self):
        return self.__node.qx
        
Daniel Brown's avatar
Daniel Brown committed
34
35
    @q.setter
    def q(self, value):
36
        self.__node.setGauss(self.__comp, complex(value))
Daniel Brown's avatar
Daniel Brown committed
37
38
        
    @property
39
40
    def qx(self):
        return self.__node.qx
Daniel Brown's avatar
Daniel Brown committed
41
42
    @qx.setter
    def qx(self, value):
43
        self.__node.setGauss(self.__comp, complex(value))
Daniel Brown's avatar
Daniel Brown committed
44
45
    
    @property
46
47
    def qy(self):
        return self.__node.qy
Daniel Brown's avatar
Daniel Brown committed
48
49
    @qy.setter
    def qy(self, value):
50
        self.__node.setGauss(self.__comp, self.qx, complex(value))
51
        
52
53
54
class Component(object):
    __metaclass__ = abc.ABCMeta
    
55
    def __init__(self, name):
Daniel Brown's avatar
Daniel Brown committed
56
57
        self.__name = name
        self._svgItem = None
58
59
        self._requested_node_names = []
        self._kat = None
Daniel Brown's avatar
Daniel Brown committed
60
        self.tag = None
61
62
63
64
65
66
        
        # store a unique ID for this component
        global next_component_id
        self.__id = next_component_id
        next_component_id += 1
        
67
68
69
70
71
72
        # 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,), {})
            
73
74
    def _on_kat_add(self, kat):
        """
75
76
77
78
        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.
79
        """
80
81
82
        if self._kat != None:
            raise pkex.BasePyKatException("Component has already been added to a finesse.kat object")
            
83
84
        self._kat = kat
        
85
        kat.nodes.registerComponentNodes(self, self._requested_node_names, self.__on_node_change)
86
        
87
    def __on_node_change(self):
88
        # need to update the node gauss parameter setter members 
Daniel Brown's avatar
Daniel Brown committed
89
        self.__update_node_setters()
90
91
92
93
94
95
        
    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)]
Daniel Brown's avatar
Daniel Brown committed
96
        
97
98
99
        # now we have a list of which to remove
        for key in key_rm:
            ns = self.__dict__[key]
100
101
            delattr(self, '__nodesetter_' + ns.node.name)
            delattr(self.__class__, ns.node.name)
Daniel Brown's avatar
Daniel Brown committed
102
        
103
        for node in self.nodes:
Daniel Brown's avatar
Daniel Brown committed
104
105
106
            if type(node) != pykat.node_network.DumpNode:
                ns = NodeGaussSetter(self, node)
                self.__add_node_setter(ns)
107
108
109
110
111
112
        
    def __add_node_setter(self, ns):

        if not isinstance(ns, NodeGaussSetter):
            raise exceptions.ValueError("Argument is not of type NodeGaussSetter")
        
Daniel Brown's avatar
Daniel Brown committed
113
        name = ns.node.name
114
115
        fget = lambda self: self.__get_node_setter(name)
        
116
        setattr(self.__class__, name, property(fget))
117
118
119
120
        setattr(self, '__nodesetter_' + name, ns)                   

    def __get_node_setter(self, name):
        return getattr(self, '__nodesetter_' + name)   
121
122
        
    @staticmethod
123
124
125
    @abc.abstractmethod
    def parseFinesseText(text):
        """Parses Finesse syntax"""
126
        raise NotImplementedError("This function is not implemented")
127
128
129

    @staticmethod
    @abc.abstractmethod
Daniel Brown's avatar
Daniel Brown committed
130
    def getFinesseText(self):
131
        """ Base class for individual Finesse optical components """    
Daniel Brown's avatar
Daniel Brown committed
132
        raise NotImplementedError("This function is not implemented")
133

Daniel Brown's avatar
Daniel Brown committed
134
135
    def getQGraphicsItem(self):    
        return None      
136
137
138
    
    @property
    def nodes(self): return self._kat.nodes.getComponentNodes(self) 
139
140
141
142
143
144
145
    
    @property    
    def name(self): return self.__name      
    
    @property
    def id(self): return self.__id
    
146
147
class Param(float):
    def __new__(self,name,value):
148
        return float.__new__(self,SIfloat(value))
149
         
Daniel Brown's avatar
Daniel Brown committed
150
151
152
    def __init__(self,name,value):
        self.__name = name
        
153
    name = property(lambda self: self.__name)
Daniel Brown's avatar
Daniel Brown committed
154

155
156
157
158
159
160
class AbstractMirrorComponent(Component):
    __metaclass__ = abc.ABCMeta
    
    def __init__(self, name, R=0, T=0, phi=0, Rcx=0, Rcy=0, xbeta=0, ybeta=0, mass=0, r_ap=0):
        super(AbstractMirrorComponent, self).__init__(name)

161
162
163
164
165
166
167
        self.__R = SIfloat(R)
        self.__T = SIfloat(T)
        self.__phi = SIfloat(phi)
        self.__Rcx = SIfloat(Rcx)
        self.__Rcy = SIfloat(Rcy)
        self.__xbeta = SIfloat(xbeta)
        self.__ybeta = SIfloat(ybeta)
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
        self.__mass = SIfloat(mass)
        self.__r_ap = SIfloat(r_ap)

    def getAttributeText(self):
        rtn = []
        
        if self.Rcx != 0: rtn.append("attr {0} Rcx {1}".format(self.name,self.__Rcx))
        if self.Rcy != 0: rtn.append("attr {0} Rcy {1}".format(self.name,self.__Rcy))
        if self.xbeta != 0: rtn.append("attr {0} xbeta {1}".format(self.name,self.__xbeta))
        if self.ybeta != 0: rtn.append("attr {0} ybeta {1}".format(self.name,self.__ybeta))
        if self.mass != 0: rtn.append("attr {0} mass {1}".format(self.name,self.__mass))
        if self.r_ap != 0: rtn.append("attr {0} r_ap {1}".format(self.name,self.__r_ap))
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
183
    @property
184
    def r_ap(self): return Param('r_ap', self.__r_ap)
Daniel Brown's avatar
Daniel Brown committed
185
    @r_ap.setter
186
    def r_ap(self,value): self.__aperture = SIfloat(value)
Daniel Brown's avatar
Daniel Brown committed
187

188
189
190
    @property
    def mass(self): return Param('mass', self.__mass)
    @mass.setter
191
    def mass(self,value): self.__mass = SIfloat(value)
192
    
193
    @property
194
    def R(self): return Param('R', self.__R)
195
    @R.setter
196
    def R(self,value): self.__R = SIfloat(value)
197
    
198
199
200
    @property
    def T(self): return Param('T', self.__T)
    @T.setter
201
    def T(self,value): self.__T = SIfloat(value)
202
203
204
205
        
    @property
    def phi(self): return Param('phi', self.__phi)
    @phi.setter
206
    def phi(self,value): self.__phi = SIfloat(value)
207
208
209
210
    
    @property
    def Rcx(self): return Param('Rcx', self.__Rcx)
    @Rcx.setter
211
    def Rcx(self,value): self.__Rcx = SIfloat(value)
212
    
213
214
215
    @property
    def Rcy(self): return Param('Rcy', self.__Rcy)
    @Rcy.setter
216
    def Rcy(self,value): self.__Rcy = SIfloat(value)
217
218
219
220
    
    @property
    def xbeta(self): return Param('xbeta', self.__xbeta)
    @xbeta.setter
221
    def xbeta(self,value): self.__xbeta = SIfloat(value)
222
    
223
224
225
    @property
    def ybeta(self): return Param('ybeta', self.__ybeta)
    @ybeta.setter
226
    def ybeta(self,value): self.__ybeta = SIfloat(value)
227
228
229
    
    @property
    def Rc(self):
Daniel Brown's avatar
Daniel Brown committed
230
231
232
233
234
        if self.Rcx == self.Rcy:
            return self.Rcx
        else:
            return [self.Rcx, self.Rcy]
    
235
236
    @Rc.setter
    def Rc(self,value):
237
238
        self.Rcx = SIfloat(value)
        self.Rcy = SIfloat(value)
239
240
241
242
243
244
245

class mirror(AbstractMirrorComponent):
    def __init__(self,name,node1,node2,R=0,T=0,phi=0,Rcx=0,Rcy=0,xbeta=0,ybeta=0,mass=0, r_ap=0):
        super(mirror, self).__init__(name, R, T, phi, Rcx, Rcy, xbeta, ybeta, mass, r_ap)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
246
247
248
249
250
    
    @staticmethod
    def parseFinesseText(text):
        values = text.split(" ")

251
        if values[0] != "m" and values[0] != "m1" and values[0] != "m2":
252
253
            raise exceptions.RuntimeError("'{0}' not a valid Finesse mirror command".format(text))
        
Andreas Freise's avatar
Andreas Freise committed
254
        if len(values) != 7:
255
256
            raise exceptions.RuntimeError("Mirror Finesse code format incorrect '{0}'".format(text))

257
        if len(values[0])==1:
Andreas Freise's avatar
Andreas Freise committed
258
            values.pop(0) # remove initial value
259
260
            return mirror(values[0], values[4], values[5], R=values[1], T=values[2], phi=values[3])
        else:
Andreas Freise's avatar
Andreas Freise committed
261
262
            if values[0][1]=="1":
                values.pop(0) # remove initial value
263
264
                return mirror(values[0], values[4], values[5], R=1.0-SIfloat(values[1])-SIfloat(values[2]), T=values[1], phi=values[3])
            else:
Andreas Freise's avatar
Andreas Freise committed
265
                values.pop(0) # remove initial value
266
267
                return mirror(values[0], values[4], values[5], R=values[1], T=1.0-SIfloat(values[1])-SIfloat(values[2]), phi=values[3])

Daniel Brown's avatar
Daniel Brown committed
268
269
    def getFinesseText(self):        
        rtn = []
270
            
Daniel Brown's avatar
Daniel Brown committed
271
        rtn.append('m {0} {1} {2} {3} {4} {5}'.format(
272
                self.name, self.R, self.T, self.phi,
273
                self.nodes[0].name, self.nodes[1].name))
Daniel Brown's avatar
Daniel Brown committed
274

275
        rtn.append(super(mirror, self).getAttributeText())
Daniel Brown's avatar
Daniel Brown committed
276
277
278
279
280
        
        return rtn
        
    def getQGraphicsItem(self):
        if self._svgItem == None:
281
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/mirror_flat.svg", self ,[(-4,15,self.nodes[0]), (14,15,self.nodes[1])])
Daniel Brown's avatar
Daniel Brown committed
282
            
Daniel Brown's avatar
Daniel Brown committed
283
        return self._svgItem
Sean Leavey's avatar
Sean Leavey committed
284

285
286
287
class beamSplitter(AbstractMirrorComponent):
    def __init__(self, name, node1, node2, node3, node4, R = 0, T = 0, phi = 0, alpha = 0, Rcx = 0, Rcy = 0, xbeta = 0, ybeta = 0, mass = 0, r_ap = 0):
        super(beamSplitter, self).__init__(name, R, T, phi, Rcx, Rcy, xbeta, ybeta, mass, r_ap)
Sean Leavey's avatar
Sean Leavey committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
        self._requested_node_names.append(node3)
        self._requested_node_names.append(node4)
             
        self.__alpha = SIfloat(alpha)
    
    @property
    def alpha(self): return Param('alpha', self.__alpha)
    @alpha.setter
    def alpha(self,value): self.__alpha = SIfloat(value)
    
    @staticmethod
    def parseFinesseText(text):
        values = text.split(" ")

        if values[0] != "bs" and values[0] != "bs1" and values[0] != "bs2":
            raise exceptions.RuntimeError("'{0}' not a valid Finesse beam splitter command".format(text))
        
        if len(values) != 10:
            raise exceptions.RuntimeError("Beam splitter Finesse code format incorrect '{0}'".format(text))

        if len(values[0])==1:
            values.pop(0) # remove initial value
            return beamSplitter(values[0], values[5], values[6], values[7], values[8], values[1], values[2], values[3], values[4])
        else:
            if values[0][1]=="1":
                values.pop(0) # remove initial value
                return beamSplitter(values[0], values[5], values[6], values[7], values[8], 1.0 - SIfloat(values[1]) - SIfloat(values[2]), values[1], values[3], values[4])
            else:
                values.pop(0) # remove initial value
                return beamSplitter(values[0], values[5], values[6], values[7], values[8], values[1], 1.0 - SIfloat(values[1]) - SIfloat(values[2]), values[3], values[4])
            
322
    def getFinesseText(self):
Sean Leavey's avatar
Sean Leavey committed
323
324
325
        rtn = []
            
        rtn.append('bs {0} {1} {2} {3} {4} {5} {6} {7} {8}'.format(
326
327
                self.name, self.R, self.T, self.phi,
                self.alpha, self.nodes[0].name,
Sean Leavey's avatar
Sean Leavey committed
328
329
330
                self.nodes[1].name, self.nodes[2].name,
                self.nodes[3].name))

331
        rtn.append(super(beamSplitter, self).getAttributeText())
Sean Leavey's avatar
Sean Leavey committed
332
333
334
335
336
337
338
339
340
        
        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
Daniel Brown's avatar
Daniel Brown committed
341
342
   
class space(Component):
343
344
    def __init__(self, name, node1, node2, L=0, n=1):
        Component.__init__(self,name,)
Daniel Brown's avatar
Daniel Brown committed
345
        
346
347
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
348
        
Andreas Freise's avatar
Andreas Freise committed
349
350
        self.__L = SIfloat(L)
        self.__n = SIfloat(n)
351
352
353
354
355
        self._QItem = None
        
    @property
    def L(self): return Param('L', self.__L)
    @L.setter
Andreas Freise's avatar
Andreas Freise committed
356
    def L(self,value): self.__L = SIfloat(value)
357
358
359
    @property
    def n(self): return Param('n', self.__n)
    @n.setter
Andreas Freise's avatar
Andreas Freise committed
360
    def n(self,value): self.__n = SIfloat(value)
361
    
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
    @staticmethod
    def parseFinesseText(text):
        values = text.split(" ")

        if values[0] != "s":
            raise exceptions.RuntimeError("'{0}' not a valid Finesse space command".format(text))

        values.pop(0) # remove initial value
        
        if len(values) == 5:
            return space(values[0],values[3],values[4],L=values[1],n=values[2])
        elif len(values) == 4:
            return space(values[0],values[2],values[3],L=values[1])
        else:
            raise exceptions.RuntimeError("Space Finesse code format incorrect '{0}'".format(text))
        
Daniel Brown's avatar
Daniel Brown committed
378
    def getFinesseText(self):
379
        if self.__n == 1:
380
            return 's {0} {1} {2} {3}'.format(self.name, self.__L, self.nodes[0].name, self.nodes[1].name)            
Daniel Brown's avatar
Daniel Brown committed
381
        else:
382
            return 's {0} {1} {2} {3} {4}'.format(self.name, self.__L, self.__n, self.nodes[0].name, self.nodes[1].name)            
Daniel Brown's avatar
Daniel Brown committed
383
       
384
385
    def getQGraphicsItem(self):
        if self._QItem == None:
386
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self)
387
        
388
        return self._QItem          
389
    
Daniel Brown's avatar
Daniel Brown committed
390
class laser(Component):
391
392
393
394
    def __init__(self,name,node,P=1,f_offset=0,phase=0):
        Component.__init__(self,name)
        
        self._requested_node_names.append(node)
Daniel Brown's avatar
Daniel Brown committed
395
        
396
397
398
        self.__power = float(P)
        self.__f_offset = float(f_offset)
        self.__phase = float(phase)
Daniel Brown's avatar
Daniel Brown committed
399
        
400
401
402
    @property
    def power(self): return Param('P', self.__power)
    @power.setter
403
    def power(self,value): self.__power = float(value)
404
405
406
407
    
    @property
    def f_offset(self): return Param('f', self.__f_offset)
    @f_offset.setter
408
    def f_offset(self,value): self.__f_offset = float(value)
409
410
411
412
    
    @property
    def phase(self): return Param('phase', self.__phase)
    @phase.setter
413
    def phase(self,value): self.__phase = float(value)
414
    
415
416
417
418
419
420
421
422
423
424
425
426
427
428
    @staticmethod
    def parseFinesseText(text):
        values = text.split(" ")

        if values[0] != "l":
            raise exceptions.RuntimeError("'{0}' not a valid Finesse laser command".format(text))

        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:
Andreas Freise's avatar
Andreas Freise committed
429
            raise exceptions.FinesseParse("Laser Finesse code format incorrect '{0}'".format(text))
430
    
Daniel Brown's avatar
Daniel Brown committed
431
    def getFinesseText(self):
432
        return 'l {0} {1} {2} {3} {4}'.format(self.name, self.__power, self.__f_offset, self.__phase, self.nodes[0].name)            
Daniel Brown's avatar
Daniel Brown committed
433
434
435
         
    def getQGraphicsItem(self):
        if self._svgItem == None:
436
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/laser.svg", self, [(65,25,self.nodes[0])])
Daniel Brown's avatar
Daniel Brown committed
437
438
439
            
        return self._svgItem