node_network.py 22 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 10:02:41 2013

@author: Daniel
"""
7
8
9
10
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
11

Daniel Brown's avatar
Daniel Brown committed
12
13
14
15
16
from pykat import USE_GUI, NoGUIException

if USE_GUI:
    import pykat.gui.graphics
    
Daniel Brown's avatar
Daniel Brown committed
17
import pykat.exceptions as pkex
18
import pykat.external.six as six
Daniel Brown's avatar
Daniel Brown committed
19

20
from pykat.components import Component, NodeGaussSetter
21
from pykat.detectors import BaseDetector as Detector
22
from pykat.optics.gaussian_beams import beam_param
23
from copy import deepcopy
Daniel Brown's avatar
Daniel Brown committed
24
25

class NodeNetwork(object):
26
27
28
29
30
31
32

    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)

Daniel Brown's avatar
Daniel Brown committed
33
34
35
36
37
38
39
    def __init__(self, kat):
        self.__nodes = {}
        self.__kat = kat
        self.__nodeComponents = {} # dictionary of tuples containing which components are connected to a node
        self.__componentNodes = {} # dictionary of tuples containing which nodes are connected to a given component
        self.__componentCallback = {}
        self.__node_id = 1
40
            
41
42
    @property
    def kat(self): return self.__kat
Daniel Brown's avatar
Daniel Brown committed
43
44
45
46
47
48
49
50
51
        
    def registerComponentNodes(self, comp, node_names, change_callback):
        """
        For a given component we create some nodes or get existing ones and 
        attach them to this component. Also specify a callback function that
        is called whenever the nodes attached to this component are changed
        , e.g. connected, disconnected, name change, etc.
        """
        if not isinstance(comp, Component):
52
            raise pkex.BasePyKatException("comp argument is not of type Component")
Daniel Brown's avatar
Daniel Brown committed
53
54
55
56
57
58
59
60
        
        if comp.id in self.__componentNodes:
            raise pkex.BasePyKatException("Component has already been registered")
        
        list = []
        
        for name in node_names:
            n = self.createNode(name)
61
            self.__connectNodeToComp(n, comp, do_callback=False)
Daniel Brown's avatar
Daniel Brown committed
62
63
64
65
66
67
68
69
            list.append(n)
        
        self.__componentNodes[comp.id] = tuple(list)
        self.__componentCallback[comp.id] = change_callback
        
        change_callback()
    
    def replaceNode(self, comp, node_old, node_new):
70
71
72
73
74
75
76
77
        """
        For a particular pykat component this will replace a node that is currently
        connected to it with another. This can be used to dynamically change layouts
        once components have been read into the pykat.finesse.kat object.
        
        node_old is the node that is attached to the component. This will accept
             str - name of a node
             pykat.node_network.Node - The direct node object
78
             NodeGaussSetter - the node object that is used to set gaussian parameters
