components.py 52.4 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
8
9
10
11
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals

12
from pykat import USE_GUI, HAS_OPTIVIS, NoGUIException
13
14
15
16
17
18

import pykat.external.six as six

if six.PY2:
	import exceptions

19
import warnings
Daniel Brown's avatar
Daniel Brown committed
20
21
22
23
24
import pykat.exceptions as pkex
import pykat
from pykat.node_network import *
from pykat.exceptions import *
import abc
25
26
27
28
29
30
31
32
33
import copy
from collections import OrderedDict

if HAS_OPTIVIS:
    import optivis.bench.components as optivis_components
    from optivis.view.canvas import OptivisCanvasItemDataType
    from optivis.bench.labels import Label as optivis_label
    from optivis.geometry import Coordinates as optivis_coord
    import PyQt4
Daniel Brown's avatar
Daniel Brown committed
34

Daniel Brown's avatar
Daniel Brown committed
35
36
from pykat.SIfloat import *
from pykat.param import Param, AttrParam
37
import weakref
38
import pykat.exceptions as pkex
39
from copy import deepcopy
40
from pykat.freeze import canFreeze
Daniel Brown's avatar
Daniel Brown committed
41

42
next_component_id = 1
43

44
45
46
47
48
if USE_GUI:
    import pykat.gui.resources
    import pykat.gui.graphics
    from pykat.gui.graphics import *

Daniel Brown's avatar
Daniel Brown committed
49
50
class NodeGaussSetter(object):
    def __init__(self, component, node):                
51
52
        self.__comp = weakref.ref(component)
        self.__node = weakref.ref(node)
Daniel Brown's avatar
Daniel Brown committed
53
54
55
56
57
58
59
60
61
        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
62
63
64
    
    @property
    def node(self):
65
        return self.__node()
Daniel Brown's avatar
Daniel Brown committed
66
67
68
    
    @property
    def q(self):
69
        return self.__node().qx
Daniel Brown's avatar
Daniel Brown committed
70
71
72
        
    @q.setter
    def q(self, value):
73
        self.__node().setGauss(self.__comp(), complex(value))
Daniel Brown's avatar
Daniel Brown committed
74
75
76
        
    @property
    def qx(self):
77
        return self.__node().qx
Daniel Brown's avatar
Daniel Brown committed
78
79
    @qx.setter
    def qx(self, value):
80
        self.__node().setGauss(self.__comp(), complex(value))
Daniel Brown's avatar
Daniel Brown committed
81
82
83
    
    @property
    def qy(self):
84
        return self.__node().qy
Daniel Brown's avatar
Daniel Brown committed
85
86
    @qy.setter
    def qy(self, value):
87
        self.__node().setGauss(self.__comp(), self.qx, complex(value))
Daniel Brown's avatar
Daniel Brown committed
88
        
89
id_____pykat_class = 0
90
91
 
@canFreeze
Daniel Brown's avatar
Daniel Brown committed
92
93
class Component(object):
    __metaclass__ = abc.ABCMeta
94
95
96
97
98

    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
99
100
101
        global id_____pykat_class
        id_____pykat_class += 1
        cnew_name = str("%s.%s_%i" % (cls.__module__, cls.__name__, id_____pykat_class))
102
103
104
        
        cnew = type(cnew_name, (cls,), {})
        
105
106
        o = object.__new__(cnew)
        return o
107
108
        
    def __init__(self, name=None):
109
        self._unfreeze()
110
111
        
        self._optivis_component = None
Daniel Brown's avatar
Daniel Brown committed
112
113
114
115
116
117
        self.__name = name
        self._svgItem = None
        self._requested_node_names = []
        self._kat = None
        self.tag = None
        self._params = []
118
        self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
119
        self._default_fsig_param = None
120
        self.optivisLabelContent = None
Daniel Brown's avatar
Daniel Brown committed
121
122
123
124
        
        # store a unique ID for this component
        global next_component_id
        self.__id = next_component_id
