components.py 44.9 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:10:01 2013

@author: Daniel
"""
7
from __future__ import print_function
Daniel Brown's avatar
Daniel Brown committed
8
9
10

from pykat import USE_GUI, HAS_OPTIVIS, NoGUIException

11
import pykat.external.six as six
Daniel Brown's avatar
Daniel Brown committed
12

13
14
if six.PY2:
	import exceptions
Daniel Brown's avatar
Daniel Brown committed
15

Daniel Brown's avatar
Daniel Brown committed
16
17
18
19
20
import pykat.exceptions as pkex
import pykat
from pykat.node_network import *
from pykat.exceptions import *
import abc
21
import copy
Daniel Brown's avatar
Daniel Brown committed
22
from collections import OrderedDict
Daniel Brown's avatar
Daniel Brown committed
23

Daniel Brown's avatar
Daniel Brown committed
24
25
if HAS_OPTIVIS:
    import optivis.bench.components as optivis_components
Daniel Brown's avatar
Daniel Brown committed
26
    from optivis.view.canvas import OptivisCanvasItemDataType
Daniel Brown's avatar
Daniel Brown committed
27

Daniel Brown's avatar
Daniel Brown committed
28
29
from pykat.SIfloat import *
from pykat.param import Param, AttrParam
30
import weakref
31
32
import pykat.exceptions as pkex

Daniel Brown's avatar
Daniel Brown committed
33
34
next_component_id = 1

35
36
37
38
39
if USE_GUI:
    import pykat.gui.resources
    import pykat.gui.graphics
    from pykat.gui.graphics import *

Daniel Brown's avatar
Daniel Brown committed
40
41
class NodeGaussSetter(object):
    def __init__(self, component, node):                
42
43
        self.__comp = weakref.ref(component)
        self.__node = weakref.ref(node)
Daniel Brown's avatar
Daniel Brown committed
44
45
46
47
48
49
50
51
52
        self.__name = None
        
    @property
    def name(self):
        return self.__name
        
    @name.setter
    def name(self, value):
        self.__name = str(value)
Daniel Brown's avatar
Daniel Brown committed
53
54
55
    
    @property
    def node(self):
56
        return self.__node()
Daniel Brown's avatar
Daniel Brown committed
57
58
59
    
    @property
    def q(self):
60
        return self.__node().qx
Daniel Brown's avatar
Daniel Brown committed
61
62
63
        
    @q.setter
    def q(self, value):
64
        self.__node().setGauss(self.__comp(), complex(value))
Daniel Brown's avatar
Daniel Brown committed
65
66
67
        
    @property
    def qx(self):
68
        return self.__node().qx
Daniel Brown's avatar
Daniel Brown committed
69
70
    @qx.setter
    def qx(self, value):
71
        self.__node().setGauss(self.__comp(), complex(value))
Daniel Brown's avatar
Daniel Brown committed
72
73
74
    
    @property
    def qy(self):
75
        return self.__node().qy
Daniel Brown's avatar
Daniel Brown committed
76
77
    @qy.setter
    def qy(self, value):
78
        self.__node().setGauss(self.__comp(), self.qx, complex(value))
Daniel Brown's avatar
Daniel Brown committed
79
80
81
        
class Component(object):
    __metaclass__ = abc.ABCMeta
82
83
84
85
86
87
88
89
90

    def __new__(cls, *args, **kwargs):
        # This creates an instance specific class for the component
        # this enables us to add properties to instances rather than
        # all classes
        return object.__new__(type(cls.__name__, (cls,), {}), *args, **kwargs)
        
    def __init__(self, name=None):
        
Daniel Brown's avatar
Daniel Brown committed
91
        self._optivis_component = None
Daniel Brown's avatar
Daniel Brown committed
92
93
94
95
96
97
        self.__name = name
        self._svgItem = None
        self._requested_node_names = []
        self._kat = None
        self.tag = None
        self._params = []
98
        self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
99
        self._default_fsig_param = None
Daniel Brown's avatar
Daniel Brown committed
100
        self.optivisLabelContent = None
Daniel Brown's avatar
Daniel Brown committed
101
102
103
104
105
106
        
        # store a unique ID for this component
        global next_component_id
        self.__id = next_component_id
        next_component_id += 1
        
107
108
109
110
111
112
113
114
115
116
117
118
119
       
    def __deepcopy__(self, memo):
        """
        When deep copying a kat object we need to take into account
        the instance specific properties.
        """
        result = self.__class__.__new__(self.__class__)
        result.__dict__ = copy.deepcopy(self.__dict__, memo)
        
        result.__update_node_setters             
        
        return result
        
Daniel Brown's avatar
Daniel Brown committed
120
121
    def _register_param(self, param):
        self._params.append(param)
Daniel Brown's avatar
Daniel Brown committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
    
    def _default_fsig(self):
        """
        Returns what Finesse internally determines as the default 
        fsig parameter. This is used mainly for parsing fsig command
        lines where no target parameter is stated.
        """
        if self._default_fsig_param != None:
            if not self._default_fsig_param.canFsig:
                raise pkex.BasePyKatException("Default fsig parameter %s is not possible to fsig" % (self.__default_fsig_param.name))
            else:
                return self._default_fsig_param
        else:
            return None
    
Daniel Brown's avatar
Daniel Brown committed
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
    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)
166
            
Daniel Brown's avatar
Daniel Brown committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
        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):    
199
200
201
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
202
203
        return None      
    
204
205
206
    @property
    def removed(self): return self.__removed
    
Daniel Brown's avatar
Daniel Brown committed
207
208
209
210
211
212
213
214
215
216
217
    @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
    
218
219
220
    def remove(self):
        self._kat.remove(self)
        
221
222
223
224
225
        # inform all parameters that we have removed its owner
        # so that it can then warn about any puts/vars/xaxis
        for p in self._params:
            p._onOwnerRemoved()
        
226
227
228
        del self._params[:]

        self.__removed = True
Daniel Brown's avatar
Daniel Brown committed
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
    
    def getOptivisParameterDict(self):
        if len(self._params) == 0:
            return None
            
        d = OrderedDict()
        
        for p in self._params:
            d[p.name] = OptivisCanvasItemDataType.TEXTBOX
        
        return d
        
    def getOptivisTooltip(self):
        tooltip = "Name: %s" % self.name
        
        for p in self._params:
            if p.value is not None:
                tooltip += "\n%s = %s" %(p.name, str(p.value))
247
        
Daniel Brown's avatar
Daniel Brown committed
248
249
250
251
252
253
254
255
256
257
258
259
260
        return tooltip

    def setOptivisLabelContent(self):
        """
        Sets default Optivis label contents
        """

        if self.optivisLabelContent is None:
            self.optivisLabelContent = {}

        self.optivisLabelContent["Name"] = self.name


Daniel Brown's avatar
Daniel Brown committed
261
262
class AbstractMirrorComponent(Component):
    __metaclass__ = abc.ABCMeta
263
        
Daniel Brown's avatar
Daniel Brown committed
264
    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
265
        super(AbstractMirrorComponent, self).__init__(name)
266
 
Daniel Brown's avatar
Daniel Brown committed
267
        if (L != None and R != None and T != None) and SIfloat(R)+SIfloat(T)+SIfloat(L) != 1: 
268
            raise pkex.BasePyKatException('L+R+T must equal 1 if all are specified at {0}'.format(self.name))
269
        elif (R != None and L is None and T != None):
Daniel Brown's avatar
Daniel Brown committed
270
            L = 1- (SIfloat(R)+SIfloat(T))
271
        elif (R is None and L != None and T != None):
Daniel Brown's avatar
Daniel Brown committed
272
            R = 1 - (SIfloat(L)+SIfloat(T))
273
        elif (R != None and L != None and T is None):
Daniel Brown's avatar
Daniel Brown committed
274
            T = 1 - (SIfloat(L)+SIfloat(R))
275
        elif (L is None and R is None and T is None):
276
277
            raise pkex.BasePyKatException('Must specify at least two of L, R or T')
        
Daniel Brown's avatar
Daniel Brown committed
278
279
        self.__R = Param("R", self, SIfloat(R))
        self.__T = Param("T", self, SIfloat(T))
280
281
        self.__L = Param("L", self, SIfloat(L))
        
282
        self.__phi = Param("phi", self, SIfloat(phi), canFsig=True, fsig_name="phase")
Daniel Brown's avatar
Daniel Brown committed
283
284
        self.__Rcx = AttrParam("Rcx", self, SIfloat(Rcx))
        self.__Rcy = AttrParam("Rcy", self, SIfloat(Rcy))
285
286
        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
287
        self.__mass = AttrParam("mass", self, SIfloat(mass))
Daniel Brown's avatar
Daniel Brown committed
288
289
        self.__Ix = AttrParam("Ix", self, SIfloat(Ix))
        self.__Iy = AttrParam("Iy", self, SIfloat(Iy))
Daniel Brown's avatar
Daniel Brown committed
290
        self.__r_ap = AttrParam("r_ap", self, SIfloat(r_ap))
291
    
Daniel Brown's avatar
Daniel Brown committed
292
293
294
295
        self.__zmech = AttrParam("zmech", self, zmech)
        self.__rxmech = AttrParam("rxmech", self, rxmech)
        self.__rymech = AttrParam("rymech", self, rymech)
        
Daniel Brown's avatar
Daniel Brown committed
296
297
298
299
300
301
        self.__z = Param("z", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="z")
        self.__rx = Param("rx", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="rx")
        self.__ry = Param("ry", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="ry")
        self.__Fz = Param("Fz", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="Fz")
        self.__Frx = Param("Frx", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="Frx")
        self.__Fry = Param("Fry", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="Fry")
302
        
Daniel Brown's avatar
Daniel Brown committed
303
304
        self._default_fsig_param = self.__phi
        
305
306
307
308
309
310
311
312
313
314
315
316
317
    @property
    def z(self): return self.__z
    @property
    def Fz(self): return self.__Fz
    @property
    def rx(self): return self.__rx
    @property
    def Frx(self): return self.__Frx
    @property
    def ry(self): return self.__ry
    @property
    def Fry(self): return self.__Fry
    
318
319
320
    @property
    def L(self): return self.__L
    @L.setter
321
    def L(self,value): self.__L.value = SIfloat(value)       
Daniel Brown's avatar
Daniel Brown committed
322
323
324
325
326
327
328
329
330
331
332
        
    @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
333
334
335
336
337
338
339
340
341
342
    @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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
    @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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
    @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
393
394
395
396
397
398
399
400
401
402
403
404
    @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
405
406
407
408
409
410
411
    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
412
        elif key in ["M","m", "Mass", "mass"]:
Daniel Brown's avatar
Daniel Brown committed
413
            self.mass = value
Daniel Brown's avatar
Daniel Brown committed
414
        elif key in ["xbeta", "xBeta"]:
Daniel Brown's avatar
Daniel Brown committed
415
            self.xbeta = value
Daniel Brown's avatar
Daniel Brown committed
416
        elif key in ["ybeta","yBeta"]:
Daniel Brown's avatar
Daniel Brown committed
417
418
419
420
421
422
423
            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
424
425
426
427
        elif key in ["Ix","ix"]:
            self.Ix = value
        elif key in ["Iy","iy"]:
            self.Iy = value
Daniel Brown's avatar
Daniel Brown committed
428
429
430
431
432
433
        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
434
435
436
437
438
        else:
            return False
            
        return True
        
Daniel Brown's avatar
Daniel Brown committed
439
class mirror(AbstractMirrorComponent):
440
    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
441
        super(mirror, self).__init__(name, R, T, L, phi, Rcx, Rcy, xbeta, ybeta, mass, r_ap)
Daniel Brown's avatar
Daniel Brown committed
442
443
444
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
Daniel Brown's avatar
Daniel Brown committed
445
446
447
448
449
450
451

    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
452
453
    @staticmethod
    def parseFinesseText(text):
454
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
455
456

        if values[0] != "m" and values[0] != "m1" and values[0] != "m2":
457
            raise pkex.BasePyKatException("'{0}' not a valid Finesse mirror command".format(text))
Daniel Brown's avatar
Daniel Brown committed
458
459
        
        if len(values) != 7:
460
            raise pkex.BasePyKatException("Mirror Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
461
462
463

        if len(values[0])==1:
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
464
            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
465
466
467
        else:
            if values[0][1]=="1":
                values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
468
                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
469
470
            else:
                values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
471
                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
472

473
    def getFinesseText(self):
Daniel Brown's avatar
Daniel Brown committed
474
        if self.R+self.T+self.L > 1:
475
476
            raise pkex.BasePyKatException("Mirror {0} has R+T+L > 1".format(self.name))        
        
Daniel Brown's avatar
Daniel Brown committed
477
478
479
480
481
482
483
484
485
486
        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
Daniel Brown's avatar
Daniel Brown committed
487
488
    
    def getOptivisComponent(self):
Daniel Brown's avatar
Daniel Brown committed
489
490
        self.setOptivisLabelContent()
        
Daniel Brown's avatar
Daniel Brown committed
491
        if self._optivis_component is None:
Daniel Brown's avatar
Daniel Brown committed
492
            self._optivis_component = optivis_components.CavityMirror(name=self.name, aoi=0, tooltip=self.getOptivisTooltip, paramList=self.getOptivisParameterDict(), pykatObject=weakref.ref(self))
Daniel Brown's avatar
Daniel Brown committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
        
        return self._optivis_component
    
    def getOptivisNode(self, mode, kat_node):
        mode = mode.lower()
        
        if mode != "input" and mode.lower() != "output":
            raise pkex.BasePyKatException("Mode must be either input or output not %s" % mode)
        
        if mode == "input":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getInputNode("fr")
            else:
                return self._optivis_component.getInputNode("bk")
                
        elif mode == "output":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getOutputNode("fr")
            else:
                return self._optivis_component.getOutputNode("bk")
          
Daniel Brown's avatar
Daniel Brown committed
514
515
        
    def getQGraphicsItem(self):
516
517
518
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
519
520
521
522
523
524
        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):
525
526
    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
527
528
529
530
531
        
        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
532
        self.__alpha = Param("alpha", self, SIfloat(alpha))
533
        
Daniel Brown's avatar
Daniel Brown committed
534
535
536
537
538
    @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
539
540
541
542
543
544
545
546
    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
547
548
    
    def getOptivisComponent(self):
Daniel Brown's avatar
Daniel Brown committed
549
550
        self.setOptivisLabelContent()
        
Daniel Brown's avatar
Daniel Brown committed
551
        if self._optivis_component is None:
Daniel Brown's avatar
Daniel Brown committed
552
            self._optivis_component = optivis_components.BeamSplitter(name=self.name, aoi=-self.alpha, tooltip=self.getOptivisTooltip, paramList=self.getOptivisParameterDict(), pykatObject=weakref.ref(self))
Daniel Brown's avatar
Daniel Brown committed
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
        
        return self._optivis_component
    
    def getOptivisNode(self, mode, kat_node):
        mode = mode.lower()
        
        if mode != "input" and mode.lower() != "output":
            raise pkex.BasePyKatException("Mode must be either input or output")
        
        if mode == "input":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getInputNode("frA")
            elif kat_node is self.nodes[1]:
                return self._optivis_component.getInputNode("frB")
            elif kat_node is self.nodes[2]:
                return self._optivis_component.getInputNode("bkB")
569
570
            elif kat_node is self.nodes[3]:
                return self._optivis_component.getInputNode("bkA")
Daniel Brown's avatar
Daniel Brown committed
571
572
573
        elif mode == "output":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getOutputNode("frB")
574
575
            elif kat_node is self.nodes[1]:
                return self._optivis_component.getOutputNode("frA")
Daniel Brown's avatar
Daniel Brown committed
576
577
578
579
580
            elif kat_node is self.nodes[2]:
                return self._optivis_component.getOutputNode("bkA")
            elif kat_node is self.nodes[3]:
                return self._optivis_component.getOutputNode("bkB")
                     
Daniel Brown's avatar
Daniel Brown committed
581
582
    @staticmethod
    def parseFinesseText(text):
583
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
584
585

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

591
        if len(values[0])==2:
Daniel Brown's avatar
Daniel Brown committed
592
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
593
594
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                values[1], values[2], None, values[3], values[4])
595
596
        elif values[0][2]=="1":
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
597
598
            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
599
        else:
600
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
601
602
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                values[1], None, values[2], values[3], values[4])
603
        
Daniel Brown's avatar
Daniel Brown committed
604
    def getFinesseText(self):
Daniel Brown's avatar
Daniel Brown committed
605
606
607
        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
608
609
610
        rtn = []
            
        rtn.append('bs {0} {1} {2} {3} {4} {5} {6} {7} {8}'.format(
611
612
                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
613
614
615
616
617
618
619
620
621
                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):
622
623
624
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
625
626
        if self._svgItem == None:
            # FIXME: make proper SVG component for beam splitter
627
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/mirror_flat.svg", self ,[(-4,24,self.nodes[0]), (-4,6,self.nodes[1]), (14,6,self.nodes[2]), (14,24,self.nodes[3])])
Daniel Brown's avatar
Daniel Brown committed
628
629
630
631
            
        return self._svgItem
   
class space(Component):
632
    def __init__(self, name, node1, node2, L = 0, n = 1, g = None, gx = None, gy = None):
Daniel Brown's avatar
Daniel Brown committed
633
634
635
636
637
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
        self._QItem = None
Daniel Brown's avatar
Daniel Brown committed
638
        self.__L = Param("L", self, SIfloat(L), canFsig=True, fsig_name="phase")
Daniel Brown's avatar
Daniel Brown committed
639
        self.__n = Param("n", self, SIfloat(n))
640

641
642
        self.__gx = AttrParam("gx", self, gx)
        self.__gy = AttrParam("gy", self, gy)
Daniel Brown's avatar
Daniel Brown committed
643
        
Daniel Brown's avatar
Daniel Brown committed
644
645
        self._default_fsig_param = self.__L
        
Daniel Brown's avatar
Daniel Brown committed
646
647
648
    @property
    def L(self): return self.__L
    @L.setter
Andreas Freise's avatar
Andreas Freise committed
649
    def L(self,value): self.__L.value = SIfloat(value)
Daniel Brown's avatar
Daniel Brown committed
650
651
652
653
    @property
    def n(self): return self.__n
    @n.setter
    def n(self,value): self.__n.value = SIfloat(value)
654
655

    @property
Daniel Brown's avatar
Daniel Brown committed
656
657
658
659
660
661
    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")
            
662
    @g.setter
Daniel Brown's avatar
Daniel Brown committed
663
664
665
666
    def g(self,value):
        self.__gx.value = SIfloat(value)
        self.__gy.value = SIfloat(value)
        
667
668
669
670
671
672
673
674
675
    @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
676
    
Daniel Brown's avatar
Daniel Brown committed
677
678
679
680
681
682
683
684
685
686
687
688
    def connectingComponents(self):
        """
        Returns the two components that this space connects.
        """
        a = list(self.nodes[0].components + self.nodes[1].components)
        a = [value for value in a if value != self]
        
        if len(a) != 2:
            raise pkex.BasePyKatException("Space should only connect 2 components")
            
        return a
        
Daniel Brown's avatar
Daniel Brown committed
689
690
691
692
693
694
695
    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]
696
            elif key in ["g","gouy"]:
Daniel Brown's avatar
Daniel Brown committed
697
698
699
700
701
                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
702
703
    @staticmethod
    def parseFinesseText(text):
704
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
705
706

        if values[0] != "s":
707
            raise pkex.BasePyKatException("'{0}' not a valid Finesse space command".format(text))
Daniel Brown's avatar
Daniel Brown committed
708
709
710
711
712
713
714
715

        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:
716
            raise pkex.BasePyKatException("Space Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
        
    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):
732
733
734
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
735
736
737
738
739
740
        if self._QItem == None:
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self)
        
        return self._QItem

class grating(Component):
741
    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
742
743
744
745
746
747
748
749
750
        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:
751
                raise pkex.BasePyKatException("Grating node 3 not specified")
Daniel Brown's avatar
Daniel Brown committed
752
753
754
755
756

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

        if n > 4 or n < 2:
760
            raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
761
762
763
764
765
766
767
768
769
        
        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))
770
771
        self._svgItem = None
        
Daniel Brown's avatar
Daniel Brown committed
772
773
774
775
776
    @property
    def n(self): return Param('n', self.__n)
    @n.setter
    def n(self, value):
        if value < 2 or value > 4:
777
            raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
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
805
806
807
808
809
810
811
812
813
814
815
816
817
        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):
818
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
819
820

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

        if len(values[0]) > 2:
            if int(values[0][2]) > 4 or int(values[0][2]) < 2:
825
                raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
826
827
828
829
830
831
832
833
834
            else:
                n = int(values[0][2])
        else:
            n = 2

        values.pop(0) # remove initial value
        
        if n == 2:
            if len(values) != 4:
835
                raise pkex.BasePyKatException("Two port grating must have 2 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
836
837
838
839

            return grating(values[0], values[2], values[3], None, None, n, values[1])
        elif n == 3:
            if len(values) != 5:
840
                raise pkex.BasePyKatException("Three port grating must have 3 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
841
842
843
844
            
            return grating(values[0], values[2], values[3], values[4], None, n, values[1])
        else:
            if len(values) != 6:
845
                raise pkex.BasePyKatException("Four port grating must have 4 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
            
            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):
865
866
867
        if not USE_GUI:
            raise NoGUIException
            
868
869
        if self._svgItem == None:
            self._svgItem = pykat.gui.graphics.SpaceQGraphicsItem(self) # TODO: make SVG graphic for grating
Daniel Brown's avatar
Daniel Brown committed
870
        
871
        return self._svgItem
Daniel Brown's avatar
Daniel Brown committed
872
873

class isolator(Component):
874
    def __init__(self, name, node1, node2, S = 0, node3="dump"):
Daniel Brown's avatar
Daniel Brown committed
875
876
877
878
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
879
        self._requested_node_names.append(node3)
880
        self._svgItem = None
Daniel Brown's avatar
Daniel Brown committed
881
882
883
884
885
886
887
888
889
890
        
        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):
891
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
892
893

        if values[0] != "isol":
894
            raise pkex.BasePyKatException("'{0}' not a valid Finesse isolator command".format(text))
Daniel Brown's avatar
Daniel Brown committed
895
896
897
898
899

        values.pop(0) # remove initial value
        
        if len(values) == 4:
            return isolator(values[0], values[2], values[3], values[1])
900
        elif len(values) == 5:
901
            return isolator(values[0], values[2], values[3], node3=values[4], S=values[1])
Daniel Brown's avatar
Daniel Brown committed
902
        else:
903
            raise pkex.BasePyKatException("Isolator Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
904
905
        
    def getFinesseText(self):
906
        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
907
908
909
910
911
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn
Daniel Brown's avatar
Daniel Brown committed
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
    
    def getOptivisComponent(self):
        self.setOptivisLabelContent()
        
        if self._optivis_component is None:
            self._optivis_component = optivis_components.FaradayIsolator(name=self.name, tooltip=self.getOptivisTooltip, paramList=self.getOptivisParameterDict(), pykatObject=weakref.ref(self))
        
        return self._optivis_component
    
    def getOptivisNode(self, mode, kat_node):
        mode = mode.lower()
        
        if mode != "input" and mode.lower() != "output":
            raise pkex.BasePyKatException("Mode must be either input or output")
        
        if mode == "input":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getInputNode("fr")
            elif kat_node is self.nodes[1]:
                return self._optivis_component.getInputNode("bk")
        elif mode == "output":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getnOutputNode("fr")
            elif kat_node is self.nodes[1]:
                return self._optivis_component.getOutputNode("bk")
     
     
Daniel Brown's avatar
Daniel Brown committed
939
    def getQGraphicsItem(self):
940
941
942
        if not USE_GUI:
            raise NoGUIException
            
943
944
        if self._svgItem == None:
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/isolator.svg", self ,[(-4,15,self.nodes[0]), (14,15,self.nodes[1]), (14,24,self.nodes[2])])
Daniel Brown's avatar
Daniel Brown committed
945
        
946
        return self._svgItem
Daniel Brown's avatar
Daniel Brown committed
947
948

class lens(Component):
949
    def __init__(self, name, node1, node2, f=1):
Daniel Brown's avatar
Daniel Brown committed
950
951
952
953
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
954
        self._svgItem = None
Daniel Brown's avatar
Daniel Brown committed
955
956
957
958
959
960
961
962
963
        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):
964
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
965
966

        if values[0] != "lens":
967
            raise pkex.BasePyKatException("'{0}' not a valid Finesse lens command".format(text))
Daniel Brown's avatar
Daniel Brown committed
968
969
970
971
972
973

        values.pop(0) # remove initial value
        
        if len(values) == 4:
            return lens(values[0], values[2], values[3], values[1])
        else:
974
            raise pkex.BasePyKatException("Lens Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
975
976
977
978
979
980
981
982
        
    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
983
984
    
    def getOptivisComponent(self):
Daniel Brown's avatar
Daniel Brown committed
985
986
        self.setOptivisLabelContent()
        
987
        if self._optivis_component is None:
Daniel Brown's avatar
Daniel Brown committed
988
            self._optivis_component = optivis_components.ConvexLens(name=self.name, tooltip=self.getOptivisTooltip, paramList=self.getOptivisParameterDict(), pykatObject=weakref.ref(self))
Daniel Brown's avatar
Daniel Brown committed
989
        
990
991
992
993
994
995
996
997
998
999
1000
        return self._optivis_component
    
    def getOptivisNode(self, mode, kat_node):
        mode = mode.lower()
        
        if mode != "input" and mode.lower() != "output":
            raise pkex.BasePyKatException("Mode must be either input or output")
        
        if mode == "input":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getInputNode("fr")
For faster browsing, not all history is shown. View entire blame