79
80
81
82
             
        This will call a components __on_node_change callback function to let it know that the nodes
        connected to it have changed.
        """
Daniel Brown's avatar
Daniel Brown committed
83
        
84
        if isinstance(node_old, six.string_types):
85
86
            node_old = self.__kat.nodes[node_old]
        
87
        if isinstance(node_new, six.string_types):
88
89
            node_new = self.__kat.nodes[node_new]
            
90
        if isinstance(node_old, NodeGaussSetter):
91
92
            node_old = node_old.node
        
93
        if isinstance(node_new, NodeGaussSetter):
94
95
96
            node_new = node_new.node
            
        if not node_new.isDump and node_new.components.count(None) == 0:
Daniel Brown's avatar
Daniel Brown committed
97
98
99
100
101
            raise pkex.BasePyKatException("New node already connected to two components")
            
        if comp not in node_old.components:
            raise pkex.BasePyKatException("Old node not attached to component")
        
102
        if not node_new.isDump and comp in node_new.components:
Daniel Brown's avatar
Daniel Brown committed
103
104
105
106
107
108
            raise pkex.BasePyKatException("New node already attached to component")
        
        # add component to new node component list
        new_node_comps = list(node_new.components)
        new_node_comps[new_node_comps.index(None)] = comp
        self.__nodeComponents[node_new.id] = tuple(new_node_comps)
109
        del new_node_comps
Daniel Brown's avatar
Daniel Brown committed
110
111
112
113
114
        
        # remove component from old node list
        old_node_comps = list(node_old.components)
        old_node_comps[old_node_comps.index(comp)] = None
        self.__nodeComponents[node_old.id] = tuple(old_node_comps)
115
        del old_node_comps
Daniel Brown's avatar
Daniel Brown committed
116
117
118
119
        
        comp_nodes = list(comp.nodes)
        comp_nodes[comp_nodes.index(node_old)] = node_new
        self.__componentNodes[comp.id] = tuple(comp_nodes)
120
        del comp_nodes
Daniel Brown's avatar
Daniel Brown committed
121
122
123
124
        
        # if old node is no longer connected to anything then delete it
        if node_old.components.count(None) == 2:
            self.removeNode(node_old)
125
126
127
        
        # Call component callback to let it know that we have changed the 
        # nodes attached to it
Daniel Brown's avatar
Daniel Brown committed
128
129
        self.__componentCallback[comp.id]()
            
130
131
132
133
    def __connectNodeToComp(self, node, comp, do_callback=True):
        """
        This is an internal function used to create connections between nodes
        """
Daniel Brown's avatar
Daniel Brown committed
134
135
136
137
138
139
        if node.id in self.__nodeComponents:
            comps = self.__nodeComponents[node.id]
        else:
            comps = (None,) * 2
        
        if len(comps) >= 2 and comps[0] != None and comps[1] != None:
140
            raise pkex.BasePyKatException("Node '{0}' is already connected to 2 components ({1}, {2})".format(node.name, comps[0], comps[1]))
Daniel Brown's avatar
Daniel Brown committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
        
        l = list(comps)
        
        if l[0] == None:
            l[0] = comp
        elif l[1] == None:
            l[1] = comp
        else:
            raise pkex.BasePyKatException("Connected to two coponents already")
        
        self.__nodeComponents[node.id] = tuple(l)
        
        if do_callback: self.__componentCallback[comp.id]()
        
    def createNode(self, node_name):
156
157
158
159
160
161
162
163
164
        """
        This creates a new node object. It won't be connected to anything or added to a
        pykat.finesse.kat object until it is specifically attached to a particular 
        component. This should be used in conjunction with kat.nodes.replaceNode to 
        add a new node into a system, as every component will already have the nodes
        setup, including dump nodes.
        
        This will return a dump node if the name of the node is "dump" (case senstive)
        """
Daniel Brown's avatar
Daniel Brown committed
165
            
166
        if node_name != 'dump' and node_name in self.__nodes:
Daniel Brown's avatar
Daniel Brown committed
167
168
169
            # then this node already exists
            return self.__nodes[node_name]
        else:
170
171
172
173
            if node_name == 'dump':
                n = DumpNode(self)
            else:
                n = Node(node_name, self, self.__node_id)
Daniel Brown's avatar
Daniel Brown committed
174
175
176
            
            self.__node_id += 1
            self.__nodeComponents[n.id] = (None, None)
177
178
179
180
181
182
            
            if not n.isDump:
                self.__add_node_attr(n) # add node as a member of this object, e.g. kat.nodes.n
                self.__nodes[node_name] = n
                
            
Daniel Brown's avatar
Daniel Brown committed
183
            return n
184
    
185
186
187
188
189
190
    def _removeComponent(self, comp):
        """
        This is an internal function that shouldn't be used directly. This removes
        a particular component from the node network. For this to work it has to be 
        detached from all other connections first.
        """
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
        C = self.__componentNodes[comp.id]
        
        for n in C:
           if comp in self.__nodeComponents[n.id]:
               l = list(self.__nodeComponents[n.id])
               l[l.index(comp)] = None
               self.__nodeComponents[n.id] = tuple(l)
               
               if l.count(None) == 2:
                   self.removeNode(n) 
               
               del l
               
        del self.__componentCallback[comp.id]
        del self.__componentNodes[comp.id]
Daniel Brown's avatar
Daniel Brown committed
206
207
        
    def removeNode(self, node):
208
209
210
211
212
213
214
215
216
        """
        This will remove a particular node object from the network. The node in question
        must be fully detached from all components and connections first. This function is 
        called by replaceNode directly so a replaced node, that is no longer connected to 
        anything, is removed automatically.
        
        node_old is the node that is attached to the component. This will accept
             str - name of a node
             pykat.node_network.Node - The direct node object
217
             NodeGaussSetter - the node object that is used to set gaussian parameters