125
        next_component_id += 1    
126
         
127
128
129
130
131
    def __deepcopy__(self, memo):
        """
        When deep copying a kat object we need to take into account
        the instance specific properties.
        """
132
133
134
        # Here we create a copy of this object based of the base class
        # of this one, otherwise we're making a copy of a copy of a copy...
        result = self.__class__.__new__(self.__class__.__base__)
135
        result._unfreeze()
136
        result.__dict__ = copy.deepcopy(self.__dict__, memo)
137
        
138
139
        for _ in result._params:
            _._updateOwner(result)
140
141
    
        result._freeze()
142
143
        return result
        
Daniel Brown's avatar
Daniel Brown committed
144
145
    def _register_param(self, param):
        self._params.append(param)
Daniel Brown's avatar
Daniel Brown committed
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    
    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
161
162
163
164
165
166
167
168
169
170
171
172
173
    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)
174
175
176
177
178
179
     
    def _on_kat_remove(self):
        # 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()
Daniel Brown's avatar
Daniel Brown committed
180
        
181
182
183
184
        del self._params[:]

        self.__removed = True
          
Daniel Brown's avatar
Daniel Brown committed
185
186
187
188
189
190
191
192
193
    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)]
194

Daniel Brown's avatar
Daniel Brown committed
195
196
197
        # now we have a list of which to remove
        for key in key_rm:
            ns = self.__dict__[key]
198
199
200
201
            name = str(ns.node.name)
            
            if '__nodesetter_' + name in self.__dict__:
                delattr(self, '__nodesetter_' + name)
202
            
203
204
205
206
            if name in self.__class__.__dict__:
                delattr(self.__class__, name)
        
        # Now re-add them pointing to the recent nodes
Daniel Brown's avatar
Daniel Brown committed
207
208
209
210
211
212
        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):
213
214
        self._unfreeze()
        
Daniel Brown's avatar
Daniel Brown committed
215
216
217
        if not isinstance(ns, NodeGaussSetter):
            raise exceptions.ValueError("Argument is not of type NodeGaussSetter")
        
218
        name = str(ns.node.name)
Daniel Brown's avatar
Daniel Brown committed
219
        fget = lambda self: self.__get_node_setter(name)
220
            
Daniel Brown's avatar
Daniel Brown committed
221
222
223
        setattr(self.__class__, name, property(fget))
        setattr(self, '__nodesetter_' + name, ns)                   

224
225
        self._freeze()
        
Daniel Brown's avatar
Daniel Brown committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
    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):    
242
243
244
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
245
246
        return None      
    
247
248
249
    @property
    def removed(self): return self.__removed
    
Daniel Brown's avatar
Daniel Brown committed
250
251
252
253
254
255
256
257
258
259
260
    @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
    
261
    def remove(self):
262
263
264
265
        if self.__removed:
            raise pkex.BasePyKatException("{0} has already been marked as removed".format(self.name))
        else:
            self._kat.remove(self)
266
267
268
269
270
271
    
    def getOptivisParameterDict(self):
        if len(self._params) == 0:
            return None
            
        d = OrderedDict()
272
        
273
274
        for p in self._params:
            d[p.name] = OptivisCanvasItemDataType.TEXTBOX
275
        
276
        return d
277
        
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
    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))
        
        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
298
299
class AbstractMirrorComponent(Component):
    __metaclass__ = abc.ABCMeta
300
        
Daniel Brown's avatar
Daniel Brown committed
301
    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
302
        super(AbstractMirrorComponent, self).__init__(name)
303
 
Daniel Brown's avatar
Daniel Brown committed
304
        if (L != None and R != None and T != None) and SIfloat(R)+SIfloat(T)+SIfloat(L) != 1: 
305
            raise pkex.BasePyKatException('L+R+T must equal 1 if all are specified at {0}'.format(self.name))
306
        elif (R != None and L is None and T != None):
