components.py 9.5 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.gui.resources
import pykat
10
import pykat.gui.graphics
11
#from pykat.gui.graphics import *
Daniel Brown's avatar
Daniel Brown committed
12
from pykat.node_network import *
13
14
#from PyQt4.QtGui import *
#from PyQt4.Qt import *
Daniel Brown's avatar
Daniel Brown committed
15

16
class Component(object) :
17
    def __init__(self, name):
Daniel Brown's avatar
Daniel Brown committed
18
19
20
        self.__name = name
        self._svgItem = None
        self.__nodes = []
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
        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")
Daniel Brown's avatar
Daniel Brown committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
        
    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:
51
            raise exceptions.RuntimeError("createNode did not return a node for '{0}'".format(name))
Daniel Brown's avatar
Daniel Brown committed
52
        else:
53
54
            n.connect(self)
                
Daniel Brown's avatar
Daniel Brown committed
55
56
57
58
59
60
61
62
63
64
65
66
67
            self.__nodes.append(n)
        
        return n
        
    def getNodes(self):
        """ Returns a copy of the nodes the component has """
        return self.__nodes[:]        
            
    def __getname(self):
        return self.__name      
        
    name = property(__getname)
    
68
69
70
71
class Param(float):
    def __new__(self,name,value):
        return float.__new__(self,value)
         
Daniel Brown's avatar
Daniel Brown committed
72
73
74
    def __init__(self,name,value):
        self.__name = name
        
75
76
    name = property(lambda self: self.__name)
           
Daniel Brown's avatar
Daniel Brown committed
77
class mirror(Component):
78
    def __init__(self,name,node1,node2,R=0,T=0,phi=0,Rcx=0,Rcy=0,xbeta=0,ybeta=0):
Daniel Brown's avatar
Daniel Brown committed
79
        
80
        Component.__init__(self,name)
Daniel Brown's avatar
Daniel Brown committed
81
        
82
83
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
84
        
85
86
87
88
89
90
91
        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)
92
93
            
    @property
94
    def R(self): return Param('R', self.__R)
95
    @R.setter
96
97
    def R(self,value): self.__R = float(value)
    
98
99
100
    @property
    def T(self): return Param('T', self.__T)
    @T.setter
101
    def T(self,value): self.__T = float(value)
102
103
104
105
        
    @property
    def phi(self): return Param('phi', self.__phi)
    @phi.setter
106
    def phi(self,value): self.__phi = float(value)
107
108
109
110
    
    @property
    def Rcx(self): return Param('Rcx', self.__Rcx)
    @Rcx.setter
111
112
    def Rcx(self,value): self.__Rcx = float(value)
    
113
114
115
    @property
    def Rcy(self): return Param('Rcy', self.__Rcy)
    @Rcy.setter
116
    def Rcy(self,value): self.__Rcy = float(value)
117
118
119
120
121
    
    
    @property
    def xbeta(self): return Param('xbeta', self.__xbeta)
    @xbeta.setter
122
    def xbeta(self,value): self.__xbeta = float(value)
123
124
125
    @property
    def ybeta(self): return Param('ybeta', self.__ybeta)
    @ybeta.setter
126
    def ybeta(self,value): self.__ybeta = float(value)
127
128
129
    
    @property
    def Rc(self):
Daniel Brown's avatar
Daniel Brown committed
130
131
132
133
134
        if self.Rcx == self.Rcy:
            return self.Rcx
        else:
            return [self.Rcx, self.Rcy]
    
135
136
    @Rc.setter
    def Rc(self,value):
137
138
        self.Rcx = float(value)
        self.Rcy = float(value)
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    
    @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
153
154
155
        
    def getFinesseText(self):        
        rtn = []
156
157
158
159
160
        nodes = self.getNodes()
        
        if len(nodes) != 2:
            raise exceptions.RuntimeError("Not enough nodes for mirror")
            
Daniel Brown's avatar
Daniel Brown committed
161
        rtn.append('m {0} {1} {2} {3} {4} {5}'.format(
162
                self.name, self.__R, self.__T, self.__phi,
163
                nodes[0].name, nodes[1].name))
Daniel Brown's avatar
Daniel Brown committed
164
            
165
166
167
168
        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
169
170
171
172
173
        
        return rtn
        
    def getQGraphicsItem(self):
        if self._svgItem == None:
174
            nodes = self.getNodes()
175
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/mirror_flat.svg",self
176
                                                ,[(-4,15,nodes[0]),(14,15,nodes[1])])
Daniel Brown's avatar
Daniel Brown committed
177
178
179
180
        return self._svgItem
   
   
class space(Component):
181
182
    def __init__(self, name, node1, node2, L=0, n=1):
        Component.__init__(self,name,)
Daniel Brown's avatar
Daniel Brown committed
183
        
184
185
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
186
        
187
188
        self.__L = float(L)
        self.__n = float(n)
189
190
191
192
193
        self._QItem = None
        
    @property
    def L(self): return Param('L', self.__L)
    @L.setter
194
    def L(self,value): self.__L = float(value)
195
196
197
    @property
    def n(self): return Param('n', self.__n)
    @n.setter
198
    def n(self,value): self.__n = float(value)
199
    
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
    @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
216
    def getFinesseText(self):
217
218
        nodes = self.getNodes()
        
219
        if self.__n == 1:
220
            return 's {0} {1} {2} {3}'.format(self.name, self.__L, nodes[0].name, nodes[1].name)            
Daniel Brown's avatar
Daniel Brown committed
221
        else:
222
            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
223
       
224
225
    def getQGraphicsItem(self):
        if self._QItem == None:
226
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self)
227
228
229
        
        return self._QItem  

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
    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)
        
        if self.node1 == node_old:
            self.node1 = node_new
        
        if self.node2 == node_old:
            self.node2 = node_new

    
Daniel Brown's avatar
Daniel Brown committed
245
class laser(Component):
246
247
248
249
    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
250
        
251
252
253
        self.__power = float(P)
        self.__f_offset = float(f_offset)
        self.__phase = float(phase)
Daniel Brown's avatar
Daniel Brown committed
254
        
255
256
257
    @property
    def power(self): return Param('P', self.__power)
    @power.setter
258
    def power(self,value): self.__power = float(value)
259
260
261
262
    
    @property
    def f_offset(self): return Param('f', self.__f_offset)
    @f_offset.setter
263
    def f_offset(self,value): self.__f_offset = float(value)
264
265
266
267
    
    @property
    def phase(self): return Param('phase', self.__phase)
    @phase.setter
268
    def phase(self,value): self.__phase = float(value)
269
    
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
    @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:
            raise exceptions.RuntimeError("Laser Finesse code format incorrect '{0}'".format(text))
    
Daniel Brown's avatar
Daniel Brown committed
286
    def getFinesseText(self):
287
288
289
        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
290
291
292
         
    def getQGraphicsItem(self):
        if self._svgItem == None:
293
            nodes = self.getNodes()
294
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/laser.svg",
295
                                                   self,[(65,25,nodes[0])])
Daniel Brown's avatar
Daniel Brown committed
296
297
298
            
        return self._svgItem