218
219
              
        """
220
        
221
        if isinstance(node, six.string_types):
222
223
            node = self.__kat.nodes[node]
            
224
        if isinstance(node, NodeGaussSetter):
225
226
            node = node.node
            
227
228
        if not isinstance(node, Node):
            raise pkex.BasePyKatException("node argument is not of type Node")
Daniel Brown's avatar
Daniel Brown committed
229
        
230
231
        if not isinstance(node, DumpNode) and node.name not in self.__nodes:
            raise pkex.BasePyKatException("Trying to remove node {0} when it has not been added".format(node.name))
Daniel Brown's avatar
Daniel Brown committed
232
233
234
235
        
        C = self.getNodeComponents(node)
        
        if C[0] is not None or C[1] is not None:
236
            raise pkex.BasePyKatException("Cannot remove a node which is attached to components still")
Daniel Brown's avatar
Daniel Brown committed
237
238
            
        if len(node.getDetectors()) > 0:
239
            raise pkex.BasePyKatException("Cannot remove a node which is attached to detectors still")
Daniel Brown's avatar
Daniel Brown committed
240
        
241
242
243
        if not isinstance(node, DumpNode):
            self.__remove_node_attr(node)
            del self.__nodes[node.name] 
244
245
            
        del self.__nodeComponents[node.id]
Daniel Brown's avatar
Daniel Brown committed
246
247
        
    def hasNode(self, name):
248
        ""
Daniel Brown's avatar
Daniel Brown committed
249
250
251
        return (name in self.__nodes)
    
    def getNodes(self):
252
253
254
255
        """
        Returns a copy of the node dictionary, this is for infomration purposes any edits won't make
        any changes to the node network.
        """
Daniel Brown's avatar
Daniel Brown committed
256
257
258
        return self.__nodes.copy()
    
    def getComponentNodes(self, comp):
259
260
261
262
        """
        This function returns a tuple of the nodes connected to the component specified.
        For information only, you cannot edit the connections using this function.
        """
Daniel Brown's avatar
Daniel Brown committed
263
264
265
        return self.__componentNodes[comp.id]
    
    def getNodeComponents(self, node):
266
267
268
269
        """
        This function returns a tuple of the components connected to the node specified.
        For information only, you cannot edit the connections using this function.
        """
Daniel Brown's avatar
Daniel Brown committed
270
271
272
273
274
        return self.__nodeComponents[node.id]
    
    def __add_node_attr(self, node):

        if not isinstance(node, Node):
275
            raise pkex.BasePyKatException("Argument is not of type Node")
Daniel Brown's avatar
Daniel Brown committed
276
277
278
279
280
281
282
283
284
        
        name = node.name
        fget = lambda self: self.__get_node_attr(name)
        
        setattr(self.__class__, name, property(fget))
        setattr(self, '__node_' + name, node)                   
    
    def __remove_node_attr(self, node):
        if not isinstance(node, Node):
285
            kat.nodes.replaceNode(kat.bs1, "n1", kat.nodes.createNode("test1"))
Daniel Brown's avatar
Daniel Brown committed
286
287
288
289
290
291
292
293
294
        
        name = node.name
        delattr(self, '__node_' + name)
        delattr(self.__class__, name)
        
    def __get_node_attr(self, name):
        return getattr(self, '__node_' + name)        
        
    def __getitem__(self, value):
295
296
297
298
        if str(value) in self.__nodes:
            return self.__nodes[str(value)]
        else:
            raise pkex.BasePyKatException("The node '%s' could not be found in the network." % str(value))
Daniel Brown's avatar
Daniel Brown committed
299
300
301
        
    def __contains__(self, value):
        return value in self.__nodes
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
    
    def __nodeSearch(self, fnode, currcomp, branches, tnode):
        
        if fnode == tnode:
            branches[-1][0] = True
            branches[-1][1] = True
            return True # Hurrah, we have found a path to the node
        elif fnode.isDump:
            branches[-1][0] = True
            return False # if the current node is a dump, we need to check another branch

        nextnode = None
        
        if isinstance(currcomp, pykat.components.beamSplitter):
            # if we get to a beamsplitter then we need to 
            # create new branches to search: the rfelected
            # and transmitted
            
            # set this branch as searched
            branches[-1][0] = True
            # add two new ones
            
            if fnode == currcomp.nodes[0]:
                rn = currcomp.nodes[1]
                tn = currcomp.nodes[2]
            elif fnode == currcomp.nodes[1]:
                rn = currcomp.nodes[0]
                tn = currcomp.nodes[3]
            elif fnode == currcomp.nodes[2]:
                rn = currcomp.nodes[3]
                tn = currcomp.nodes[0]
            elif fnode == currcomp.nodes[3]:
                rn = currcomp.nodes[2]
                tn = currcomp.nodes[1]
            else:
337
                raise pkex.BasePyKatException("Node not attached in path find to BS")
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
            
            nextcomp = None
            
            if tn.components[0] == currcomp:
                nextcomp = tn.components[1]
            elif tn.components[1] == currcomp:
                nextcomp = tn.components[0]
            
            if nextcomp != None:
                branches.append([False, False, tn, nextcomp, []])
            
            if rn.components[0] == currcomp:
                nextcomp = rn.components[1]
            elif rn.components[1] == currcomp:
                nextcomp = rn.components[0]
            
            if nextcomp != None:
                branches.append([False, False, rn, nextcomp, []])
            
            branches[-1][-1].append(currcomp)
            
            return False
            
        elif isinstance(currcomp, pykat.components.isolator):
362
            print ("isol")
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
        elif isinstance(currcomp, pykat.components.laser):
            # if we are at a laser then we can't go any further
            # and it isn;t this node as we checked before
            branches[-1][0] = True
            return False
        elif len(currcomp.nodes) == 2:
            if currcomp.nodes[0] == fnode:
                nextnode = currcomp.nodes[1]
            elif currcomp.nodes[1] == fnode:
                nextnode = currcomp.nodes[0]
            else:
                raise pkex.BasePyKatException("Unexpeceted condition")
        else:
            raise pkex.BasePyKatException("Did not handle component {0} correctly, has more or less than 2 nodes.".format(currcomp))
        
        if nextnode == None:
            branches[-1][0] = True
            return False
        elif nextnode == tnode:
            branches[-1][0] = True
            branches[-1][1] = True
            branches[-1][-1].append(currcomp)
            return True
        else:
            # Now we have the next node, we need the next component
            if nextnode.components[0] == currcomp:
                nextcomp = nextnode.components[1]
            elif nextnode.components[1] == currcomp:
                nextcomp = nextnode.components[0]
            else:
                raise pkex.BasePyKatException("Unexpeceted condition")

            if nextcomp == None:
                branches[-1][0] = True
                return False
            
            branches[-1][-1].append(currcomp)
            
            return self.__nodeSearch(nextnode, nextcomp, branches, tnode)
            
    def getComponentsBetween(self, from_node, to_node):
404
405
406
407
408
        """
        This function will trace the path between the two nodes specified and return a list
        of the components it finds between them.
        """
        
409
        if isinstance(from_node, six.string_types):
410
411
            from_node = self.__kat.nodes[from_node]
            
412
        if isinstance(from_node, NodeGaussSetter):
413
414
            from_node = from_node.node
            
415
        if isinstance(to_node, six.string_types):
416
417
            to_node = self.__kat.nodes[to_node]
            
418
        if isinstance(to_node, NodeGaussSetter):
419
420
421
422
423
            to_node = to_node.node
            
        if to_node == from_node:
            return []
        
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
        if from_node not in self.__nodes:
            raise pkex.BasePyKatException("Node {0} cannot be found in this kat object".format(from_node))

        if to_node not in self.__nodes:
            raise pkex.BasePyKatException("Node {0} cannot be found in this kat object".format(to_node))
        
        branches = []
        
        fn = self.__nodes[from_node]
        tn = self.__nodes[to_node]
        
        branches.append([False, False, fn, fn.components[1], []])
        branches.append([False, False, fn, fn.components[0], []])
        
        while len(branches) > 0 and branches[-1][1] != True:
            while branches[-1][0] == False:
                branch = branches[-1]
            
                if not self.__nodeSearch(branch[2], branch[3], branches, tn):
                    if len(branches) > 0 and branches[-1][0] != False:
                        branches.pop()
            
            if branches[-1][1] != True:
                while len(branches) > 0 and branches[-1][0] == True:
                    branches.pop()
            
            
        comps = []
        
        if len(branches) > 0  and branches[-1][0] == True and branches[-1][1] == True:
            # select the branches that form the path from node to node
            br = [b for b in branches if b[0] == True]
Daniel Brown's avatar
Daniel Brown committed
456
        
457
458
459
460
461
            for b in br:
                comps.extend(b[-1])
        
        return comps
    
Daniel Brown's avatar
Daniel Brown committed
462
463
464
465
466
467
468
469
470
471
472
473
    
class Node(object):

    def __init__(self, name, network, id):
        self._detectors = []
        self.__name = name
        self._item = None
        self._network = network
        self.__q_x = None
        self.__q_y = None
        self.__q_comp = None
        self.__id = id
474
475
        self._isDump = False
        
Daniel Brown's avatar
Daniel Brown committed
476
    def __str__(self): return self.__name
477
478
479
480

    @property
    def isDump(self): return self._isDump
        
Daniel Brown's avatar
Daniel Brown committed
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
    @property
    def id(self): return self.__id
    
    @property
    def network(self): return self._network
    
    @property
    def components(self): return self._network.getNodeComponents(self)
    
    @property
    def q(self):
        if self.__q_x == self.__q_y:
            return self.__q_x
        else:
            return (self.__q_x, self.__q_y)
            
    @property
    def qx(self): return self.__q_x
    @property
    def qy(self): return self.__q_y
    
502
    def removeGauss(self):
Daniel Brown's avatar
Daniel Brown committed
503
504
505
506
507
508
509
        self.__q_x = None
        self.__q_y = None
        self.__q_comp = None
    
    def setGauss(self, component, *args):
        self.__q_comp = component
        
510
        if len(args) == 1:  
511
512
            self.__q_x = beam_param(self._network.kat.lambda0, q=args[0])
            self.__q_y = beam_param(self._network.kat.lambda0, q=args[0])
Daniel Brown's avatar
Daniel Brown committed
513
        elif len(args) == 2:
514
515
            self.__q_x = beam_param(self._network.kat.lambda0, q=args[0])
            self.__q_y = beam_param(self._network.kat.lambda0, q=args[1])
Daniel Brown's avatar
Daniel Brown committed
516
517
        else:
            raise pkex.BasePyKatException("Must specify either 1 Gaussian beam parameter or 2 for astigmatic beams")
518
                
Daniel Brown's avatar
Daniel Brown committed
519
520
521
522
523
    def getFinesseText(self):    
        if self.__q_x is None or self.__q_y is None or self.__q_comp is None:
            return []
            
        rtn = []
Daniel Brown's avatar
Daniel Brown committed
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
        
        # to get the name of the gauss parameter is a bit convoluted...
        # firstly the name is set in the NodeGaussSetter object which is
        # connected to each component, so this has to be retrieved and 
        # then applied.
        if hasattr(self.__q_comp, self.name):
            ns = getattr(self.__q_comp, self.name)
            
            # if no name is present give it a default one
            if ns.name != None:
                name = ns.name
            else:
                name = "g_%s" % self.name
        else:
            raise pkex.BasePyKatException("Node {0} is not connected to {1}".format(self.name, self.__q_comp.name))
        
        
Daniel Brown's avatar
Daniel Brown committed
541
        if self.__q_x == self.__q_y:
Daniel Brown's avatar
Daniel Brown committed
542
            rtn.append("gauss {name} {comp} {node} {w0:.15g} {z:.15g}".format(name=name, node=self.name, comp=self.__q_comp.name, w0=self.__q_x.w0, z=self.__q_x.z))
Daniel Brown's avatar
Daniel Brown committed
543
        else:
Daniel Brown's avatar
Daniel Brown committed
544
            rtn.append("gauss {name} {comp} {node} {w0x:.15g} {zx:.15g} {w0y:.15g} {zy:.15g}".format(name=name, node=self.name, comp=self.__q_comp.name, w0x=self.__q_x.w0, zx=self.__q_x.z, w0y=self.__q_y.w0, zy=self.__q_y.z))
Daniel Brown's avatar
Daniel Brown committed
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
            
        return rtn
        
    def isConnected(self):
        if (self.components[0] is not None) and (self.components[1] is not None):
            return True
        else:
            return False
      
    def remove(self):
        self._network.removeNode(self)
        
        if self._item != None:
            self._item.scene().removeItem(self._item)
    
    def getQGraphicsItem(self,dx=0,dy=0,nsize=8,parent=None):
Daniel Brown's avatar
Daniel Brown committed
561
562
563
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
        if self._item == None:
            self._item = pykat.gui.graphics.NodeQGraphicItem(self,
                                                             dx,dy,
                                                             -nsize/2,-nsize/2,
                                                             nsize, nsize, parent)
            
        return self._item
    
    def getDetectors(self):
        return self._detectors[:]
        
    def amIConnected(self, obj):
        """
        Checks if obj is connected to the node. Returns true or false in tuple
        with None or the other object and the node index which it is attached to
        """ 
        comps = self.components
        
        if obj == comps[0]:
            if comps[1] == None:
                ix = -1
            else:
                ix = comps[1].nodes.index(self)
                
            return [True, comps[1], ix]
            
        elif obj == comps[1]:
            if comps[0] == None:
                ix = -1
            else:
                ix = comps[0].nodes.index(self)
                
            return [True, comps[0], ix]
        else:
            return [False, None]
        
    @property
    def name(self): return self.__name      
602
603
        
        
Daniel Brown's avatar
Daniel Brown committed
604
class DumpNode(Node):
605
606
    __total_dump_node_id = 0
    
607
    def __init__(self, network):
608
        DumpNode.__total_dump_node_id -= 1
609
        Node.__init__(self, 'dump', network, DumpNode.__total_dump_node_id)
610
        self._isDump = True
Daniel Brown's avatar
Daniel Brown committed
611
        
612