finesse.py 101 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
# -*- 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
"""
26
27
28
29
30
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals

Daniel Brown's avatar
Daniel Brown committed
31
import warnings
32
import codecs
33
import uuid
Daniel Brown's avatar
Daniel Brown committed
34
35
36
37
38
39
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
40
import time
Daniel Brown's avatar
Daniel Brown committed
41
42
43
import pickle
import pykat
import warnings
44
45
import re
import math       
Daniel Brown's avatar
Daniel Brown committed
46
import itertools
Daniel Brown's avatar
Daniel Brown committed
47
import ctypes
Daniel Brown's avatar
Daniel Brown committed
48
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
49
import collections
50
import re
51
import copy
52

53
54
from subprocess import Popen, PIPE

55
56
57
58
59
60
try:
    # Python 2
    from itertools import izip_longest
except ImportError:
    # Python 3
    from itertools import zip_longest as izip_longest
Daniel Brown's avatar
Daniel Brown committed
61
62
63
64
65
66
67
68


try:
    # Add exception in Python 2
    FileNotFoundError
except NameError:
    FileNotFoundError = IOError
    
69
70
71
72
73
74
75
76
77
78
"""
try:
    from future_builtins import zip_longest
except ImportError: # not 2.6+ or is 3.x
    try:
        from itertools import izip_longest as zip_longest # < 2.5 or 3.x
    except ImportError:
        print("boom")
        pass
"""
79
80

from math import erfc, pi
81
from collections import namedtuple, OrderedDict
82

Daniel Brown's avatar
Daniel Brown committed
83
from pykat.node_network import NodeNetwork
84
from pykat.detectors import BaseDetector as Detector
Daniel Brown's avatar
Daniel Brown committed
85
86
from pykat.components import Component
from pykat.commands import Command, xaxis
87
from pykat.SIfloat import *
88
from pykat.param import Param, AttrParam
89
from pykat.external import progressbar
Daniel Brown's avatar
Daniel Brown committed
90

91
92
import pykat.external.six as six

Daniel Brown's avatar
Daniel Brown committed
93
94
import pykat.exceptions as pkex

95
96
97
98
99
100
101
from pykat import USE_GUI, HAS_OPTIVIS, NoGUIException

    
if HAS_OPTIVIS:
    from optivis.bench.labels import Label as optivis_label
    from optivis.geometry import Coordinates as optivis_coord
    import PyQt4
102
103
104
105
106

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
107

Daniel Brown's avatar
Daniel Brown committed
108
109
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
110
NO_BLOCK = "NO_BLOCK"
111
112
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
113
114
115
116
117
118
119
# 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
120
121
122
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
123
    
124
    if lkat_location is None:
Daniel Brown's avatar
Daniel Brown committed
125
126
127
        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
128
129
130
131
132
133
134
135
136
137
138
139
140

    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: 
141
        print ("Exception caught in python: ", ex.message)
Daniel Brown's avatar
Daniel Brown committed
142
143
144
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
145
146


147
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
148
149
150
151
152
153
154
155
156
157
158
159
    """
    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()

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
    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
187
188
                                )

189
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
190

191
192
193
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
194

195
196
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
197
198
                                                 

Daniel Brown's avatar
Daniel Brown committed
199
200

class BlockedKatFile(object):
201
    """
Daniel Brown's avatar
Daniel Brown committed
202
203
204
205
206
207
208
209
210
    Allows manipulation of blocked kat file.
    
    Example:
        bkf = BlockedKatFile()
        
        bkf.read(katfile)
        bkf.add('tester', "blah\nblah", addAfter="Tunings")
        bkf.remove("Laser")
        bkf.write("mytest.kat")
211
    """
Daniel Brown's avatar
Daniel Brown committed
212
    
Daniel Brown's avatar
Daniel Brown committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    def __init__(self, NO_BLOCK="NO_BLOCK"):
        self.__NO_BLOCK = NO_BLOCK
        self.ordering = [self.__NO_BLOCK]
        self.blocks = {self.__NO_BLOCK:""}
        self.__currentBlock = self.__NO_BLOCK
        
    def remove(self, block):
        if block not in self.ordering or block not in self.blocks:
            raise Exception("%s block not found")
        
        self.ordering.remove(block)
        self.blocks.pop(block)
        
    def add(self, block, contents, addAfter=None):