Daniel Brown's avatar
Daniel Brown committed
307
            L = 1- (SIfloat(R)+SIfloat(T))
308
        elif (R is None and L != None and T != None):
Daniel Brown's avatar
Daniel Brown committed
309
            R = 1 - (SIfloat(L)+SIfloat(T))
310
        elif (R != None and L != None and T is None):
Daniel Brown's avatar
Daniel Brown committed
311
            T = 1 - (SIfloat(L)+SIfloat(R))
312
        elif (L is None and R is None and T is None):
313
314
            raise pkex.BasePyKatException('Must specify at least two of L, R or T')
        
Daniel Brown's avatar
Daniel Brown committed
315
316
        self.__R = Param("R", self, SIfloat(R))
        self.__T = Param("T", self, SIfloat(T))
317
318
        self.__L = Param("L", self, SIfloat(L))
        
319
        self.__phi = Param("phi", self, SIfloat(phi), canFsig=True, fsig_name="phase")
Daniel Brown's avatar
Daniel Brown committed
320
321
        self.__Rcx = AttrParam("Rcx", self, SIfloat(Rcx))
        self.__Rcy = AttrParam("Rcy", self, SIfloat(Rcy))
322
323
        self.__xbeta = AttrParam("xbeta", self, SIfloat(xbeta), canFsig=True, fsig_name="xbeta")
        self.__ybeta = AttrParam("ybeta", self, SIfloat(ybeta), canFsig=True, fsig_name="ybeta")
Daniel Brown's avatar
Daniel Brown committed
324
        self.__mass = AttrParam("mass", self, SIfloat(mass))
Daniel Brown's avatar
Daniel Brown committed
325
326
        self.__Ix = AttrParam("Ix", self, SIfloat(Ix))
        self.__Iy = AttrParam("Iy", self, SIfloat(Iy))
Daniel Brown's avatar
Daniel Brown committed
327
        self.__r_ap = AttrParam("r_ap", self, SIfloat(r_ap))
328
    
Daniel Brown's avatar
Daniel Brown committed
329
330
331
332
        self.__zmech = AttrParam("zmech", self, zmech)
        self.__rxmech = AttrParam("rxmech", self, rxmech)
        self.__rymech = AttrParam("rymech", self, rymech)
        
333
334
335
336
337
338
        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")
339
        
340
341
342
343
344
        self.__Fs0 = Param("Fs0", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="Fs0")
        self.__Fs1 = Param("Fs1", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="Fs1")
        self.__Fs0 = Param("s0", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="s0")
        self.__Fs1 = Param("s1", self, None, canFsig=True, isPutable=False, isPutter=False, isTunable=False, fsig_name="s1")
            
Daniel Brown's avatar
Daniel Brown committed
345
        self._default_fsig_param = self.__phi
346
347
348
349
350
351
    
    def setRTL(self, R=None, T=None, L=None):
        if R is not None: self.R.value = R
        if T is not None: self.T.value = T
        if L is not None: self.L.value = L
    
352
353
354
355
356
357
358
359
360
361
362
363
364
    @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
    
365
366
367
    @property
    def L(self): return self.__L
    @L.setter
368
    def L(self,value): self.__L.value = SIfloat(value)       
Daniel Brown's avatar
Daniel Brown committed
369
370
371
372
373
374
375
376
377
378
379
        
    @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
380
381
382
383
384
385
386
387
388
389
    @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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
    @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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
    @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
440
441
442
443
444
445
446
447
448
449
450
451
    @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
452
453
454
455
456
457
458
    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
459
        elif key in ["M","m", "Mass", "mass"]:
Daniel Brown's avatar
Daniel Brown committed
460
            self.mass = value
Daniel Brown's avatar
Daniel Brown committed
461
        elif key in ["xbeta", "xBeta"]:
Daniel Brown's avatar
Daniel Brown committed
462
            self.xbeta = value
Daniel Brown's avatar
Daniel Brown committed
463
        elif key in ["ybeta","yBeta"]:
