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

@author: Daniel
"""
import exceptions
import pykat
from pykat.node_network import *
Andreas Freise's avatar
Andreas Freise committed
10
from pykat.exceptions import *
Daniel Brown's avatar
Daniel Brown committed
11
12
13
14

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

17
class Component(object) :
18
    def __init__(self, name):
Daniel Brown's avatar
Daniel Brown committed
19
20
        self.__name = name
        self._svgItem = None
Daniel Brown's avatar
Daniel Brown committed
21
        self._nodes = []
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
        self._requested_node_names = []
        self._kat = None
    
    def _on_kat_add(self, kat):
        """
        Called when this component has been added to a kat object
        """
        self._kat = kat
        
        for node_name in self._requested_node_names:
            self._addNode(node_name)
        
    @staticmethod
    def parseFinesseText(text):    
        raise NotImplementedError("This function is not implemented")
37
38
39
    
    def setAttr(name, value):    
        raise NotImplementedError("This function is not implemented")
Daniel Brown's avatar
Daniel Brown committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
        
    def getFinesseText(self):
        """ Base class for individual finesse optical components """    
        raise NotImplementedError("This function is not implemented")
        
    def getQGraphicsItem(self):    
        return None      
        
    def _addNode(self, name):
        """ Adds a node in sequential order to the component, i.e. add them
        n1, n2, n3, n4... etc. by the name of the node"""
            
        n = self._kat.nodes.createNode(name)
        
        if n == None:
55
            raise exceptions.RuntimeError("createNode did not return a node for '{0}'".format(name))
Daniel Brown's avatar
Daniel Brown committed
56
        else:
57
58
            n.connect(self)
                
Daniel Brown's avatar
Daniel Brown committed
59
            self._nodes.append(n)
Daniel Brown's avatar
Daniel Brown committed
60
61
62
63
64
        
        return n
        
    def getNodes(self):
        """ Returns a copy of the nodes the component has """
Daniel Brown's avatar
Daniel Brown committed
65
        return self._nodes[:]        
Daniel Brown's avatar
Daniel Brown committed
66
67
68
69
70
71
            
    def __getname(self):
        return self.__name      
        
    name = property(__getname)
    
72
73
74
75
class Param(float):
    def __new__(self,name,value):
        return float.__new__(self,value)
         
Daniel Brown's avatar
Daniel Brown committed
76
77
78
    def __init__(self,name,value):
        self.__name = name
        
79
80
    name = property(lambda self: self.__name)
           
Daniel Brown's avatar
Daniel Brown committed
81
class mirror(Component):
Daniel Brown's avatar
Daniel Brown committed
82
    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):
Daniel Brown's avatar
Daniel Brown committed
83
        
84
        Component.__init__(self,name)
Daniel Brown's avatar
Daniel Brown committed
85
        
86
87
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
88
89

        self.__r_ap = float(r_ap)        
90
        self.__mass = float(mass)
91
92
93
94
95
96
97
        self.__R = float(R)
        self.__T = float(T)
        self.__phi = float(phi)
        self.__Rcx = float(Rcx)
        self.__Rcy = float(Rcy)
        self.__xbeta = float(xbeta)
        self.__ybeta = float(ybeta)
98
    
Daniel Brown's avatar
Daniel Brown committed
99
100
101
102
103
    @property
    def r_ap(self): return Param('r_ap', self.__mass)
    @r_ap.setter
    def r_ap(self,value): self.__aperture = float(value)

104
105
106
107
108
    @property
    def mass(self): return Param('mass', self.__mass)
    @mass.setter
    def mass(self,value): self.__mass = float(value)
    
109
    @property
110
    def R(self): return Param('R', self.__R)
111
    @R.setter
112
113
    def R(self,value): self.__R = float(value)
    
114
115
116
    @property
    def T(self): return Param('T', self.__T)
    @T.setter
117
    def T(self,value): self.__T = float(value)
118
119
120
121
        
    @property
    def phi(self): return Param('phi', self.__phi)
    @phi.setter
122
    def phi(self,value): self.__phi = float(value)
123
124
125
126
    
    @property
    def Rcx(self): return Param('Rcx', self.__Rcx)
    @Rcx.setter
127
128
    def Rcx(self,value): self.__Rcx = float(value)
    
129
130
131
    @property
    def Rcy(self): return Param('Rcy', self.__Rcy)
    @Rcy.setter
132
    def Rcy(self,value): self.__Rcy = float(value)
133
134
135
136
    
    @property
    def xbeta(self): return Param('xbeta', self.__xbeta)
    @xbeta.setter
137
    def xbeta(self,value): self.__xbeta = float(value)
138
    
139
140
141
    @property
    def ybeta(self): return Param('ybeta', self.__ybeta)
    @ybeta.setter
142
    def ybeta(self,value): self.__ybeta = float(value)
143
144
145
    
    @property
    def Rc(self):
Daniel Brown's avatar
Daniel Brown committed
146
147
148
149
150
        if self.Rcx == self.Rcy:
            return self.Rcx
        else:
            return [self.Rcx, self.Rcy]
    
151
152
    @Rc.setter
    def Rc(self,value):
153
154
        self.Rcx = float(value)
        self.Rcy = float(value)
155
156
157
158
159
160
161
162
163
164
165
166
167
168
    
    @staticmethod
    def parseFinesseText(text):
        values = text.split(" ")

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

        values.pop(0) # remove initial value
        
        if len(values) != 6:
            raise exceptions.RuntimeError("Mirror Finesse code format incorrect '{0}'".format(text))

        return mirror(values[0], values[4], values[5], R=values[1], T=values[2], phi=values[3])
Daniel Brown's avatar
Daniel Brown committed
169
170
171
        
    def getFinesseText(self):        
        rtn = []
172
173
174
175
176
        nodes = self.getNodes()
        
        if len(nodes) != 2:
            raise exceptions.RuntimeError("Not enough nodes for mirror")
            
Daniel Brown's avatar
Daniel Brown committed
177
        rtn.append('m {0} {1} {2} {3} {4} {5}'.format(
178
                self.name, self.__R, self.__T, self.__phi,
179
                nodes[0].name, nodes[1].name))
Daniel Brown's avatar
Daniel Brown committed
180
181

        if self.r_ap != 0: rtn.append("attr {0} r_ap {1}".format(self.name,self.__r_ap))            
182
        if self.mass != 0: rtn.append("attr {0} mass {1}".format(self.name,self.__mass))
183
184
185
186
        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))
Daniel Brown's avatar
Daniel Brown committed
187
188
189
190
191
        
        return rtn
        
    def getQGraphicsItem(self):
        if self._svgItem == None:
192
            nodes = self.getNodes()
Daniel Brown's avatar
Daniel Brown committed
193
194
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/mirror_flat.svg", self ,[(-4,15,nodes[0]), (14,15,nodes[1])])
            
Daniel Brown's avatar
Daniel Brown committed
195
196
197
198
        return self._svgItem
   
   
class space(Component):
199
200
    def __init__(self, name, node1, node2, L=0, n=1):
        Component.__init__(self,name,)
Daniel Brown's avatar
Daniel Brown committed
201
        
202
203
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
204
        
Andreas Freise's avatar
Andreas Freise committed
205
206
        self.__L = SIfloat(L)
        self.__n = SIfloat(n)
207
208
209
210
211
        self._QItem = None
        
    @property
    def L(self): return Param('L', self.__L)
    @L.setter
212
    def L(self,value): self.__L = float(value)
213
214
215
    @property
    def n(self): return Param('n', self.__n)
    @n.setter
216
    def n(self,value): self.__n = float(value)
217
    
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
    @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
234
    def getFinesseText(self):
235
236
        nodes = self.getNodes()
        
237
        if self.__n == 1:
238
            return 's {0} {1} {2} {3}'.format(self.name, self.__L, nodes[0].name, nodes[1].name)            
Daniel Brown's avatar
Daniel Brown committed
239
        else:
240
            return 's {0} {1} {2} {3} {4}'.format(self.name, self.__L, self.__n, nodes[0].name, nodes[1].name)            
Daniel Brown's avatar
Daniel Brown committed
241
       
242
243
    def getQGraphicsItem(self):
        if self._QItem == None:
244
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self)
245
246
247
        
        return self._QItem  

248
249
250
251
252
253
254
255
    def changeNode(self, node_old, node_new):
        '''
        Called when a space's node has been connected
        to another components node
        '''
        node_new.connect(self)
        node_old.disconnect(self)
        
Daniel Brown's avatar
Daniel Brown committed
256
257
        if self._nodes[0] == node_old:
            self._nodes[0] = node_new
258
        
Daniel Brown's avatar
Daniel Brown committed
259
260
        if self._nodes[1] == node_old:
            self._nodes[1] = node_new
261
262

    
Daniel Brown's avatar
Daniel Brown committed
263
class laser(Component):
264
265
266
267
    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
268
        
269
270
271
        self.__power = float(P)
        self.__f_offset = float(f_offset)
        self.__phase = float(phase)
Daniel Brown's avatar
Daniel Brown committed
272
        
273
274
275
    @property
    def power(self): return Param('P', self.__power)
    @power.setter
276
    def power(self,value): self.__power = float(value)
277
278
279
280
    
    @property
    def f_offset(self): return Param('f', self.__f_offset)
    @f_offset.setter
281
    def f_offset(self,value): self.__f_offset = float(value)
282
283
284
285
    
    @property
    def phase(self): return Param('phase', self.__phase)
    @phase.setter
286
    def phase(self,value): self.__phase = float(value)
287
    
288
289
290
291
292
293
294
295
296
297
298
299
300
301
    @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
302
            raise exceptions.FinesseParse("Laser Finesse code format incorrect '{0}'".format(text))
303
    
Daniel Brown's avatar
Daniel Brown committed
304
    def getFinesseText(self):
305
306
307
        nodes = self.getNodes()
        
        return 'l {0} {1} {2} {3} {4}'.format(self.name, self.__power, self.__f_offset, self.__phase, nodes[0].name)            
Daniel Brown's avatar
Daniel Brown committed
308
309
310
         
    def getQGraphicsItem(self):
        if self._svgItem == None:
311
            nodes = self.getNodes()
312
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/laser.svg",
313
                                                   self,[(65,25,nodes[0])])
Daniel Brown's avatar
Daniel Brown committed
314
315
316
            
        return self._svgItem