Daniel Brown's avatar
Daniel Brown committed
227

Daniel Brown's avatar
Daniel Brown committed
228
229
        if block in self.ordering or block in self.blocks:
            raise Exception("%s block already present")
Daniel Brown's avatar
Daniel Brown committed
230
    
Daniel Brown's avatar
Daniel Brown committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
        if addAfter is not None:
            self.ordering.insert(self.ordering.index(addAfter)+1, block)
        else:
            self.ordering.append(block)
            
        self.blocks[block] = contents + "\n"
        
    def write(self, katfile):
        with open(katfile, "w") as f:
            for block in self.ordering:
                f.write("\n%%% FTblock " + block + "\n")
                f.write(self.blocks[block])
                f.write("%%% FTend " + block + "\n")
    
    def read(self, katfile):
        """
        For a given kat file, the blocks are parsed into dictionary as raw strings.
        """
    
        with open(katfile, "r") as f:
            commands = f.readlines()
    
        for line in commands:
            line = line.strip()
Daniel Brown's avatar
Daniel Brown committed
255

Daniel Brown's avatar
Daniel Brown committed
256
257
            # Looking for block start or end
            values = line.split()
Daniel Brown's avatar
Daniel Brown committed
258
    
Daniel Brown's avatar
Daniel Brown committed
259
260
261
            if len(values) >= 3 and values[0] == "%%%":
                if values[1] == "FTblock":
                    newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
262

Daniel Brown's avatar
Daniel Brown committed
263
264
                    if self.__currentBlock != None and self.__currentBlock != self.__NO_BLOCK: 
                        warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentBlock))    
Daniel Brown's avatar
Daniel Brown committed
265
    
Daniel Brown's avatar
Daniel Brown committed
266
267
                    if newTag in self.blocks:
                        raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
268
    
Daniel Brown's avatar
Daniel Brown committed
269
270
271
272
273
274
                    self.blocks[newTag] = ""
                    self.__currentBlock = newTag
                    self.ordering.append(newTag)
                
                if values[1] == "FTend":
                    self.__currentBlock = self.__NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
275
        
Daniel Brown's avatar
Daniel Brown committed
276
277
278
279
                continue
                
            if(len(line) == 0 and (self.__currentBlock == self.__NO_BLOCK)):
                continue
Daniel Brown's avatar
Daniel Brown committed
280
        
Daniel Brown's avatar
Daniel Brown committed
281
            self.blocks[self.__currentBlock] += line + "\n"
Daniel Brown's avatar
Daniel Brown committed
282
283
284
    
    
class KatBatch(object):
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
    
    def __init__(self):
        from IPython.parallel import Client

        self._c = Client()
        self._lb = c.load_balanced_view()
        self.lb.block = False
        
        self._todo = []
    
    def _run(dir, commands, **kwargs):
        import pykat
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(commands)
        
        kw = dict()
        
        if "cmd_args" in kwargs:
            kw["cmd_args"] = kwargs["cmd_args"]
        
306
        return kat.run(**kw)
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
    
    def addKat(self, kat, **kwargs):
        import os
        cdir = os.getcwd()
        script = "\n".join(kat.generateKatScript())
        self.todo.append(self.lb.apply_async(self._run, script, **kwargs))
        return self.todo[-1]
    
    def wait(self):
        return self.lb.wait(self.todo)
        
    def results(self):
        return self.todo

                                  
322
323
324
325
326
327
def GUILength(L):
    """
    Should scale the lengths in some way to handle km and mm for time being
    """
    return L # * ( 40 * erfc(L/400.0) + 0.01)
            
328
class KatRun(object):
Daniel Brown's avatar
Daniel Brown committed
329
    def __init__(self):
330
331
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
332
333
334
335
336
337
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
338
        self.yaxis = None
339
        