Daniel Brown's avatar
Daniel Brown committed
464
465
466
467
468
469
470
            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
471
472
473
474
        elif key in ["Ix","ix"]:
            self.Ix = value
        elif key in ["Iy","iy"]:
            self.Iy = value
Daniel Brown's avatar
Daniel Brown committed
475
476
477
478
479
480
        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
481
482
483
484
485
        else:
            return False
            
        return True
        
Daniel Brown's avatar
Daniel Brown committed
486
class mirror(AbstractMirrorComponent):
487
    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
488
        super(mirror, self).__init__(name, R, T, L, phi, Rcx, Rcy, xbeta, ybeta, mass, r_ap)
Daniel Brown's avatar
Daniel Brown committed
489
490
491
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
492
493
        self._freeze()
        
Daniel Brown's avatar
Daniel Brown committed
494
495
496
497
498
499
    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
500
501
    @staticmethod
    def parseFinesseText(text):
502
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
503
504

        if values[0] != "m" and values[0] != "m1" and values[0] != "m2":
505
            raise pkex.BasePyKatException("'{0}' not a valid Finesse mirror command".format(text))
Daniel Brown's avatar
Daniel Brown committed
506
507
        
        if len(values) != 7:
508
            raise pkex.BasePyKatException("Mirror Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
509
510
511

        if len(values[0])==1:
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
512
            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
513
514
515
        else:
            if values[0][1]=="1":
                values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
516
                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
517
518
            else:
                values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
519
                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
520

521
    def getFinesseText(self):
522
523
        if abs(self.R + self.T + self.L - 1) > 1e-14:
            raise pkex.BasePyKatException("Mirror {0} has R+T+L = {1}, must equal 1 +- 1e-14".format(self.name, self.R+self.T+self.L))
524
        
Daniel Brown's avatar
Daniel Brown committed
525
526
527
528
529
530
531
532
533
534
        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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
    
    def getOptivisComponent(self):
        self.setOptivisLabelContent()
        
        if self._optivis_component is None:
            self._optivis_component = optivis_components.CavityMirror(name=self.name, aoi=0, tooltip=self.getOptivisTooltip, paramList=self.getOptivisParameterDict(), pykatObject=weakref.ref(self))
            
            lbl = optivis_label(text="", position=optivis_coord(0, -1), item=self._optivis_component)
            lbl.content["Name"] = self.name
            self._optivis_component.labels.append(lbl)
        
        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
566
567
        
    def getQGraphicsItem(self):
568
569
570
        if not USE_GUI:
            raise NoGUIException
            
571
        if self._svgItem is None:
Daniel Brown's avatar
Daniel Brown committed
572
573
574
575
576
            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):
577
578
    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
579
580
581
582
583
        
        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
584
        self.__alpha = Param("alpha", self, SIfloat(alpha))
585
586

        self._freeze()
587
        
Daniel Brown's avatar
Daniel Brown committed
588
589
590
591
592
    @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
593
594
595
596
597
598
599
600
    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))
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
    
    def getOptivisComponent(self):
        self.setOptivisLabelContent()
        
        if self._optivis_component is None:
            self._optivis_component = optivis_components.BeamSplitter(name=self.name, aoi=-self.alpha, 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("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")
            elif kat_node is self.nodes[3]:
                return self._optivis_component.getInputNode("bkA")
        elif mode == "output":
            if kat_node is self.nodes[0]:
                return self._optivis_component.getOutputNode("frB")
            elif kat_node is self.nodes[1]:
                return self._optivis_component.getOutputNode("frA")
            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
635
636
    @staticmethod
    def parseFinesseText(text):
637
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
638
639

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

645
        if len(values[0])==2:
Daniel Brown's avatar
Daniel Brown committed
646
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
647
648
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                values[1], values[2], None, values[3], values[4])
649
650
        elif values[0][2]=="1":
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
651
652
            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
653
        else:
654
            values.pop(0) # remove initial value
