finesse.py 58.2 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 09:56:53 2013

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
"""
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
import pickle
import pykat
import warnings
import re
36
import math       
Daniel Brown's avatar
Daniel Brown committed
37
import itertools
Daniel Brown's avatar
Daniel Brown committed
38
import ctypes
Daniel Brown's avatar
Daniel Brown committed
39
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
40
import collections
41
42
import re

43
from collections import namedtuple, OrderedDict
44

Daniel Brown's avatar
Daniel Brown committed
45
from pykat.node_network import NodeNetwork
46
from pykat.detectors import BaseDetector as Detector
Daniel Brown's avatar
Daniel Brown committed
47
48
from pykat.components import Component
from pykat.commands import Command, xaxis
49
from pykat.SIfloat import *
50
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
51
52
53

import pykat.exceptions as pkex

54
55
56
57
58
59
from pykat import USE_GUI, NoGUIException

if USE_GUI:
    from pykat.gui.gui import pyKatGUI
    from PyQt4.QtCore import QCoreApplication
    from PyQt4.QtGui import QApplication
Daniel Brown's avatar
Daniel Brown committed
60

Daniel Brown's avatar
Daniel Brown committed
61
62
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
63
NO_BLOCK = "NO_BLOCK"
64
65
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
66
67
68
69
70
71
72
# containers used in the trace routine
space_trace = namedtuple("space_trace", ['gouyx','gouyy'])
node_trace = namedtuple("node_trace", ['qx','qy'])
cav_trace = namedtuple("cav_trace", ['isStable','gx','gy','qx','qy','finesse','loss','length','FSR','FWHM','pole'])
         
lkat_location = ctypes.util.find_library("kat")
                                     
Daniel Brown's avatar
Daniel Brown committed
73
74
75
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
76
77
78
79
80
    
    if lkat_location == None:
        raise RuntimeError("Could not find shared library 'libkat', please install to a system location or copy to the same directory as this script")
        
    lkat = ctypes.PyDLL(lkat_location)
Daniel Brown's avatar
Daniel Brown committed
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

    try:
        lkat._pykat_preInit() # must always be called, sets up
                        # exception handling and such no simulation
                        # specifc code here

        # reads in the kat.ini and setups up other parts
        lkat._pykat_init()
        lkat._pykat_setup(cmd)
    
        callback(lkat, **kwargs)
    
    except Exception as ex: 
        print "Exception caught in python: ", ex.message
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
98
99


100
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
101
102
103
104
105
106
107
108
109
110
111
112
    """
    lkat callback for computing the beam traces through a setup.
    Returns a dictionary of nodes, spaces and cavities and the
    various outputs of the tracing algorithm.
    """
    import pylibkat

    # first we need to get a handle on the internals of Finesse
    inter = pylibkat.interferometer.in_dll(lkat, "inter")

    lkat._pykat_step()

113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
    if getNodes:
        for n in range(0, inter.num_nodes):
            node = inter.node_list[n]

            node_info = node_trace(
                                    qx = complex(node.qx.re, node.qx.im),
                                    qy = complex(node.qy.re, node.qy.im)
                                    )

            trace_info[node.name] = node_info

    if getCavities:
        for c in range(0, inter.num_cavities):
            cav = inter.cavity_list[c]

            cav_info = cav_trace(
                                isStable = (cav.stable == 1),
                                gx = cav.stability_x,
                                gy = cav.stability_y,
                                qx = complex(cav.qx.re, cav.qx.im),
                                qy = complex(cav.qy.re, cav.qy.im),
                                finesse = cav.finesse,
                                FSR = cav.FSR,
                                FWHM = cav.FWHM,
                                loss = cav.loss,
                                length = cav.length,
                                pole = cav.pole
Daniel Brown's avatar
Daniel Brown committed
140
141
                                )

142
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
143

144
145
146
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
147

148
149
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
150
151
                     
                                             
Daniel Brown's avatar
Daniel Brown committed
152
153
154
155
156
157
158
159
160
class katRun(object):
    def __init__(self):
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
161
        self.yaxis = None
162
        
163
164
165
166
167
168
169
    def plot(self):
        import pylab
        
        pylab.plot(self.x, self.y)
        pylab.legend(self.ylabels,0)
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
170
        
171
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
172
173
174
175
176
177
178
179
180
181
182
        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):
183
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
184

185
186
        if len(idx) > 0:
            out = self.y[:, idx]
187
            
188
189
190
191
192
193
194
195
196
197
            if len(idx) == 1:
                if self.yaxis == "abs:deg":
                    out = self.y[:, idx[0]]
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]]
            else: 
                if self.yaxis == "abs:deg":
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
198
            
199
            if out.size == 1:
200
                return out[0].squeeze()
201
            else:
202
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
203
        else:
204
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
      
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)
    
227
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
228
229
    
    def __getitem__(self, value):
230
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
231
232
233
234
235
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
236
    
237
        
238
239
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
240
        def __init__(self, param, name, amplitude, phase, signal):
241
242
243
244
245
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
246
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
247
248
            self.__signal = signal
			
249
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
250
            # various parameter names of the c	omponents, e.g. mirror xbeta is x 
251
252
253
            # for fsig. So we need to check here what type of component we are targetting
            # and then based on the parameter specfied get the name
            if not param.canFsig:
254
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
255
256
257
            
        def _register_param(self, param):
            self._params.append(param)
258
259
260
        
        @property
        def removed(self): return self.__removed
261
  
262
263
264
265
        def remove(self):
            if self.__removed:
                raise pkex.BasePyKatException("Signal {0} has already been marked as removed".format(self.name))
            else:
Daniel Brown's avatar
Daniel Brown committed
266
267
                self.__signal.targets.remove(self)
                self.__remove = True
268
        
269
270
271
272
273
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
274
275
276
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

277
278
279

        @property
        def phase(self): return self.__phase
280
281
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
282
283
284
285
286

        @property
        def target(self): return self.__target.fsig_name

        @property
287
        def owner(self): return self.__target._owner().name
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
    @property
    def name(self):
        # if we don't have any signals yet then use a dummy name
        # however we need to always tune a real fsig command
        # so need to get the name of at least one of them
        # as if you tune one you tune them all
        if len(self.targets) == 0:
304
            return "fsignal"
305
306
        else:
            return self.targets[0].name
307
308
            
    @property
Daniel Brown's avatar
Daniel Brown committed
309
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
310

311
312
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
313
            t.remove()
314
            
315
316
    @property
    def f(self): return self.__f
317
318
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
319
    
Daniel Brown's avatar
Daniel Brown committed
320
321
322
    def __init__(self, kat):
        if kat == None:
            raise  pkex.BasePyKatException("kat object must be specified")
323
324
        self.targets = []
        self._params = []
Daniel Brown's avatar
Daniel Brown committed
325
        self.__kat = kat
326
327
328
329
330
331
332
333
334
335
336
        self.__f = Param("f", self, 1)
    
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
        if target == None:
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
        if name == None:
337
            name = "sig_" + target._owner().name + "_" + target.name
338
        
Daniel Brown's avatar
Daniel Brown committed
339
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
340
341
342
343
344
345
346
347
348
349
350
351
352
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
            rtn.append("fsig {name} {comp} {target} {frequency} {phase} {amplitude}".format(name = t.name, comp=t.owner, target=t.target, frequency=str(self.f), phase=str(t.phase), amplitude=str(t.amplitude)))
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
353
354
355
356
357
358
359
360
361
class Block:
    def __init__(self, name):
        self.__name = name
        self.contents = [] # List of objects and strings of finesse code
        self.enabled = True 
        
    @property
    def name(self): return self.__name
    
362
363
364
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
365
366
        
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
367
368
369

        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
Daniel Brown's avatar
Daniel Brown committed
370
371
372
        
        self.scene = None # scene object for GUI
        self.verbose = True
373
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
374
375
376
377
378
379
380
381
382
383
        self.__components = {}  # dictionary of optical components      
        self.__detectors = {}   # dictionary of detectors
        self.__commands = {}    # dictionary of commands
        self.__gui = None
        self.nodes = NodeNetwork(self)  
        self.__katdir = katdir
        self.__katname = katname
        self.__tempdir = tempdir
        self.__tempname = tempname
        self.pykatgui = None
Daniel Brown's avatar
Daniel Brown committed
384
        self.__signals = Signals(self)
385
        self.constants = {}
386
        self.vacuum = []
387
388
        self.__prevrunfilename = None
        self.printmatrix = None
389
390
391
392
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
393
394
395
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
396
397
        self.retrace = None
        self.deriv_h = None
398
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
399
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
400
401
        self.__phase = None
        self.__maxtem = None
402
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
403
        self.__time_code = None
404
        self.__yaxis = "abs" # default yaxis
405
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
406
407
408
409
410
411
412
413
414
        
        if kat_code != None and kat_file != None:
            raise pkex.BasePyKatException("Specify either a Kat file or some Kat code, not both.")
        
        if kat_code != None:
            self.parseCommands(kat_code)
        
        if kat_file != None:
            self.loadKatFile(kat_file)
Daniel Brown's avatar
Daniel Brown committed
415

416
417
418
    @property
    def signals(self): return self.__signals

419
420
421
422
423
424
425
426
427
428
429
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
        
        if not str(value) in self.yaxis_options:
            raise pkex.BasePyKatException("yaxis value '{0}' is not a value option. Valid options are: {1}".format(str(value), ",".join(self.yaxis_options) ))
            
        self.__yaxis = str(value)

Sean Leavey's avatar
Sean Leavey committed
430
431
432
433
434
435
436
437
438
439
440
    @property
    def trace(self): return self.__trace
    @trace.setter
    def trace(self, value):
        value = int(value)

        if value < 0 or value > 255:
            raise pkex.BasePyKatException('trace command only accepts values in the range 0-255.')
        else:
            self.__trace = value

441
442
443
444
445
446
447
448
449
450
    @property
    def lambda0(self): return self.__lambda0
    @lambda0.setter
    def lambda0(self, value):
        self.__lambda0 = SIfloat(value)
        
        for node in self.nodes.getNodes():
            if self.nodes[node].q != None:
                self.nodes[node].q.wavelength = self.__lambda0

Daniel Brown's avatar
Daniel Brown committed
451
452
453
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
454
455
456
457
458
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
459
460
461
462
463
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
464
        
Daniel Brown's avatar
Daniel Brown committed
465
466
467
468
469
    @property
    def getPerformanceData(self): return self.__time_code
    @getPerformanceData.setter
    def getPerformanceData(self,value): self.__time_code = bool(value)
    
Daniel Brown's avatar
Daniel Brown committed
470
471
472
473
474
475
476
477
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
478
479
480
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
481
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
482

483
484
    @staticmethod
    def logo():
Daniel Brown's avatar
Daniel Brown committed
485
        print """                                              ..-