Daniel Brown's avatar
Daniel Brown committed
340
341
342
343
344
345
346
347
348
    def info(self):
        
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)
        
        detectors = list(set([lbl.split()[0] for lbl in self.ylabels]))
        detectors.sort()
        
349
        print("")
Daniel Brown's avatar
Daniel Brown committed
350
        print("--- Output info ---")
351
        print("")
Daniel Brown's avatar
Daniel Brown committed
352
353
        print("Run date and time: %s" % self.StartDateTime)
        print("Detectors used: %s" % (", ".join(detectors)))
354
355
        print("")

Daniel Brown's avatar
Daniel Brown committed
356
357
358
359
        if kat.noxaxis:
            print("No xaxis used")
        else:
            print("One xaxis used: %s" % kat.xaxis.getFinesseText())
360
361
362
363
364
365
366
367
368
369
370
            
        import numpy as np

        maxs = np.max(self.y, 0)
        mins = np.min(self.y, 0)
        
        maxlbl = max([len(lbl) for lbl in self.ylabels])    
        
        for i, lbl in enumerate(self.ylabels):
            a = "{0:" + str(maxlbl) + "} : min = {1:.15e} max = {2:.15e}"
            print(a.format(lbl, mins[i], maxs[i]))
Daniel Brown's avatar
Daniel Brown committed
371
372
        
        
Daniel Brown's avatar
Daniel Brown committed
373
374
    def plot(self, detectors=None, filename=None, show=True,
                   yaxis=None, legend=True, loc=0, title=None, styles=None,
375
376
                   ylabel=None, y2label=None, xlabel=None, x2label=None,
                   xlim=None, x2lim=None, ylim=None, y2lim=None):
377
378
379
380
381
382
383
384
        """
        This will generate a plot for the output data of this particular pykat run.
        It will attempt to generate a plot that shows all the various traces and plots
        by default for quick viewing of the data. Similar to that which would be
        generated by running the Finesse file from the command line.
        
        There are some additional keyword options to customise the plot output slightly:
        
Daniel Brown's avatar
Daniel Brown committed
385
386
387
388
389
390
391
392
393
394
395
396
            detectors:          a list of detectors that you want to plot
            filename:           providing a filename here will save the plot to a file.
                                The format is given by the extension provided.
            show:               True | False - whether to display the plot or not
            yaxis:              Set the Finesse yaxis command to base the plot on. By
                                default the original one will be used.
            legend:             True | False - whether to include a legend
            loc:                Location value for the legend, the usual matplotlib one.
            title:              Provide a title for the plot if required.
            styles:             A dictionary which keys being the detector names and the
                                value being a colour and linestyle of the sort 'k:'
            ylabel, xlabel:     Text for the first plot x and y labels
397
398
399
400
401
402
            y2label, x2label:   Text for the second plot x and y labels

            xlim, ylim:         Limits of x- and y-axes of the first plot. List or tuple
                                of length 2.
            x2lim, y2lim:       Limits of x- and y-axes of the second plot. List or tuple
                                of length 2.
403
        """
404
405
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt
406
            
Daniel Brown's avatar
Daniel Brown committed
407
408
409
        if not show:
            pyplot.ioff()

410
411
412
413
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)

414
415
416
        if kat.noxaxis == True:
            raise  pkex.BasePyKatException("This kat object has noxaxis=True, so there is nothing to plot.")

417
418
        original_yaxis = kat.yaxis

419
420
        if yaxis is not None:
            kat.yaxis = yaxis
421
422
423
424
425
426
427
428
429
430
431
432
433

        if "log" in kat.yaxis:
            if kat.xaxis.scale == "log":
                plot_cmd = pyplot.loglog
            else:
                plot_cmd = pyplot.semilogy
        else:
            if kat.xaxis.scale == "log":
                plot_cmd = pyplot.semilogx
            else:
                plot_cmd = pyplot.plot

        dual_plot = False
Daniel Brown's avatar
Daniel Brown committed
434
435
        _func1 = np.abs
        _func2 = None
436

437
438
439
        plot_cmd1 = None
        plot_cmd2 = None
        
Daniel Brown's avatar
Daniel Brown committed
440
441
442
        if "re:im" in kat.yaxis:
            _func1 = np.real
            _func2 = np.imag