Daniel Brown's avatar
Daniel Brown committed
655
656
            return beamSplitter(values[0], values[5], values[6], values[7], values[8],
                                values[1], None, values[2], values[3], values[4])
657
        
Daniel Brown's avatar
Daniel Brown committed
658
    def getFinesseText(self):
659
660
        if abs(self.R + self.T + self.L - 1) > 1e-14:
            raise pkex.BasePyKatException("Beamsplitter {0} has R+T+L = {1}, must equal 1 +- 1e-14".format(self.name, self.R+self.T+self.L))
Daniel Brown's avatar
Daniel Brown committed
661

Daniel Brown's avatar
Daniel Brown committed
662
663
664
        rtn = []
            
        rtn.append('bs {0} {1} {2} {3} {4} {5} {6} {7} {8}'.format(
665
666
                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
667
668
669
670
671
672
673
674
675
                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):
676
677
678
        if not USE_GUI:
            raise NoGUIException
            
679
        if self._svgItem is None:
Daniel Brown's avatar
Daniel Brown committed
680
            # FIXME: make proper SVG component for beam splitter
681
            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
682
683
684
685
            
        return self._svgItem
   
class space(Component):
686
    def __init__(self, name, node1, node2, L = 0, n = 1, g = None, gx = None, gy = None):
Daniel Brown's avatar
Daniel Brown committed
687
688
689
690
691
        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
692
        self.__L = Param("L", self, SIfloat(L), canFsig=True, fsig_name="phase")
Daniel Brown's avatar
Daniel Brown committed
693
        self.__n = Param("n", self, SIfloat(n))
694

695
696
        self.__gx = AttrParam("gx", self, gx)
        self.__gy = AttrParam("gy", self, gy)
Daniel Brown's avatar
Daniel Brown committed
697
        
Daniel Brown's avatar
Daniel Brown committed
698
        self._default_fsig_param = self.__L
699
700

        self._freeze()
Daniel Brown's avatar
Daniel Brown committed
701
        
Daniel Brown's avatar
Daniel Brown committed
702
703
704
    @property
    def L(self): return self.__L
    @L.setter
Andreas Freise's avatar
Andreas Freise committed
705
    def L(self,value): self.__L.value = SIfloat(value)
Daniel Brown's avatar
Daniel Brown committed
706
707
708
709
    @property
    def n(self): return self.__n
    @n.setter
    def n(self,value): self.__n.value = SIfloat(value)
710
711

    @property
Daniel Brown's avatar
Daniel Brown committed
712
713
714
715
716
717
    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")
            
718
    @g.setter
Daniel Brown's avatar
Daniel Brown committed
719
720
721
722
    def g(self,value):
        self.__gx.value = SIfloat(value)
        self.__gy.value = SIfloat(value)
        
723
724
725
726
727
728
729
730
731
    @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
732
    
733
734
735
736
737
738
739
740
741
742
743
744
    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
745
746
747
748
749
750
751
    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]
752
            elif key in ["g","gouy"]:
Daniel Brown's avatar
Daniel Brown committed
753
754
755
756
757
                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
758
759
    @staticmethod
    def parseFinesseText(text):
760
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
761
762

        if values[0] != "s":
763
            raise pkex.BasePyKatException("'{0}' not a valid Finesse space command".format(text))
Daniel Brown's avatar
Daniel Brown committed
764
765
766
767
768
769
770
771

        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:
772
            raise pkex.BasePyKatException("Space Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
        
    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):
788
789
790
        if not USE_GUI:
            raise NoGUIException
            
791
        if self._QItem is None:
Daniel Brown's avatar
Daniel Brown committed
792
793
794
795
796
            self._QItem = pykat.gui.graphics.SpaceQGraphicsItem(self)
        
        return self._QItem

class grating(Component):
797
    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
798
799
800
801
802
803
804
805
806
        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:
807
                raise pkex.BasePyKatException("Grating node 3 not specified")
