finesse.py 26.6 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 09:56:53 2013

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
PyKat - Python interface and wrapper for FINESSE
Copyright (C) 2013 Daniel David Brown

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact at ddb@star.sr.bham.ac.uk

@author: Daniel Brown
Daniel Brown's avatar
Daniel Brown committed
25
"""
26
import sys
Daniel Brown's avatar
Daniel Brown committed
27
28
29
30
import os
import subprocess
import tempfile
import numpy as np
31
32
import datetime
import pickle
33
import pykat
34
import warnings
35
import re
Daniel Brown's avatar
Daniel Brown committed
36
37
38
39

from pykat.node_network import NodeNetwork
from pykat.detectors import Detector
from pykat.components import Component
40
from pykat.commands import Command, xaxis
Daniel Brown's avatar
Daniel Brown committed
41
42
from pykat.gui.gui import pyKatGUI

43
44
import pykat.exceptions as pkex

45
46
47
from PyQt4.QtCore import QCoreApplication
from PyQt4.QtGui import QApplication

Daniel Brown's avatar
Daniel Brown committed
48
NO_GUI = False
49
50
NO_BLOCK = "NO_BLOCK"

51
class katRun(object):
Daniel Brown's avatar
Daniel Brown committed
52
    def __init__(self):
53
54
55
56
57
58
59
60
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
        
61
    def saveKatRun(self, filename):
62
        with open(filename,'w') as outfile:
63
            pickle.dump(self, outfile)
Daniel Brown's avatar
Daniel Brown committed
64
    
65
66
67
68
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
69
70
71
72
73
74
75
76
77
78
79
    
    def get(self, value): return self[value]
    
    def __getitem__(self, value):
        if value in self.ylabels:
            idx = self.ylabels.index(value)
            if len(self.y.shape) == 1:
                return self.y
            else:
                return self.y[:, idx]
        else:
80
            raise  pkex.BasePyKatException("No output by the name {0} found".format(value))
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
      
class katRun2D(object):
    def __init__(self):
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
        
    def saveKatRun(self, filename):
        with open(filename,'w') as outfile:
            pickle.dump(self, outfile)
    
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
    
    def get(self, value): return self[value]
    
    def __getitem__(self, value):
106
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split(" ")[0] == str(value)]
107
108
        
        if len(idx) > 0:
109
            return self.z[idx].squeeze()
110
        else:
111
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
112
      
113
114
115
class Block:
    def __init__(self, name):
        self.__name = name
116
        self.contents = [] # List of objects and strings of finesse code
117
118
119
120
121
        self.enabled = True 
        
    @property
    def name(self): return self.__name
    
122
123
class kat(object):                    
        
124
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
125
        
126
        self.scene = None # scene object for GUI
Andreas Freise's avatar
Andreas Freise committed
127
        self.verbose = True
128
        self.__blocks = {} # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
129
130
131
132
        self.__components = {}  # dictionary of optical components      
        self.__detectors = {}   # dictionary of detectors
        self.__commands = {}    # dictionary of commands
        self.__extra_lines = [] # an array of strings which are just normal finesse code to include when running
Daniel Brown's avatar
Daniel Brown committed
133
134
        self.__gui = None
        self.nodes = NodeNetwork(self)  
135
136
        self.__katdir = katdir
        self.__katname = katname
137
138
        self.__tempdir = tempdir
        self.__tempname = tempname
Daniel Brown's avatar
Daniel Brown committed
139
        self.pykatgui = None
140
141
142
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
143
144
145
        self.__phase = None
        self.__maxtem = None
        self.__noxaxis = None
146
        self.__time_code = None
Daniel Brown's avatar
Daniel Brown committed
147
        
148
        if kat_code != None and kat_file != None:
149
            raise BasePyKatException("Specify either a Kat file or some Kat code, not both.")
150
151
152
153
154
155
        
        if kat_code != None:
            self.parseCommands(kat_code)
        
        if kat_file != None:
            self.loadKatFile(kat_file)
156
157
158
159
        
        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
        
160
161
162
163
164
165
166
167
168
169
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
    def maxtem(self,value): self.__maxtem = int(value)
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
    
170
171
172
173
174
    @property
    def getPerformanceData(self): return self.__time_code
    @getPerformanceData.setter
    def getPerformanceData(self,value): self.__time_code = bool(value)
    
175
176
177
178
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
    def noxaxis(self,value): self.__noxaxis = bool(value)
179
180
181
182
183
184
185
186
187
188
189
190

    def logo(self):
        print """                                              ..-
                          _                  '(
    PyKat                 \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
   `^-....____:   +."""
    
191
    def loadKatFile(self, katfile):
192
193
        commands=open(katfile).read()
        self.parseCommands(commands)
194
    
195
196
    def parseKatCode(self, code):
        #commands = code.split("\n")
197
        self.parseCommands(code)
198
        
199
    def parseCommands(self, commands):
200
        blockComment = False
Andreas Freise's avatar
Andreas Freise committed
201

202
203
204
205
        self.__currentTag= NO_BLOCK
        
        if not (NO_BLOCK in self.__blocks):
            self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
206
        
207
        commands=self.remove_comments(commands)
Andreas Freise's avatar
Andreas Freise committed
208
        
209
210
211
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
212
        for line in commands.split("\n"):
213
            #for line in commands:
214
215
            if len(line.strip()) >= 2:
                line = line.strip()
216
217

                # Looking for block start or end
218
219
                values = line.split(" ")
                if values[0] == "%%%":
220
221
                    if values[1] == "FTblock":
                        newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
222
223
                        
                        if self.__currentTag != None and newTag != self.__currentTag: 
224
                            warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
Daniel Brown's avatar
Daniel Brown committed
225
226
227
228
                            
                        if newTag in self.__blocks:
                            raise pkex.BasePyKatException("Block `{0}` has already been read")
                            
229
                        self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
230
                        self.__currentTag = newTag                            
Daniel Brown's avatar
Daniel Brown committed
231
                        
232
                    if values[1] == "FTend":
233
                        self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
234
                        
235
                    continue
236
237
                #warnings.warn("current tag {0}".format(self.__currentTag))    

238
239
240
241
242
243
244
245
246
247
248
249
                # don't read comment lines
                if line[0] == "#" or line[0] == "%":
                    continue
                
                # check if block comment is being used
                if not blockComment and line[0:2] == "/*":
                    blockComment = True
                    continue
                elif blockComment and line[0:2] == "*/":
                    blockComment = False
                    continue
                
250
                first = line.split(" ",1)[0]
251
                obj = None
252
                
253
                if(first == "m" or first == "m1" or first == "m2"):
254
                    obj = pykat.components.mirror.parseFinesseText(line)
255
                elif(first == "s"):
256
                    obj = pykat.components.space.parseFinesseText(line)
257
                elif(first == "l"):
258
                    obj = pykat.components.laser.parseFinesseText(line)
Sean Leavey's avatar
Sean Leavey committed
259
260
                elif(first[0:2] == "bs"):
                    obj = pykat.components.beamSplitter.parseFinesseText(line)
261
262
                elif(first[0:2] == "gr"):
                    obj = pykat.components.grating.parseFinesseText(line)
Sean Leavey's avatar
Sean Leavey committed
263
264
                elif(first[0:4] == "isol"):
                    obj = pykat.components.isolator.parseFinesseText(line)
Sean Leavey's avatar
Sean Leavey committed
265
266
                elif(first[0:4] == "lens"):
                    obj = pykat.components.lens.parseFinesseText(line)
267
268
                elif(first[0:3] == "mod"):
                    obj = pykat.components.modulator.parseFinesseText(line)
Andreas Freise's avatar
Andreas Freise committed
269
270
                elif(first[0:2] == "pd"):
                    obj = pykat.detectors.photodiode.parseFinesseText(line)
271
                elif(first == "xaxis" or first == "xaxis*"):
Andreas Freise's avatar
Andreas Freise committed
272
                    obj = pykat.commands.xaxis.parseFinesseText(line)
273
274
                elif(first == "x2axis" or first == "x2axis*"):
                    obj = pykat.commands.x2axis.parseFinesseText(line)
275
276
                elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
                    after_process.append(line)
277
                else:
Andreas Freise's avatar
Andreas Freise committed
278
279
                    if self.verbose:
                        print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
280
                    obj = line
281
282
                    # manually add the line to the block contents
                    self.__blocks[self.__currentTag].contents.append(line) 
283
                
284
                if obj != None and not isinstance(obj, str):
285
                    self.add(obj)
Daniel Brown's avatar
Daniel Brown committed
286
                    
287
288
289
290
291
292
293
294
        # now process all the varous gauss/attr etc. commands which require
        # components to exist first before they can be processed
        for line in after_process:
            first = line.split(" ",1)[0]
            
            if first == "gauss" or first == "gauss*" or first == "gauss**":
                pykat.commands.gauss.parseFinesseText(line)
            
295
        self.__currentTag = NO_BLOCK 
296
297
298
299
300
301
302
303
304
305
306
307
308
309

    def saveScript(self, filename=None):
        """
        Saves the current kat object to a Finesse input file
        """
        try:
            katScript = "".join(self.generateKatScript())       
            katfile = open(filename,'w')
            katfile.writelines(katScript)
            katfile.flush()
            katfile.close()

        except BasePyKatException as ex:
            print ex
310
            
311
    def run(self, printout=0, printerr=0, save_output=False, save_kat=False,kat_name=None) :
312
313
        """ 
        Runs the current simulation setup that has been built thus far.
314
        It returns a katRun or katRun2D object which is populated with the various
315
316
        data from the simulation run.
        """
317
318
        
        try:        
319
            if not hasattr(self, "xaxis") and self.noxaxis != None and self.noxaxis == False:
320
                raise pkex.BasePyKatException("No xaxis was defined")
321
            
322
            if len(self.__katdir) == 0:
323
324
325
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
326
                if self.__finesse_dir == None :
327
                    raise MissingFinesseEnvVar()
328
329
330
331
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
332
333
334
335
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
336
            else:
337
338
339
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
340
341
342
            
            # check if kat file exists and it is executable by user        
            if not (os.path.isfile(kat_exec) and os.access(kat_exec, os.X_OK)):
343
                raise MissingFinesse()
344
345
346
347
348
349
350
351
352
353
354
                
            print "--------------------------------------------------------------"
            start = datetime.datetime.now()
            print "Running kat - Started at " + str(start)
            
            if hasattr(self, "x2axis"):
                r = katRun2D()
            else:
                r = katRun()
                
            r.katScript = "".join(self.generateKatScript())   
355
356
            
            # create a kat file which we will write the script into
357
358
359
360
361
362
            if self.__tempname == None:
                katfile = tempfile.NamedTemporaryFile(suffix=".kat", dir=self.__tempdir)
            else:
                filepath =os.path.join(self.__tempdir, self.__tempname+".kat" )
                katfile = open( filepath, 'w' ) 
                
363
364
            katfile.writelines(r.katScript)
            katfile.flush()
365
            
366
            cmd=[kat_exec, '--perl1']
367
            
368
            if self.__time_code:
369
                cmd.append('--perf-timing')
370
371
372
373
374

            cmd.append('--no-backspace')
            # set default format so that less repeated numbers are printed to the
            # output file, should speed up running and parsing of output files
            cmd.append('-format=%.15g')
375
376

            cmd.append(katfile.name)
377
378
379
380
            
            #if self.verbose:
                #print cmd
                
381
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
382
            err = ""
383
            
384
385
            print "Finesse binary output:"
            
386
            for line in iter(p.stderr.readline, ""):
387
                #err += line 
388
                
389
390
391
392
393
394
395
396
397
                if len(line) > 0:
                    if line.rstrip().endswith('%'):
                        vals = line.split("-")
                        action = vals[0].strip()
                        prc = vals[1].strip()[:-1]
                        sys.stdout.write("\r{0} {1}%".format(action, prc))
                    elif line[0] == '*':
                        sys.stdout.write(line)
                        
398
            [out,errpipe] = p.communicate()
Daniel Brown's avatar
Daniel Brown committed
399
            
400
401
402
403
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
Daniel Brown's avatar
Daniel Brown committed
404
            
405
            r.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
406
            
407
            if p.returncode != 0:
408
                raise pkex.FinesseRunError(err, katfile.name)
409
            
410
411
412
413
414
415
            if printout == 1: print out
            if printerr == 1: print err

            root = os.path.splitext(katfile.name)
            base = os.path.basename(root[0])            
            outfile = root[0] + ".out"
Daniel Brown's avatar
Daniel Brown committed
416
            
417
418
419
420
421
422
423
424
425
426
            if save_output:        
                newoutfile = "{0}.out".format(base)
                
                cwd = os.path.os.getcwd()
                newoutfile = os.path.join(cwd,newoutfile)
                
                if os.path.isfile(newoutfile):
                    os.remove(newoutfile)
                    
                os.rename(outfile, newoutfile)
Daniel Brown's avatar
Daniel Brown committed
427

428
429
430
431
                print "\nOutput data saved to '{0}'".format(newoutfile)
            
            if hasattr(self, "x2axis"):
                [r.x,r.y,r.z,hdr] = self.readOutFile(outfile)
432
                
433
434
435
436
437
438
439
440
441
                r.xlabel = hdr[0]
                r.ylabel = hdr[1]
                r.zlabels = map(str.strip, hdr[2:])
            else:
                [r.x,r.y,hdr] = self.readOutFile(outfile)
            
                r.xlabel = hdr[0]
                r.ylabels = map(str.strip, hdr[1:])
                            
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
            if save_kat:
                if kat_name == None:
                    kat_name = "pykat_output"                
                
                cwd = os.path.os.getcwd()
                newkatfile = os.path.join(cwd, kat_name + ".kat")
                
                if os.path.isfile(newkatfile):
                    os.remove(newkatfile)
                  
                os.rename(katfile.name, newkatfile)         
                
                print "Kat file saved to '{0}'".format(newkatfile)
                

            katfile.close()
            perfData = []
459
            
460
461
462
463
464
465
466
467
468
469
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
                    vals = l.strip().split(' ')
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
                    
                return [r, perfData]
            else:
                return r
470
            
471
        except pkex.FinesseRunError as fe:
472
            print fe
473
474
475
        finally:
            print ""
            print "Finished in " + str(datetime.datetime.now()-start)
476
            
Daniel Brown's avatar
Daniel Brown committed
477
        
478
    def add(self, obj):
479
        try:
480
            obj.tag = self.__currentTag
481
            self.__blocks[self.__currentTag].contents.append(obj)
Daniel Brown's avatar
Daniel Brown committed
482
            
483
484
485
            if isinstance(obj, Component):
                
                if obj.name in self.__components :
486
                    raise BasePyKatException("A component with name '{0}' has already been added".format([obj.name]))            
487
488
489
490
491
492
493
                            
                self.__components[obj.name] = obj
                self.__add_component(obj)
                
            elif isinstance(obj, Detector):
                
                if obj.name in self.__detectors :
494
                        raise BasePyKatException("A detector '{0}' has already been added".format(obj.name))
Daniel Brown's avatar
Daniel Brown committed
495
                        
496
497
498
499
500
501
502
503
504
                self.__detectors[obj.name] = obj
                self.__add_detector(obj)
                
            elif isinstance(obj, Command):
                
                self.__commands[obj.__class__.__name__] = obj
                self.__add_command(obj)
                
            else :
505
                raise pkex.BasePyKatException("Object {0} could not be added".format(obj))
506
507
                
            obj._on_kat_add(self)
Daniel Brown's avatar
Daniel Brown committed
508
            
509
        except pkex.BasePyKatException as ex:
510
            print ex
511

Daniel Brown's avatar
Daniel Brown committed
512
513
    def readOutFile(self, filename):
        
514
515
516
517
518
519
        with open(filename,'r') as outfile:
            # read first to lines to get to header line
            outfile.readline()
            outfile.readline()
            
            hdr = outfile.readline().replace('%','').replace('\n','').split(',')
Daniel Brown's avatar
Daniel Brown committed
520
        
521
        data = np.loadtxt(filename,comments='%',skiprows=4)
Daniel Brown's avatar
Daniel Brown committed
522
        
523
524
525
526
527
        if hasattr(self, "x2axis"):
            # need to parse 2D outputs slightly different as they are effectively 2D matrices
            # written in linear form
            x = data[0::(1+self.x2axis.steps),0]
            y = data[0:(1+self.x2axis.steps),1]
528
529
            # get rows and columns lined up so that we can reshape a single column of all x/y data
            # into a matrix
530
            z = data[:,2:].transpose().reshape(data.shape[1]-2, 1+self.xaxis.steps, 1+self.x2axis.steps)
531
532
            # once you do this the data for y and x axes need swapping
            z = z.swapaxes(1,2)
533
            return [x, y, z, hdr]
534
        else:
535
            shape_len = len(data.shape)
536
            
537
538
539
540
541
542
543
544
545
546
547
548
            if shape_len > 1:
                rows,cols = data.shape
                x = data[:,0]
                y = data[:,1:cols].squeeze()
            else:
                rows = 1
                cols = data.shape[0]
                
                x = data[0]
                y = data[1:cols].squeeze()
            
            return [x, y, hdr]
549
550
            
    def generateKatScript(self) :
Daniel Brown's avatar
Daniel Brown committed
551
        """ Generates the kat file which can then be run """
Daniel Brown's avatar
Daniel Brown committed
552
        
Daniel Brown's avatar
Daniel Brown committed
553
554
        out = []    
        
555
        for key in self.__blocks:
556
            objs = self.__blocks[key].contents
557
558
            
            out.append("%%% FTblock " + key + "\n")
559
            
560
561
            for obj in objs:
                if isinstance(obj, str):
Daniel Brown's avatar
Daniel Brown committed
562
                    out.append(obj + '\n')
563
564
565
566
567
568
                    
                elif isinstance(obj, Component) or isinstance(obj, Detector) or isinstance(obj, Command):
                    txt = obj.getFinesseText() 
                    
                    if txt != None:
                        if isinstance(txt,list):
569
570
                            for t in txt:
                                out.append(t + "\n")
571
572
573
                        else:
                            out.append(txt + "\n")
                            
574
            out.append("%%% FTend " + key + "\n")
Daniel Brown's avatar
Daniel Brown committed
575
576
577
578
        
        if self.noxaxis != None and self.noxaxis == True:
            out.append("noxaxis\n")
            
579
580
581
582
583
584
585
586
587
588
        # now loop through all the nodes and get any gauss commands
        for key in self.nodes.getNodes():
            txt = self.nodes.getNodes()[key].getFinesseText()
            
            if txt != None:
                if isinstance(txt,list):
                    for t in txt: out.append(t+ "\n")
                else:
                    out.append(txt + "\n")
        
Daniel Brown's avatar
Daniel Brown committed
589
590
        if self.phase != None: out.append("phase {0}\n".format(self.phase))
        if self.maxtem != None: out.append("maxtem {0}\n".format(self.maxtem))            
591

Daniel Brown's avatar
Daniel Brown committed
592
593
        # ensure we don't do any plotting. That should be handled
        # by user themselves
Daniel Brown's avatar
Daniel Brown committed
594
595
596
597
598
599
        out.append("gnuterm no\n")
        out.append("pyterm no\n")
        
        return out
        
    def openGUI(self):
Daniel Brown's avatar
Daniel Brown committed
600
601
602
        if NO_GUI:
            print  "No PyQt4 module was installed so cannot open a GUI"
        else:
603
604
605
606
607
608
609
            self.app = QCoreApplication.instance() 
            created = False
            
            if self.app == None:
                created = True
                self.app = QApplication([""])
                
Daniel Brown's avatar
Daniel Brown committed
610
611
612
613
614
            if self.pykatgui == None:
                self.pykatgui = pyKatGUI(self)
                self.pykatgui.main()
            else:
                self.pykatgui.show()
615
616
                
            if created: self.app.exec_()
Daniel Brown's avatar
Daniel Brown committed
617
618
619
620
    
    def getComponents(self):
        return self.__components.values()
    
621
622
623
    def hasComponent(self, name):
        return (name in self.__components)
    
624
    def _newName(self, container, prefix):
625
626
627
        n = 1
        name = "{0}{1}".format(prefix, n)
        
628
        while name in container:
629
630
631
632
633
            n += 1
            name = "{0}{1}".format(prefix,n)
        
        return name
    
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
    def getNewComponentName(self,prefix):
        '''
        Returns a name for a component which hasn't already been added.
        Returns [prefix] + number, where number is greater than 1. e.g.
        if m1 exists getNewName('m') will return 'm2'
        '''
        return self._newName(self.__components, prefix)
    
    def getNewDetectorName(self,prefix):
        '''
        Returns a name for a component which hasn't already been added.
        Returns [prefix] + number, where number is greater than 1. e.g.
        if m1 exists getNewName('m') will return 'm2'
        '''
        return self._newName(self.__detectors, prefix)
        
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
    def getNewNodeNames(self,prefix,N=1):
        '''
        Returns a list of names for N number of nodes which haven't already been added.
        Returns [prefix] + number, where number is greater than 1. e.g.
        if m1 exists getNewName('m') will return 'm2'
        '''
        rtn = []
        n = 1
        
        for M in range(1,N+1):
            name = "{0}{1}".format(prefix, n)
            
            while name in self.nodes.getNodes() or (name in rtn):
                n += 1
                name = "{0}{1}".format(prefix,n)
        
            rtn.append(name)
            
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
670
671
672
673
    
    def __add_detector(self, det):

        if not isinstance(det, Detector):
674
            raise exceptions.ValueError("Argument is not of type Detector")
Daniel Brown's avatar
Daniel Brown committed
675
676
        
        name = det.name
677
        fget = lambda self: self.__get_detector(name)
Daniel Brown's avatar
Daniel Brown committed
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
        
        setattr(self.__class__, name, property(fget))
        setattr(self, '__det_' + name, det)                   

    def __get_detector(self, name):
        return getattr(self, '__det_' + name) 
        
    def __add_command(self, com):

        if not isinstance(com, Command):
            raise exceptions.ValueError("Argument is not of type Command")
        
        name = com.__class__.__name__
        fget = lambda self: self.__get_command(name)
        
        setattr(self.__class__, name, property(fget))
        setattr(self, '__com_' + name, com)                   

    def __get_command(self, name):
        return getattr(self, '__com_' + name)            
    
    def __add_component(self, comp):

        if not isinstance(comp, Component):
            raise exceptions.ValueError("Argument is not of type Component")
            
        fget = lambda self: self.__get_component(comp.name)
        
        setattr(self.__class__, comp.name, property(fget))
        setattr(self, '__comp_' + comp.name, comp)                   

    def __get_component(self, name):
710
        return getattr(self, '__comp_' + name)        
711
712
713
714
715
716
717
718
719
720
721
722
723
724

    def remove_comments(self, string):
        pattern = r"(\".*?\"|\'.*?\'|%{3}[^\r\n]*$)|(/\*.*?\*/|%[^\r\n]*$|#[^\r\n]*$|//[^\r\n]*$)"
        # first group captures quoted strings (double or single)
        # second group captures comments (//single-line or /* multi-line */)
        regex = re.compile(pattern, re.MULTILINE|re.DOTALL)
        def _replacer(match):
            # if the 2nd group (capturing comments) is not None,
            # it means we have captured a non-quoted (real) comment string.
            if match.group(2) is not None:
                return "" # so we will return empty to remove the comment
            else: # otherwise, we will return the 1st group
                return match.group(1) # captured quoted-string
        return regex.sub(_replacer, string)