443
444
            plot_cmd1 = plot_cmd2 = plot_cmd
            
Daniel Brown's avatar
Daniel Brown committed
445
446
447
448
            dual_plot = True
        elif "abs:deg" in kat.yaxis:
            _func1 = np.abs
            _func2 = lambda x: np.rad2deg(np.angle(x))
449
450

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
451
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
452
            
Daniel Brown's avatar
Daniel Brown committed
453
454
            dual_plot = True
        elif "db:deg" in kat.yaxis:
455
456
457
458
459
            if "db" not in original_yaxis:
                _func1 = lambda x: 10*np.log10(x)
            else:
                _func1 = lambda x: x
                
Daniel Brown's avatar
Daniel Brown committed
460
            _func2 = lambda x: np.rad2deg(np.angle(x))
461
462

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
463
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
464
            
465
            dual_plot = True
Daniel Brown's avatar
Daniel Brown committed
466
        elif "abs" in kat.yaxis:
467
468
            # _func1 = np.abs
            _func1 = np.real
469
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
470
        elif "db" in kat.yaxis:
471
472
473
474
475
            if "db" not in original_yaxis:
                _func1 = lambda x: 10*np.log10(x)
            else:
                _func1 = lambda x: x
                
476
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
477
478
        elif "deg" in kat.yaxis:
            _func1 = lambda x: np.rad2deg(np.angle(x))
479
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
480
481
482
            
        if dual_plot:
            fig = plt.figure(width="full", height=1)
483
        else:
Daniel Brown's avatar
Daniel Brown committed
484
            fig = plt.figure(width="full")   
485

486
487
488
489
490
491
492
        if detectors is None:
            detectors = [lbl.split()[0] for lbl in self.ylabels]
            
        detectors = list(set(detectors))
        detectors.sort()
        
        for det in detectors:
Daniel Brown's avatar
Daniel Brown committed
493
            if not hasattr(kat, det) or (hasattr(kat, det) and not getattr(kat, det).noplot):
494
                
Daniel Brown's avatar
Daniel Brown committed
495
                if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
496
                    ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
497
498
499
500
                    
                if styles is not None and det in styles:
                    l, = plot_cmd1(self.x, _func1(self[det]), styles[det], label=det)
                else:
501
                    l, = plot_cmd1(self.x, _func1(self[det]), label=det)
Daniel Brown's avatar
Daniel Brown committed
502
503
                
                if dual_plot: 
504
505
                    pyplot.subplot(2,1,2)
                    plot_cmd2(self.x, _func2(self[det]), color=l.get_color(), ls=l.get_linestyle(), label=det)
506

Daniel Brown's avatar
Daniel Brown committed
507
508
509
510
        if dual_plot:
            if ylabel is None:
                if "abs" in kat.yaxis: ylabel = "Absolute [au]"
                if "re" in kat.yaxis:  ylabel = "Real part [au]"
511
                    
Daniel Brown's avatar
Daniel Brown committed
512
513
514
            if y2label is None:
                if "deg" in kat.yaxis: y2label = "Phase [deg]"
                if "im" in kat.yaxis:  y2label = "Imaginary part [au]"
515
516
517
518
519
520
521
                    
            if xlim is None:
                xlim = (self.x.min(), self.x.max())
                
            if x2lim is None:
                 x2lim = (self.x.min(), self.x.max())
                 
Daniel Brown's avatar
Daniel Brown committed
522
523
524
        else:
            if ylabel is None:
                ylabel = "[au]"
525
526
527
528
                
            if xlim is None:
                xlim = (self.x.min(), self.x.max())
            
Daniel Brown's avatar
Daniel Brown committed
529
        
Daniel Brown's avatar
Daniel Brown committed
530
531
532
533
534
535
        if xlabel is None:
            xlabel = self.xlabel
            
        if x2label is None:
            x2label = self.xlabel
            
Daniel Brown's avatar
Daniel Brown committed
536
537
        font_label_size = pyplot.rcParams["font.size"]-1
        
538
        if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
539
            ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