Daniel Brown's avatar
Daniel Brown committed
808
809
810
811
812

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

        if n > 4 or n < 2:
816
            raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
817
818
819
820
821
822
823
824
825
        
        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))
826
        self._svgItem = None
827
828

        self._freeze()
829
        
Daniel Brown's avatar
Daniel Brown committed
830
831
832
833
834
    @property
    def n(self): return Param('n', self.__n)
    @n.setter
    def n(self, value):
        if value < 2 or value > 4:
835
            raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
        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):
876
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
877
878

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

        if len(values[0]) > 2:
            if int(values[0][2]) > 4 or int(values[0][2]) < 2:
883
                raise pkex.BasePyKatException("Grating must have between 2 and 4 ports")
Daniel Brown's avatar
Daniel Brown committed
884
885
886
887
888
889
890
891
892
            else:
                n = int(values[0][2])
        else:
            n = 2

        values.pop(0) # remove initial value
        
        if n == 2:
            if len(values) != 4:
893
                raise pkex.BasePyKatException("Two port grating must have 2 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
894
895
896
897

            return grating(values[0], values[2], values[3], None, None, n, values[1])
        elif n == 3:
            if len(values) != 5:
898
                raise pkex.BasePyKatException("Three port grating must have 3 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
899
900
901
902
            
            return grating(values[0], values[2], values[3], values[4], None, n, values[1])
        else:
            if len(values) != 6:
903
                raise pkex.BasePyKatException("Four port grating must have 4 nodes defined")
Daniel Brown's avatar
Daniel Brown committed
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
            
            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):
923
924
925
        if not USE_GUI:
            raise NoGUIException
            
926
        if self._svgItem is None:
927
            self._svgItem = pykat.gui.graphics.SpaceQGraphicsItem(self) # TODO: make SVG graphic for grating
Daniel Brown's avatar
Daniel Brown committed
928
        
929
        return self._svgItem
Daniel Brown's avatar
Daniel Brown committed
930
931

class isolator(Component):
932
    def __init__(self, name, node1, node2, S = 0, node3="dump", option = 0, L = 0):
933
934
935
936
937
938
939
940
941
942
943
944
945
946
        """
        Creates an isolator component. Ligth passes from node 1 to node 2, and from node
        2 to node 3. 

        S         Suppression factor for the reversed direction [power dB].
        L         Loss, fraction of input power loss. Number between 0 and 1.
        option    0: Light passes from node1 to node2, and from node2 to node3. Light
                     is suppressed when going from node3 to node2, and from node2 to
                     node1.
                  1: Light passes from node2 to node1, and from node3 to node2. Light
                     is suppressed when going from node1 to node2, and from node2 to
                     node3. 
        """
        
Daniel Brown's avatar
Daniel Brown committed
947
948
949
950
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
951
        self._requested_node_names.append(node3)
952
        self._svgItem = None
953
        self._option = option
Daniel Brown's avatar
Daniel Brown committed
954
955
        
        self.__S = Param("S",self,SIfloat(S))
956
957
        self.__L = Param("L",self,SIfloat(L))

958
        self._freeze()
Daniel Brown's avatar
Daniel Brown committed
959
960
961
962
963
        
    @property
    def S(self): return self.__S
    @S.setter
    def S(self, value): self.__S.value = SIfloat(value)
964
965
966
967
968

    @property
    def L(self): return self.__L
    @L.setter
    def L(self, value): self.__L.value = SIfloat(value)
Daniel Brown's avatar
Daniel Brown committed
969
970
971
    
    @staticmethod
    def parseFinesseText(text):
972
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
973

974
        if values[0] != "isol" and values[0] != "isol*":
975
            raise pkex.BasePyKatException("'{0}' not a valid Finesse isolator command".format(text))
Daniel Brown's avatar
Daniel Brown committed
976

977
978
979
980
981
        if values[0].endswith('*'):
            option = 1
        else:
            option = 0
            
Daniel Brown's avatar
Daniel Brown committed
982
983
984
        values.pop(0) # remove initial value
        
        if len(values) == 4:
985
            return isolator(values[0], values[2], values[3], values[1], option=option)
986
        elif len(values) == 5:
987
            # Checking if loss is specified, should be a number.
988
989
990
            if values[2].isnumeric():
                return isolator(values[0], values[3], values[4], values[1],
                                L=values[2], option=option)
991
            # .. if not a number, it's a node name.
992
993
994
995
996
            else:
                return isolator(values[0], values[2], values[3], node3=values[4],
                                S=values[1], option=option)
        elif len(values) == 6:
             return isolator(values[0], values[3], values[4], values[1], values[5], option, values[2])
Daniel Brown's avatar
Daniel Brown committed
997
        else:
998
            raise pkex.BasePyKatException("Isolator Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
999
1000
        
    def getFinesseText(self):
1001
1002
1003
1004
1005
        if self._option == 0:
            cmd = "isol"
        elif self._option == 1:
            cmd = "isol*"
            
1006
        rtn = ['{cmd} {0} {1} {2} {3} {4} {5}'.format(self.name, self.S.value, self.L.value, self.nodes[0].name, self.nodes[1].name, self.nodes[2].name, cmd=cmd)]
Daniel Brown's avatar
Daniel Brown committed
1007
1008
1009
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
1010

Daniel Brown's avatar
Daniel Brown committed
1011
        return rtn
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
    
    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
1039
    def getQGraphicsItem(self):
1040
1041
1042
        if not USE_GUI:
            raise NoGUIException
            
1043
        if self._svgItem is None:
1044
            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
1045
        
1046
        return self._svgItem
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
        
        
        
class isolator1(Component):
    def __init__(self, name, node1, node2, node3, node4):
        """
        Creates a 4-port isolator component.
        """
        
        Component.__init__(self, name)
        
        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._svgItem = None

1064
1065
        self._freeze()
        
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
    @staticmethod
    def parseFinesseText(text):
        values = text.split()

        if values[0] != "isol1":
            raise pkex.BasePyKatException("'{0}' not a valid Finesse isolator command".format(text))
            
        values.pop(0) # remove initial value
        
        if len(values) == 5:
             return isolator1(values[0], values[1], values[2], values[3], values[4])
        else:
            raise pkex.BasePyKatException("Isolator1 Finesse code format incorrect '{0}'".format(text))
        
    def getFinesseText(self):
        rtn = ['isol1 {0} {1} {2} {3} {4}'.format(self.name, 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
        
1090
1091
    def getQGraphicsItem(self):
        raise NotImplemented()    
1092
        
Daniel Brown's avatar
Daniel Brown committed
1093
1094

class lens(Component):
Daniel Brown's avatar
Daniel Brown committed
1095
    def __init__(self, name, node1, node2, f=1, p=None):
Daniel Brown's avatar
Daniel Brown committed
1096
1097
        Component.__init__(self, name)
        
Daniel Brown's avatar
Daniel Brown committed
1098
1099
1100
        if not ((f is None) ^ (p is None)):
            raise pkex.BasePyKatException("Specify either a focal length or power, not both.")
        
Daniel Brown's avatar
Daniel Brown committed
1101
1102
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
1103
        self._svgItem = None
Daniel Brown's avatar
Daniel Brown committed
1104
        self.__f = Param("f", self, SIfloat(f))
Daniel Brown's avatar
Daniel Brown committed
1105
        self.__p = Param("p", self, SIfloat(p))
1106
1107

        self._freeze()
Daniel Brown's avatar
Daniel Brown committed
1108
1109
1110
        
    @property
    def f(self): return self.__f
Daniel Brown's avatar
Daniel Brown committed
1111
            
Daniel Brown's avatar
Daniel Brown committed
1112
    @f.setter
Daniel Brown's avatar
Daniel Brown committed
1113
1114
1115
1116
1117
    def f(self, value):
        self.__f.value = SIfloat(value)
        self.__p.value = None
    
    @property
Daniel Brown's avatar
Daniel Brown committed
1118
    def p(self): return self.__p
Daniel Brown's avatar
Daniel Brown committed
1119
            
Daniel Brown's avatar
Daniel Brown committed
1120
    @p.setter
Daniel Brown's avatar
Daniel Brown committed
1121
1122
1123
    def p(self, value):
        self.__p.value = SIfloat(value)
        self.__f.value = None
Daniel Brown's avatar
Daniel Brown committed
1124
1125
1126
    
    @staticmethod
    def parseFinesseText(text):
1127
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
1128

Daniel Brown's avatar
Daniel Brown committed
1129
        if not values[0].startswith("lens"):
1130
            raise pkex.BasePyKatException("'{0}' not a valid Finesse lens command".format(text))
Daniel Brown's avatar
Daniel Brown committed
1131

Daniel Brown's avatar
Daniel Brown committed
1132
1133
        alt = values[0].endswith("*")
        
Daniel Brown's avatar
Daniel Brown committed
1134
1135
1136
        values.pop(0) # remove initial value
        
        if len(values) == 4:
Daniel Brown's avatar
Daniel Brown committed
1137
1138
1139
1140
            if not alt:
                return lens(values[0], values[2], values[3], f=values[1], p=None)
            else:
                return lens(values[0], values[2], values[3], f=None, p=values[1])
Daniel Brown's avatar
Daniel Brown committed
1141
        else:
1142
            raise pkex.BasePyKatException("Lens Finesse code format incorrect '{0}'".format(text))
Daniel Brown's avatar
Daniel Brown committed
1143
1144
        
    def getFinesseText(self):
Daniel Brown's avatar
Daniel Brown committed
1145
        if self.__p.value is None:
Daniel Brown's avatar
Daniel Brown committed
1146
1147
1148
            rtn = ['lens {0} {1} {2} {3}'.format(self.name, self.f.value, self.nodes[0].name, self.nodes[1].name)]
        else:
            rtn = ['lens* {0} {1} {2} {3}'.format(self.name, self.p.value, self.nodes[0].name, self.nodes[1].name)]
Daniel Brown's avatar
Daniel Brown committed
1149
1150
1151
1152
1153
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
            
        return rtn
1154
1155
1156
1157
1158
1159
    
    def getOptivisComponent(self):
        self.setOptivisLabelContent()
        
        if self._optivis_component is None:
            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
1160
        
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
        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
1180
    def getQGraphicsItem(self):
1181
1182
1183
        if not USE_GUI:
            raise NoGUIException
            
1184
        if self._svgItem is None:
1185
            self._svgItem = pykat.gui.graphics.ComponentQGraphicsItem(":/resources/lens.svg", self ,[(-4,15,self.nodes[0]), (14,15,self.nodes[1])])
Daniel Brown's avatar
Daniel Brown committed
1186
        
1187
        return self._svgItem
Daniel Brown's avatar
Daniel Brown committed
1188
1189
        
class modulator(Component):
1190
    def __init__(self, name, node1, node2, f, midx, order, modulation_type='pm', phase=0):
Daniel Brown's avatar
Daniel Brown committed
1191
1192
1193
1194
        Component.__init__(self, name)
        
        self._requested_node_names.append(node1)
        self._requested_node_names.append(node2)
1195
        self._svgItem = None
1196
        self.__f = Param("f", self, SIfloat(f), canFsig=True, fsig_name="fre")
Daniel Brown's avatar
Daniel Brown committed
1197
        self.__midx = Param("midx", self, SIfloat(midx))
Daniel Brown's avatar
Daniel Brown committed
1198
        self.__phase = Param("phase", self, SIfloat(phase), canFsig=True, fsig_name="phase")
1199
1200
        self.__order = 0
        self.order = order
Daniel Brown's avatar
Daniel Brown committed
1201
1202
        self.type = modulation_type