486
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
487
488
489
490
491
492
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
493
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web)
Daniel Brown's avatar
Daniel Brown committed
494
    
495
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
496
        commands=open(katfile).read()
497
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
498
    
499
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
500
        #commands = code.split("\n")
501
        self.parseCommands(code, blocks=blocks)
502
503
504
505
506
507
508
509
510

    def processConstants(self, commands):
        """
        Before fully parsing a bunch of commands firstly any constants or variables
        to be recorded and replaced.
        """
        constants = self.constants
        
        for line in commands:
511
            values = line.split()
512
513
514
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
515
                if len(values) >= 3:
516
517
518
                    if values[1] in constants:
                        raise pkex.BasePyKatException('const command with the name "{0}" already used'.format(values[1]))
                    else:
Daniel Brown's avatar
Daniel Brown committed
519
                        constants[str(values[1])] = Constant(values[1], values[2], [])
520
521
522
523
524
525
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
526
            values = line.split()
527
            
528
            if len(values) > 0 and values[0] != 'const':
529
530
531
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
                        # TODO: need to fix this for checking mulitple instances of const in a single line
                        
                        chars = [' ', '+', '-', '*', '/', ')']

                        for c in chars:
                            none_found = False
                            
                            while not none_found:
                                if line.find('$'+key+c) > -1:
                                    constants[key].usedBy.append(line)
                                    line = line.replace('$'+key+c, str(constants[key].value)+ c)
                                else:
                                    none_found = True
                        
                        if line.endswith('$'+key):