540
541
            pyplot.xlabel(xlabel, fontsize=font_label_size)
            pyplot.ylabel(ylabel, fontsize=font_label_size)
542
543
544
545
            pyplot.xlim(xlim[0], xlim[1])
            if ylim is not None:
                pyplot.ylim(ylim[0],ylim[1])

Daniel Brown's avatar
Daniel Brown committed
546
547
            if title is not None:
                pyplot.title(title, fontsize=font_label_size)
548
549
    
            pyplot.subplot(2,1,2)
Daniel Brown's avatar
Daniel Brown committed
550
551
            pyplot.xlabel(x2label, fontsize=font_label_size)
            pyplot.ylabel(y2label, fontsize=font_label_size)
552
553
554
555
556
        
            pyplot.xlim(x2lim[0], x2lim[1])
            if y2lim is not None:
                pyplot.ylim(y2lim[0],y2lim[1])
            
557
        else:
Daniel Brown's avatar
Daniel Brown committed
558
559
            pyplot.xlabel(xlabel, fontsize=font_label_size)
            pyplot.ylabel(ylabel)
560
            pyplot.xlim(self.x.min(), self.x.max())
Daniel Brown's avatar
Daniel Brown committed
561
562
563
            
            if title is not None:
                pyplot.title(title, fontsize=font_label_size)
564
565
            if ylim is not None:
                pyplot.ylim(ylim[0],ylim[1])
566
    
567
        pyplot.margins(0, 0.05)
568
        pyplot.tight_layout()
569
    
570
        if legend:
Daniel Brown's avatar
Daniel Brown committed
571
            fig.axes[0].legend(loc=loc, fontsize=font_label_size)
572
573
574
575
576
577
        
        if filename is not None:
            fig.savefig(filename)
            
        if show:
            pyplot.show(fig)
Daniel Brown's avatar
Daniel Brown committed
578
            pyplot.ion()
579
580
        
        return fig
Daniel Brown's avatar
Daniel Brown committed
581
        
582
    def saveKatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
583
584
585
586
587
588
589
590
591
592
593
        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):
594
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
595
596
        out = None
        
597
        if len(idx) > 0:
598
            #out = self.y[:, idx]
599
            
600
            if len(idx) == 1:
Daniel Brown's avatar
Daniel Brown committed
601
                if "abs:deg" in self.yaxis:
602
                    out = self.y[:, idx[0]]
Daniel Brown's avatar
Daniel Brown committed
603
                elif "re:im" in self.yaxis:
604
605
                    out = self.y[:, idx[0]]
            else: 
Daniel Brown's avatar
Daniel Brown committed
606
                if "abs:deg" in self.yaxis:
607
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
Daniel Brown's avatar
Daniel Brown committed
608
                elif "re:im" in self.yaxis :
609
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
610

611
            if out is None:
612
613
                out = self.y[:, idx]

614
            if out.size == 1:
615
                return out[0].squeeze()
616
            else:
617
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
618
        else:
619
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
620
      
621
class KatRun2D(object):
Daniel Brown's avatar
Daniel Brown committed
622
    def __init__(self):
623
        self.runtime = None
624
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
625
626
627
628
629
630
631
632
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
633
634
        self.stderr = None
        self.stdout = None
Daniel Brown's avatar
Daniel Brown committed
635
636
637
638
639
640
641
642
643
644
        
    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)
    
645
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
646
647
    
    def __getitem__(self, value):
648
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
649
650
651
652
653
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
654
    
655
        
656
657
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
658
        def __init__(self, param, name, amplitude, phase, signal):
659
660
661
662
663
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
664
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
665
            self.__signal = signal
666
            
667
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
668
            # various parameter names of the components, e.g. mirror xbeta is x 
669
670
671
            # 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:
672
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
673
674
675
            
        def _register_param(self, param):
            self._params.append(param)
676
677
678
        
        @property
        def removed(self): return self.__removed
679
  
680
        def remove(self):
681
682
683
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
684
685
686
            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
687
688
                self.__signal.targets.remove(self)
                self.__remove = True
689
        
690
691
692
693
694
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
695
696
697
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

698
699
700

        @property
        def phase(self): return self.__phase
701
702
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
703
704
705
706
707

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

        @property
708
        def owner(self): return self.__target._owner().name
709
710
711
712
713
714
715
716
717
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
718
    
719
720
721
722
723
724
725
    @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:
726
            return self._default_name
727
728
        else:
            return self.targets[0].name
729
730
            
    @property
Daniel Brown's avatar
Daniel Brown committed
731
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
732

733
734
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
735
            t.remove()
736
737
738
        
        del self.targets[:]
        
739
740
    @property
    def f(self): return self.__f
741
    @f.setter
742
743
744
745
746
747
748
    def f(self,value):
        v = SIfloat(value)
        
        if v <= 0:
            raise pkex.BasePyKatException("Signal frequency must be greater than 0.")
            
        self.__f.value = SIfloat(value)
749
    
Daniel Brown's avatar
Daniel Brown committed
750
    def __init__(self, kat):
751
        self._default_name = "fsignal"
752
753
        self.targets = []
        self._params = []
754
        self.__f = Param("f", self, None)
755
756
        self._kat = kat
        
757
758
759
760
761
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
762
        if target is None:
763
764
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
765
        if name is None:
766
            name = "sig_" + target._owner().name + "_" + target.name
767
        
Daniel Brown's avatar
Daniel Brown committed
768
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
769
770
771
772
        
    def getFinesseText(self):
        rtn = []
        
773
774
775
776
777
778
779
780
        if self.f.value is not None and self.f is not None:
            if len(self.targets) == 0:
                rtn.append("fsig {name} {frequency}"
                                .format(name = self.name,
                                        frequency=str(self.f.value)))
            else:
                for t in self.targets:
                    rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
781
            
782
783
784
785
786
787
788
                    rtn.append("fsig {name} {comp} {target} {frequency} {phase} {amplitude}"
                                    .format(name = t.name,
                                            comp=t.owner,
                                            target=t.target,
                                            frequency=str(self.f.value),
                                            phase=str(t.phase),
                                            amplitude=str(t.amplitude if t.amplitude != None else "")))
Daniel Brown's avatar
Daniel Brown committed
789

790
791
792
793
794
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
795
796
797
798
799
800
801
802
803
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
    
804
Constant = namedtuple('Constant', 'name, value, usedBy')
805
806
807

id___ = 0

808
class kat(object):  
809

810
811
812
813
814
815
816
817
818
    def __new__(cls, *args, **kwargs):
        # This may seem like an arbitrary step but here we are creating a
        # new class that is a base class of itself. This is because when
        # the kat object adds new components it also adds properties for
        # each of these. There properties are unique to each kat object,
        # but properties are part of the class definition. Thus if two
        # kat objects share the same class definition they also have the
        # same properties regardless of whether they have the actual
        # object added to it. So we create an instance specific class.
819
820
821
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
822
823
        return object.__new__(cnew)
    
824
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
825
826

        self.__looking = False
Daniel Brown's avatar
Daniel Brown committed
827
828
        self.scene = None # scene object for GUI
        self.verbose = True
829
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
830
831
832
833
834
835
836
837
838
839
        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
840
        self.__signals = Signals(self)
841
        self.constants = {}
842
        self.vacuum = []
843
844
        self.__prevrunfilename = None
        self.printmatrix = None
845
        self.__variables = {}
846
847
848
849
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
850
851
852
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
853
854
        self.retrace = None
        self.deriv_h = None
855
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
856
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
857
858
        self.__phase = None
        self.__maxtem = None
859
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
860
        self.__time_code = None
861
        self.__yaxis = "abs" # default yaxis
862
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
863
864
865
866
867
868
869
870
871
        
        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)
872

Daniel Brown's avatar
updates    
Daniel Brown committed
873
874
875
    def deepcopy(self):
        return copy.deepcopy(self)
    
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
    def getAll(self, type):
        """
        Returns a collection of all objects of the type argument that are
        part of this kat object.
        
        Example:
            # returns all cav commands that are present in this kat object
            cavs = kat.getAll(pykat.commands.cavity)
        """
        items = []
        
        for a in (item for item in self.__class__.__dict__):
            b = getattr(self, a)
            
            if isinstance(b, type):
                items.append(b)

        return tuple(items)
        
895
    def __deepcopy__(self, memo):
896
897
898
899
900
901
902
903
904
905
        """
        When deep copying a kat object we need to take into account
        the instance specific properties. This is because when
        the kat object adds new components it also adds properties for
        each of these. There properties are unique to each kat object,
        but properties are part of the class definition. Thus if two
        kat objects share the same class definition they also have the
        same properties regardless of whether they have the actual
        object added to it. So we create an instance specific class.
        """
Daniel Brown's avatar
updates    
Daniel Brown committed
906
        result = self.__class__.__new__(self.__class__.__base__)
907
        memo[id(self)] = result
908
909
910
911
912
913
914
915
916
917
        result.__dict__ = copy.deepcopy(self.__dict__, memo)

        # Find all properties in class we are copying
        # and deep copy these to the new class instance
        for x in self.__class__.__dict__.items():
            if isinstance(x[1], property):
                setattr(result.__class__, x[0], x[1])
    
        result.nodes._NodeNetwork__update_nodes_properties()
                
918
919
920
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
921
        
922
923
        return result
    
924
925
926
    @property
    def signals(self): return self.__signals

927
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
Daniel Brown's avatar
Daniel Brown committed
928
    
929
930
931
932
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
Daniel Brown's avatar
Daniel Brown committed
933
934
935
936
937
938
939
940
        values = value.split()
        
        if len(values) == 2:
            scale = values[0]
            mode = values[1]
        else:
            scale = "lin"
            mode = value
941
        
Daniel Brown's avatar
Daniel Brown committed
942
943
944
945
946
        if not str(scale) in ["lin", "log"]:
            raise pkex.BasePyKatException("yaxis value '{0}' is not a valid option. Valid options are: lin or log".format(str(mode)))
                
        if not str(mode) in self.yaxis_options:
            raise pkex.BasePyKatException("yaxis value '{0}' is not a valid option. Valid options are: {1}".format(str(mode), ",".join(self.yaxis_options) ))
947
            
Daniel Brown's avatar
Daniel Brown committed
948
        self.__yaxis = str(scale + " " + mode).strip()
949

Sean Leavey's avatar
Sean Leavey committed
950
951
952
953
954
955
956
957
958
959
960
    @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

961
962
963
964
965
966
967
968
969
970
    @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
971
972
973
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
974
975
976
977
978
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
979
980
981
982
983
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
984
        
Daniel Brown's avatar
Daniel Brown committed
985
    @property
986
987
988
    def timeCode(self): return self.__time_code
    @timeCode.setter
    def timeCode(self,value): self.__time_code = bool(value)
Daniel Brown's avatar
Daniel Brown committed
989
    
Daniel Brown's avatar
Daniel Brown committed
990
991
992
993
994
995
996
997
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
998
999
1000
1001
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
1002
1003
1004
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
1005
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
1006

1007
1008
    @staticmethod
    def logo():
1009
        print ("""                                              ..-
1010
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
1011
1012
1013
1014
1015
1016
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
1017
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
1018
    
1019
    def loadKatFile(self, katfile, blocks=None):
1020
1021
1022
        with open(katfile) as f:
            commands= f.read()
            
1023
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
1024
    
1025
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
1026
        warnings.warn('parseKatCode depreciated, use parseCommands.', stacklevel=2)
Daniel Brown's avatar
typo    
Daniel Brown committed
1027
        self.parseCommands(code, blocks=blocks)
1028
1029
1030
1031
1032
1033
1034

    def processConstants(self, commands):
        """
        Before fully parsing a bunch of commands firstly any constants or variables
        to be recorded and replaced.
        """
        
Daniel Brown's avatar
Daniel Brown committed
1035
1036
1037
1038
1039
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
1040
            
Daniel Brown's avatar
Daniel Brown committed
1041
                if len(values)>0 and values[0] == 'const':
1042
                
Daniel Brown's avatar
Daniel Brown committed
1043
1044
1045
1046
1047
                    if len(values) >= 3:
                        if values[1] in constants:
                            raise pkex.BasePyKatException('const command with the name "{0}" already used'.format(values[1]))
                        else:
                            constants[str(values[1])] = Constant(values[1], values[2], [])
1048
                    else:
Daniel Brown's avatar
Daniel Brown committed
1049
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
1050
        
Daniel Brown's avatar
Daniel Brown committed
1051
            commands_new = []
1052
        
Daniel Brown's avatar
Daniel Brown committed
1053
1054
            for line in commands:
                values = line.split()
1055
            
Daniel Brown's avatar
Daniel Brown committed
1056
1057
1058
1059
1060
                if len(values) > 0 and values[0] != 'const':
                    # check if we have a var/constant in this line
                    if line.find('$') >= 0:
                        for key in constants.keys():
                            # TODO: need to fix this for checking mulitple instances of const in a single line
1061
                        
Daniel Brown's avatar
Daniel Brown committed
1062
                            chars = [' ', '+', '-', '*', '/', ')']
1063

Daniel Brown's avatar
Daniel Brown committed
1064
1065
                            for c in chars:
                                none_found = False
1066
                            
Daniel Brown's avatar
Daniel Brown committed
1067
1068
1069
1070
1071
1072
                                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
1073
                        
Daniel Brown's avatar
Daniel Brown committed
1074
1075
1076
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
1077
                        
Daniel Brown's avatar
Daniel Brown committed
1078
                    commands_new.append(line)
1079
    
Daniel Brown's avatar
Daniel Brown committed
1080
            self.constants = constants
1081
        
Daniel Brown's avatar
Daniel Brown committed
1082
1083
1084
1085
1086
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
1087
    
Daniel Brown's avatar
updates    
Daniel Brown committed
1088
1089
1090
1091
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
1092
1093
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
1094
1095
1096
1097
1098
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
1099
        
1100
        for o in list(self.__blocks[name].contents):
1101
1102
1103
            self.remove(o)
        
        del self.__blocks[name]
1104
1105
1106
1107
    
    def __str__(self):
         return "".join(self.generateKatScript())
         
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
    def getVariable(self, name):
        if name not in self.__variables:
            raise pkex.BasePyKatException("Finesse variable `$%s` does not exist." % name)
            
        return self.__variables[name]
    
    def registerVariable(self, name, putter):
        if '$' in name:
            raise pkex.BasePyKatException("Finesse variable name `%s` should not include the `$` symbol as it is added internally." % name)
            
        assert(putter is not None)
        assert(name == putter.name)
        
        if name in self.__variables:
            raise pkex.BasePyKatException("Finesse variable name `%s` already exists." % name)
            
        self.__variables[name] = putter
        
    def unregisterVariable(self, name):
        del self.__variables[name]
    
    def printVariables(self):
        for key in self.__variables:
            print("$" + key, "::::", "owner =", self.__variables[key].owner.name, ", use count =", self.__variables[key].putCount)
    
Daniel Brown's avatar
Daniel Brown committed
1133
    def parseCommands(self, commands, blocks=None, addToBlock=None, preserve=False):
1134
        try:
1135
1136
1137
1138
1139
1140
1141
1142
            if addToBlock is not None and blocks is not None:
                raise pkex.BasePyKatException("When parsing commands you cannot set both blocks and addToBlock arguments")
            
            # Create a new block if one asked for isn't present
            if addToBlock is not None:
                if addToBlock not in self.__blocks:
                    self.__blocks[addToBlock] = Block(addToBlock)
                
1143
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
1144
        
1145
            commands=self.remove_comments(commands)
1146
        
1147
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
1148
        
1149
1150
1151
            # Some commands need to be processed after others, and some after that.
            # Here we have two lists of processing priority.
            after_process = ([], [])
Daniel Brown's avatar
Daniel Brown committed
1152
        
1153
            for line in commands:
1154
1155
1156
1157
1158
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
1159
                    
1160
1161
1162
1163
1164
1165
1166
                    if addToBlock is None:
                        if values[0] == "%%%":
                            if values[1] == "FTblock":
                                newTag = values[2]
                    
                                if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
                                    warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
1167