547
548
549
550
551
552
553
554
                            constants[key].usedBy.append(line)
                            line = line.replace('$'+key, str(constants[key].value))
                        
                commands_new.append(line)
    
        self.constants = constants
        
        return commands_new
Daniel Brown's avatar
Daniel Brown committed
555
        
556
    def parseCommands(self, commands, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
557
558
559
        blockComment = False
        
        commands=self.remove_comments(commands)
560
561
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
562
563
564
565
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
566
        for line in commands:
567
568
569
570
571
572
573
574
575
576
            try:
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
                
                    if values[0] == "%%%":
                        if values[1] == "FTblock":
                            newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
577
                        
578
579
                            if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
                                warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
Daniel Brown's avatar
Daniel Brown committed
580
                            
581
582
                            if newTag in self.__blocks:
                                raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
583
                            
584
585
                            self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                            self.__currentTag = newTag
Daniel Brown's avatar
Daniel Brown committed
586
                        
587
588
                        if values[1] == "FTend":
                            self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
589
                        
590
                        continue
Daniel Brown's avatar
Daniel Brown committed
591

592
593
594
595
596
597
598
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
                    
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
Daniel Brown's avatar
Daniel Brown committed
599
                
600
601
602
603
604
605
606
                    # 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
Daniel Brown's avatar
Daniel Brown committed
607
                
608
609
                    first = line.split(" ",1)[0]
                    obj = None
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
635
636
637
638
639
640
641
642
                    if(first == "m" or first == "m1" or first == "m2"):
                        obj = pykat.components.mirror.parseFinesseText(line)
                    elif(first == "s"):
                        obj = pykat.components.space.parseFinesseText(line)
                    elif(first == "l"):
                        obj = pykat.components.laser.parseFinesseText(line)
                    elif(first == "sq"):
                        obj = pykat.components.squeezer.parseFinesseText(line)
                    elif(first[0:2] == "bs"):
                        obj = pykat.components.beamSplitter.parseFinesseText(line)
                    elif(first[0:2] == "gr"):
                        obj = pykat.components.grating.parseFinesseText(line)
                    elif(first[0:4] == "isol"):
                        obj = pykat.components.isolator.parseFinesseText(line)
                    elif(first[0:4] == "lens"):
                        obj = pykat.components.lens.parseFinesseText(line)
                    elif(first[0:3] == "mod"):
                        obj = pykat.components.modulator.parseFinesseText(line)
                    elif(first[0:2] == "ad"):
                        obj = pykat.detectors.ad.parseFinesseText(line)
                    elif(first[0:2] == "bp"):
                        obj = pykat.detectors.bp.parseFinesseText(line)
                    elif(first[0:4] == "gouy"):
                        obj = pykat.detectors.gouy.parseFinesseText(line)
                    elif(first[0:2] == "pd" and first != "pdtype"):
                        obj = pykat.detectors.pd.parseFinesseText(line)
                    elif(first == "qshot" or first == "qshotS" or first == "qshotN"):
                        obj = pykat.detectors.qshot.parseFinesseText(line)
                    elif(first == "qnoised" or first == "qnoisedS" or first == "qnoisedN"):
                        obj = pykat.detectors.qnoised.parseFinesseText(line)
                    elif(first == "xaxis" or first == "xaxis*"):
                        obj = pykat.commands.xaxis.parseFinesseText(line)
643
644
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
645
646
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
                        after_process.append(line)
                    elif(first == "scale"):
                        after_process.append(line)
                    elif(first == "pdtype"):
                        after_process.append(line)
                    elif(first == "attr"):
                        after_process.append(line)
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
                        v = line.split()
                    
                        self.yaxis = v[-1]
                    elif(first == "phase"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
                        else:
                            self.phase = int(v[1])
                    elif(first == "maxtem"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                        else:
                            if v[1] == "off":
                            	self.maxtem = -1
                            else:
    	                        self.maxtem = int(v[1])
                    elif(first == "trace"):
                        v = line.split()
                        if len(v) > 2:
                            raise pkex.BasePyKatException("Trace command `{0}` is incorrect.".format(line))
                        elif len(v) == 2:
                            self.trace = v[1]
                    elif(first == "retrace"):
                        v = line.split()
                        if len(v) > 2:
                            raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
                        elif len(v) == 2:
                            self.retrace = v[1]                        
                    elif(first == "deriv_h"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
697
                        else:
698
699
700
701
702
703
704
705
706
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
                            print "Ignoring Gnuplot/Python terminal command '{0}'".format(line)
                    #elif(first == "fsig"):
                    #    after_process.append(line)
                    elif(first == "noplot"):
                        obj = line
                        self.__blocks[self.__currentTag].contents.append(line) 
707
                    else:
708
709
                        if self.verbose:
                            print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
710
                        
711
712
713
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
Daniel Brown's avatar
Daniel Brown committed
714
                
715
716
717
718
                    if obj != None and not isinstance(obj, str):
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
                            print "Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line)
719
                        
720
721
722
723
724
725
726
727
                        self.add(obj)
            except:
                print "--------------------------------------------------------"
                print "Error parsing line: " + line
                print "--------------------------------------------------------"
                raise
                
                
Daniel Brown's avatar
Daniel Brown committed
728
729
730
        # 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:
731
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
732
            if first == "gauss" or first == "gauss*" or first == "gauss**":
733
                pykat.commands.gauss.parseFinesseText(line, self)
734
            elif (first == "scale"):
735
                v = line.split()
Daniel Brown's avatar
Daniel Brown committed
736
737
                accepted = ["PSD","PSD_HF","ASD","ASD_HF","meter", "ampere", "degs"]
                
738
739
                if len(v) == 3:
                    component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
740
741
742
743
744
745
746
747
748
                    
                    if v[1] in accepted:
                        val = v[1]
                    else:
                        try:
                            val = SIfloat(v[1])
                        except ex as exception.ValueError:
                            raise pkex.BasePyKatException("Line `{0}`:\nAccepted scale values are decimal numbers or %s." % (line,str(accepted)))
                            
749
                    if component_name in self.__detectors :
Daniel Brown's avatar
Daniel Brown committed
750
                        self.__detectors[component_name].scale.append(val)
751
                    else:
752
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
753
754
755
756
757
                elif len(v) == 2:
                    if v[1] == "meter" or v[1] == "ampere" or v[1] == "deg":
                        self.scale = v[1]
                    else:
                        self.scale = SIfloat(v[1])
758
                else:
759
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
760
            elif (first == "pdtype"):
761
                v = line.split()
762
763
764
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
765
                        self.__detectors[component_name].pdtype = v[2]
766
                    else:
767
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
768
                else:
769
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
770
771
            elif(first == "attr"):
                v = line.split()
772

Daniel Brown's avatar
Daniel Brown committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
                if len(v) < 4:
                    raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
                else:
                    # get the component/detector in question
                    if v[1] in self.__components:
                        comp = self.__components[v[1]]
                    elif v[1] in self.__detectors:
                        comp = self.__detectors[v[1]]
                    else:
                        raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
                
                    if len(v[2:]) % 2 == 1:
                        raise pkex.BasePyKatException("Attr command '{0}' must specify both parameter and value pairs".format(line))
                                                
                    # convert split list to key value pairs
                    kv = dict(itertools.izip_longest(*[iter(v[2:])] * 2, fillvalue=None))

                    comp.parseAttributes(kv)
791
                    
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
            elif(first == "fsig"):
                
                v = line.split()
                
                if v[2] in self.__components:
                    comp = self.__components[v[1]]
                else:
                    raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
                
                
                #kat.siganls.apply()
                
            else:
                raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
                    
Daniel Brown's avatar
Daniel Brown committed
807
        self.__currentTag = NO_BLOCK 
808
        
Daniel Brown's avatar
Daniel Brown committed
809
810
811
812
813
814
815
816
817
818
819
820
821
    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 pkex.BasePyKatException as ex:
            print ex
Daniel Brown's avatar
Daniel Brown committed
822

Daniel Brown's avatar
Daniel Brown committed
823
            
Daniel Brown's avatar
Daniel Brown committed
824
825
826
827
828
829
830
831
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
832
    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False, kat_name=None, cmd_args=None) :
Daniel Brown's avatar
Daniel Brown committed
833
834
835
836
        """ 
        Runs the current simulation setup that has been built thus far.
        It returns a katRun or katRun2D object which is populated with the various
        data from the simulation run.
Sean Leavey's avatar
Sean Leavey committed
837
        printout=1 prints the Finesse banner
838
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
839
840
841
842
843
        plot (string) - Sets gnuterm for plotting
        save_output (bool) - if true does not delete out file
        save_kat (bool) - if true does not delete kat file
        kat_name (string) - name of kat file if needed, will be randomly generated otherwise
        cmd_args (list of strings) - command line flags to pass to FINESSE
Daniel Brown's avatar
Daniel Brown committed
844
845
846
847
848
849
850
851
852
853
854
855
        """
        start = datetime.datetime.now()
        
        try:        
            if not hasattr(self, "xaxis") and self.noxaxis != None and self.noxaxis == False:
                raise pkex.BasePyKatException("No xaxis was defined")
            
            if len(self.__katdir) == 0:
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
                if self.__finesse_dir == None :
856
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
            else:
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
            
            # 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)):
872
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
873
874
875
876
                
            if self.verbose: print "--------------------------------------------------------------"
            if self.verbose: print "Running kat - Started at " + str(start)
            
877
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
878
879
880
881
                r = katRun2D()
            else:
                r = katRun()
                
882
            r.yaxis = self.yaxis
Daniel Brown's avatar
Daniel Brown committed
883
            r.katScript = "".join(self.generateKatScript())   
884
885
886
887
888
889
890
891

            if (plot==None):
                # ensure we don't do any plotting. That should be handled
                # by user themselves
                r.katScript+=("gnuterm no\n")
                r.katScript+=("pyterm no\n")
            else:
                r.katScript+=(plot+"\n")
Daniel Brown's avatar
Daniel Brown committed
892
893
894
895
896
897
898
899
900
901
            
            # create a kat file which we will write the script into
            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' ) 
                
            katfile.writelines(r.katScript)
            katfile.flush()
902

903
            if printout == 1 or plot != None:
904
905
906
                cmd=[kat_exec]
            else:
                cmd=[kat_exec, '--perl1']
Daniel Brown's avatar
Daniel Brown committed
907
908
909
            
            if self.__time_code:
                cmd.append('--perf-timing')
910
911
912
913
            
            if cmd_args != None:
                cmd.extend(cmd_args)
                
Daniel Brown's avatar
Daniel Brown committed
914
915
916
917
918
919
            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')

            cmd.append(katfile.name)
920
                            
Daniel Brown's avatar
Daniel Brown committed
921
922
923
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
            err = ""
            
924
            #if self.verbose: print "Finesse output:"            
Daniel Brown's avatar
Daniel Brown committed
925
            for line in iter(p.stderr.readline, ""):
926
                if len(line) > 0:
927
928
929
                    # remove any ANSI commands
                    ansi = re.compile(r'\x1b[^m]*m')
                    line = ansi.sub('', line)
930

931
932
                    # warnings and errors start with an asterisk 
                    # so if verbose show them
933
934
935
                    if line.lstrip().startswith('*PROG*'):
                        line = line[8:-1]
                        vals = line.split("-",1)
936
937
938
939
940
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                    
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
941
942
                    elif line.lstrip().startswith('*'):
                        if self.verbose: sys.stdout.write(line)        
Daniel Brown's avatar
Daniel Brown committed
943
944
945
946
947
948
949
950
                    elif line.rstrip().endswith('%'):
                        vals = line.split("-")
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                        
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
                            
951
952
                    else:
                        err += line
953

Daniel Brown's avatar
Daniel Brown committed
954
            
Daniel Brown's avatar
Daniel Brown committed
955
            [out,errpipe] = p.communicate()
956
            
957
958
            if printout == 1: 
                print out
Andreas Freise's avatar
Andreas Freise committed
959
960
            else:
                if printerr == 1: print ""
961

Daniel Brown's avatar
Daniel Brown committed
962
963
964
965
966
967
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
            
            r.runDateTime = datetime.datetime.now()
968
969

            # If Finesse returned an error, just print that and exit!
Daniel Brown's avatar
Daniel Brown committed
970
            if p.returncode != 0:
971
972
                print err
                sys.exit(1) 
Daniel Brown's avatar
Daniel Brown committed
973
            
974
975
            self.__prevrunfilename = katfile.name
            
Daniel Brown's avatar
Daniel Brown committed
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
            root = os.path.splitext(katfile.name)
            base = os.path.basename(root[0])            
            outfile = root[0] + ".out"
            
            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)

                if self.verbose: print "\nOutput data saved to '{0}'".format(newoutfile)
            
993
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
994
995
996
997
998
                [r.x,r.y,r.z,hdr] = self.readOutFile(outfile)
                
                r.xlabel = hdr[0]
                r.ylabel = hdr[1]
                r.zlabels = map(str.strip, hdr[2:])
999
                         
Daniel Brown's avatar
Daniel Brown committed
1000
1001
1002
1003
1004
            else:
                [r.x,r.y,hdr] = self.readOutFile(outfile)
            
                r.xlabel = hdr[0]
                r.ylabels = map(str.strip, hdr[1:])
1005
                    
Daniel Brown's avatar
Daniel Brown committed
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
            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)         
                
                if self.verbose: print "Kat file saved to '{0}'".format(newkatfile)
                
Sean Leavey's avatar
Sean Leavey committed
1020
1021
1022
1023
1024
1025
1026
1027
            if self.trace != None and self.trace > 0:
                #print "{0}".format(out)
                #if self.trace & 1:
                    #search = out.find(' --- highest order of TEM modes')
                    #if search > -1:
                        #print "Trace 1: {0}".format(out[search:])

                # for now, just try to print the trace block in full
Sean Leavey's avatar
Bug fix    
Sean Leavey committed
1028
                print out[out.find(' ---') :]
Daniel Brown's avatar
Daniel Brown committed
1029
1030
1031
1032
1033
1034
1035
1036

            katfile.close()
            perfData = []
            
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
1037
                    vals = l.strip().split()
Daniel Brown's avatar
Daniel Brown committed
1038
1039
1040
1041
1042
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
                    
                return [r, perfData]
            else:
                return r
1043
1044
            
        except pkex.FinesseRunError as fe:
Daniel Brown's avatar
Daniel Brown committed
1045
1046
1047
1048
1049
            print fe
        finally:
            if self.verbose: print ""
            if self.verbose: print "Finished in " + str(datetime.datetime.now()-start)
            
1050
    def remove(self, obj):
Daniel Brown's avatar
Daniel Brown committed
1051
        if not isinstance(obj, pykat.finesse.Signals) and not (obj.name in self.__components  or obj.name in self.__detectors or obj.name in self.__commands or obj in self.signals.targets):
1052
            raise pkex.BasePyKatException("{0} is not currently in the simulation".format(obj.name))
Daniel Brown's avatar
Daniel Brown committed
1053
            
1054
1055
        if obj.removed:
            raise pkex.BasePyKatException("{0} has already been removed".format(obj.name))        
Daniel Brown's avatar
Daniel Brown committed
1056
1057

        nodes = None
1058
        
Daniel Brown's avatar
Daniel Brown committed
1059
1060
1061
1062
        # store nodes that this componet is attached to as a reference for gui
        if isinstance(obj, Component):
            nodes = self.nodes.getComponentNodes(obj)

1063
1064
1065
        if isinstance(obj, Component):    
            del self.__components[obj.name]
            self.__del_component(obj)
1066
            self.nodes._removeComponent(obj)
1067
1068
1069
1070
1071
1072
        elif isinstance(obj, Command):    
            del self.__commands[obj.name]
            self.__del_command(obj)
        elif isinstance(obj, Detector):    
            del self.__detectors[obj.name]
            self.__del_detector(obj)
Daniel Brown's avatar
Daniel Brown committed
1073
1074
1075
1076
1077
        elif isinstance(obj, pykat.finesse.Signals):
            obj.remove()
        elif isinstance(obj, pykat.finesse.Signals.fsig):
            obj.remove()
            
1078
1079
1080
1081
        for b in self.__blocks:
            if obj in self.__blocks[b].contents:
                self.__blocks[b].contents.remove(obj)
        
Daniel Brown's avatar
Daniel Brown committed
1082
1083
1084
1085
1086
        if self.pykatgui != None:
            self.pykatgui._onComponentRemoved(obj, nodes)
    
        del nodes
        
1087
1088
        #import gc
        #print gc.get_referrers(obj)
1089
    
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
    def getMatrices(self):
        
        import scipy
        from scipy.sparse import coo_matrix
        
        prev = self.noxaxis
        
        self.noxaxis = True
        self.printmatrix = True
        print "".join(self.generateKatScript())
        self.verbose = True
        self.run(printout=1)
        self.printmatrix = None
        self.noxaxis = prev        
        
        if self.__prevrunfilename == None:
            return None
        else:
            
            Mcarrier = None
            Msignal = None
            
            if os.path.exists("klu_full_matrix_car.dat"):
                M = np.loadtxt("klu_full_matrix_car.dat")
                
                if M.size > 0:
                    row = M[:,0]-1
                    col = M[:,1]-1
                    data = M[:,2] + 1j * M[:,3]
                    N = row.max()+1
                    Mcarrier = coo_matrix((data,(row,col)), shape=(N,N))
                
        
            if os.path.exists("klu_full_matrix_sig.dat"):
                M = np.loadtxt("klu_full_matrix_sig.dat")
                
                if M.size > 0:
                    row = M[:,0]-1
                    col = M[:,1]-1
                    data = M[:,2] + 1j * M[:,3]
                    N = row.max()+1
                    Msignal = coo_matrix((data,(row,col)), shape=(N,N))
        
            return (Mcarrier, Msignal)

1135
    
1136
1137
    def hasNamedObject(self, name):
        return name in self.__components or name in self.__detectors or name in self.__commands
Daniel Brown's avatar
Daniel Brown committed
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
        
    def add(self, obj):
        try:
            obj.tag = self.__currentTag
            self.__blocks[self.__currentTag].contents.append(obj)
            
            if isinstance(obj, Component):
                
                if obj.name in self.__components :
                    raise pkex.BasePyKatException("A component with name '{0}' has already been added".format([obj.name]))            
                            
                self.__components[obj.name] = obj
                self.__add_component(obj)
                
            elif isinstance(obj, Detector):
                
                if obj.name in self.__detectors :
                        raise pkex.BasePyKatException("A detector '{0}' has already been added".format(obj.name))
                        
                self.__detectors[obj.name] = obj
                self.__add_detector(obj)
                
            elif isinstance(obj, Command):
                
                self.__commands[obj.__class__.__name__] = obj
                self.__add_command(obj)
                
1165
            else:
Daniel Brown's avatar
Daniel Brown committed
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
                raise pkex.BasePyKatException("Object {0} could not be added".format(obj))
                
            obj._on_kat_add(self)
            
        except pkex.BasePyKatException as ex:
            print ex

    def readOutFile(self, filename):
        
        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(',')
        
1182
1183
1184
1185
1186
1187
        data = np.loadtxt(filename, comments='%',skiprows=4)

        # convert 1D arrays into 2D ones for simpler selection
        if len(data.shape) == 1:
            data = np.array([data])
                            
1188
        if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
            # 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]
            # get rows and columns lined up so that we can reshape a single column of all x/y data
            # into a matrix
            z = data[:,2:].transpose().reshape(data.shape[1]-2, 1+self.xaxis.steps, 1+self.x2axis.steps)
            # once you do this the data for y and x axes need swapping
            z = z.swapaxes(1,2)
            return [x, y, z, hdr]
        else:
            shape_len = len(data.shape)
            
1202
            rows,cols = data.shape
Daniel Brown's avatar
Daniel Brown committed
1203
            
1204
1205
1206
            x = data[:,0]
            y = data[:,1:cols]
        
Daniel Brown's avatar
Daniel Brown committed
1207
            return [x, y, hdr]
1208
1209

    def removeLine(self, fragment) :
1210
1211
1212
1213
1214
1215
1216
        """
        This will search all blocks by default and search for the string
        fragment specified and remove it. This will only remove non-parsed
        commands, it will not remove commands that have already been parsed
        into the pykat structure, such as mirrors and beamsplitters, use the
        kat.remove(...) function for that purpose.
        """
1217
1218
1219
1220
1221
1222
1223
        for key in self.__blocks:
            objs = self.__blocks[key].contents
            for obj in objs:
                if isinstance(obj, str):
                    if fragment in obj:
                        print "  ** removing line '{0}'".format(obj)
                        objs.remove(obj)
1224

1225
1226
1227
1228
1229
1230
1231
    def addLine(self, line, block=NO_BLOCK) :
        """
        This will forcefully add a line of FINESSE code to a particular block
        if specfied. This command will not undergo any parsing so it will remain
        as just a string. This of course can create possible conflicts with other
        pykat object that create similar commands so becareful.
        """
Daniel Brown's avatar
Daniel Brown committed
1232
        self.__blocks[block].contents.append(line)
1233
                        
Daniel Brown's avatar
Daniel Brown committed
1234
1235
    def generateKatScript(self) :
        """ Generates the kat file which can then be run """
1236

1237
        def writeBlock():
Daniel Brown's avatar
Daniel Brown committed
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
            for obj in objs:
                if isinstance(obj, str):
                    out.append(obj + '\n')
                    
                elif isinstance(obj, Component) or isinstance(obj, Detector) or isinstance(obj, Command):
                    txt = obj.getFinesseText() 
                    
                    if txt != None:
                        if isinstance(txt,list):
                            for t in txt:
                                out.append(t + "\n")
                        else:
                            out.append(txt + "\n")
1251

1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
        
        out = []    
        import datetime
        strtoday = datetime.datetime.now()
        out.append(strtoday.strftime("%% Generated by PyKat %d.%m.%Y %H:%M:%S\n") )

        # write the FTblocks
        for key in self.__blocks:
            objs = self.__blocks[key].contents

1262
            if key != NO_BLOCK:
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
                if np.size(objs)>0:
                    out.append("\n")
                    out.append("%%% FTblock " + key + "\n")
                    writeBlock()
                    out.append("%%% FTend " + key + "\n")

        # write the NO_BLOCK blocks
        for key in self.__blocks:
            objs = self.__blocks[key].contents


            if key == NO_BLOCK:
                if np.size(objs)>0:
                    out.append("\n")
                    writeBlock()
                
Daniel Brown's avatar
Daniel Brown committed
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
        # 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: