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
    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
        
219
220
221
222
223
    def remove(self, *blocks):
        if len(blocks[0]) > 1 and not isinstance(blocks[0], six.string_types):
            # if we've got an iterable thing that isn't a string, eg list or tuple
            # just use that
            blocks = blocks[0]
Daniel Brown's avatar
Daniel Brown committed
224
        
225
226
227
228
229
230
231
        for block in blocks:
            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)
            
Daniel Brown's avatar
Daniel Brown committed
232
    def add(self, block, contents, addAfter=None):
Daniel Brown's avatar
Daniel Brown committed
233

Daniel Brown's avatar
Daniel Brown committed
234
235
        if block in self.ordering or block in self.blocks:
            raise Exception("%s block already present")
Daniel Brown's avatar
Daniel Brown committed
236
    
Daniel Brown's avatar
Daniel Brown committed
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
        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
261

Daniel Brown's avatar
Daniel Brown committed
262
263
            # Looking for block start or end
            values = line.split()
Daniel Brown's avatar
Daniel Brown committed
264
    
Daniel Brown's avatar
Daniel Brown committed
265
266
267
            if len(values) >= 3 and values[0] == "%%%":
                if values[1] == "FTblock":
                    newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
268

Daniel Brown's avatar
Daniel Brown committed
269
270
                    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
271
    
Daniel Brown's avatar
Daniel Brown committed
272
273
                    if newTag in self.blocks:
                        raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
274
    
Daniel Brown's avatar
Daniel Brown committed
275
276
277
278
279
280
                    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
281
        
Daniel Brown's avatar
Daniel Brown committed
282
283
284
285
                continue
                
            if(len(line) == 0 and (self.__currentBlock == self.__NO_BLOCK)):
                continue
Daniel Brown's avatar
Daniel Brown committed
286
        
Daniel Brown's avatar
Daniel Brown committed
287
            self.blocks[self.__currentBlock] += line + "\n"
Daniel Brown's avatar
Daniel Brown committed
288
289
290
    
    
class KatBatch(object):
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
    
    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"]
        
312
        return kat.run(**kw)
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    
    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

                                  
328
329
330
331
332
333
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)
            
334
class KatRun(object):
Daniel Brown's avatar
Daniel Brown committed
335
    def __init__(self):
336
337
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
338
339
340
341
342
343
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
344
        self.yaxis = None
345
        
Daniel Brown's avatar
Daniel Brown committed
346
347
348
349
350
351
352
353
354
    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()
        
355
        print("")
Daniel Brown's avatar
Daniel Brown committed
356
        print("--- Output info ---")
357
        print("")
Daniel Brown's avatar
Daniel Brown committed
358
359
        print("Run date and time: %s" % self.StartDateTime)
        print("Detectors used: %s" % (", ".join(detectors)))
360
361
        print("")

Daniel Brown's avatar
Daniel Brown committed
362
363
364
365
        if kat.noxaxis:
            print("No xaxis used")
        else:
            print("One xaxis used: %s" % kat.xaxis.getFinesseText())
366
367
368
369
370
371
372
373
374
375
376
            
        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
377
378
        
        
Daniel Brown's avatar
Daniel Brown committed
379
380
    def plot(self, detectors=None, filename=None, show=True,
                   yaxis=None, legend=True, loc=0, title=None, styles=None,
381
382
                   ylabel=None, y2label=None, xlabel=None, x2label=None,
                   xlim=None, x2lim=None, ylim=None, y2lim=None):
383
384
385
386
387
388
389
390
        """
        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
391
392
393
394
395
396
397
398
399
400
401
402
            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
403
404
405
406
407
408
            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.
409
        """
410
411
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt
412
            
Daniel Brown's avatar
Daniel Brown committed
413
414
415
        if not show:
            pyplot.ioff()

416
417
418
419
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)

420
421
422
        if kat.noxaxis == True:
            raise  pkex.BasePyKatException("This kat object has noxaxis=True, so there is nothing to plot.")

423
424
        original_yaxis = kat.yaxis

425
426
        if yaxis is not None:
            kat.yaxis = yaxis
427
428
429
430
431
432
433
434
435
436
437
438
439

        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
440
441
        _func1 = np.abs
        _func2 = None
442

443
444
445
        plot_cmd1 = None
        plot_cmd2 = None
        
Daniel Brown's avatar
Daniel Brown committed
446
447
448
        if "re:im" in kat.yaxis:
            _func1 = np.real
            _func2 = np.imag
449
450
            plot_cmd1 = plot_cmd2 = plot_cmd
            
Daniel Brown's avatar
Daniel Brown committed
451
452
453
454
            dual_plot = True
        elif "abs:deg" in kat.yaxis:
            _func1 = np.abs
            _func2 = lambda x: np.rad2deg(np.angle(x))
455
456

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
457
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
458
            
Daniel Brown's avatar
Daniel Brown committed
459
460
            dual_plot = True
        elif "db:deg" in kat.yaxis:
461
462
463
464
465
            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
466
            _func2 = lambda x: np.rad2deg(np.angle(x))
467
468

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

492
493
494
495
496
497
498
        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
499
            if not hasattr(kat, det) or (hasattr(kat, det) and not getattr(kat, det).noplot):
500
                
Daniel Brown's avatar
Daniel Brown committed
501
                if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
502
                    ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
503
504
505
506
                    
                if styles is not None and det in styles:
                    l, = plot_cmd1(self.x, _func1(self[det]), styles[det], label=det)
                else:
507
                    l, = plot_cmd1(self.x, _func1(self[det]), label=det)
Daniel Brown's avatar
Daniel Brown committed
508
509
                
                if dual_plot: 
510
511
                    pyplot.subplot(2,1,2)
                    plot_cmd2(self.x, _func2(self[det]), color=l.get_color(), ls=l.get_linestyle(), label=det)
512

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

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

617
            if out is None:
618
619
                out = self.y[:, idx]

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

        @property
        def amplitude(self): return self.__amplitude
701
702
703
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

704
705
706

        @property
        def phase(self): return self.__phase
707
708
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
709
710
711
712
713

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

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

739
740
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
741
            t.remove()
742
743
744
        
        del self.targets[:]
        
745
746
    @property
    def f(self): return self.__f
747
    @f.setter
748
749
750
751
752
753
754
    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)
755
    
Daniel Brown's avatar
Daniel Brown committed
756
    def __init__(self, kat):
757
        self._default_name = "fsignal"
758
759
        self.targets = []
        self._params = []
760
        self.__f = Param("f", self, None)
761
762
        self._kat = kat
        
763
764
765
766
767
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
768
        if target is None:
769
770
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
771
        if name is None:
772
            name = "sig_" + target._owner().name + "_" + target.name
773
        
Daniel Brown's avatar
Daniel Brown committed
774
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
775
776
777
778
        
    def getFinesseText(self):
        rtn = []
        
779
780
781
782
783
784
785
786
        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
787
            
788
789
790
791
792
793
794
                    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
795

796
797
798
799
800
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
801
802
803
804
805
806
807
808
809
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
    
810
Constant = namedtuple('Constant', 'name, value, usedBy')
811
812
813

id___ = 0

814
class kat(object):  
815

816
817
818
819
820
821
822
823
824
    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.
825
826
827
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
828
829
        return object.__new__(cnew)
    
830
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
831
832

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

Daniel Brown's avatar
updates    
Daniel Brown committed
879
880
881
    def deepcopy(self):
        return copy.deepcopy(self)
    
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
    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)
        
901
    def __deepcopy__(self, memo):
902
903
904
905
906
907
908
909
910
911
        """
        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
912
        result = self.__class__.__new__(self.__class__.__base__)
913
        memo[id(self)] = result
914
915
916
917
918
919
920
921
922
923
        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()
                
924
925
926
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
927
        
928
929
        return result
    
930
931
932
    @property
    def signals(self): return self.__signals

933
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
Daniel Brown's avatar
Daniel Brown committed
934
    
935
936
937
938
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
Daniel Brown's avatar
Daniel Brown committed
939
940
941
942
943
944
945
946
        values = value.split()
        
        if len(values) == 2:
            scale = values[0]
            mode = values[1]
        else:
            scale = "lin"
            mode = value
947
        
Daniel Brown's avatar
Daniel Brown committed
948
949
950
951
952
        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) ))
953
            
Daniel Brown's avatar
Daniel Brown committed
954
        self.__yaxis = str(scale + " " + mode).strip()
955

Sean Leavey's avatar
Sean Leavey committed
956
957
958
959
960
961
962
963
964
965
966
    @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

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

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

    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
1041
1042
1043
1044
1045
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
1046
            
Daniel Brown's avatar
Daniel Brown committed
1047
                if len(values)>0 and values[0] == 'const':
1048
                
Daniel Brown's avatar
Daniel Brown committed
1049
1050
1051
1052
1053
                    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], [])
1054
                    else:
Daniel Brown's avatar
Daniel Brown committed
1055
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
1056
        
Daniel Brown's avatar
Daniel Brown committed
1057
            commands_new = []
1058
        
Daniel Brown's avatar
Daniel Brown committed
1059
1060
            for line in commands:
                values = line.split()
1061
            
Daniel Brown's avatar
Daniel Brown committed
1062
1063
1064
1065
1066
                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
1067
                        
Daniel Brown's avatar
Daniel Brown committed
1068
                            chars = [' ', '+', '-', '*', '/', ')']
1069

Daniel Brown's avatar
Daniel Brown committed
1070
1071
                            for c in chars:
                                none_found = False
1072
                            
Daniel Brown's avatar
Daniel Brown committed
1073
1074
1075
1076
1077
1078
                                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
1079
                        
Daniel Brown's avatar
Daniel Brown committed
1080
1081
1082
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
1083
                        
Daniel Brown's avatar
Daniel Brown committed
1084
                    commands_new.append(line)
1085
    
Daniel Brown's avatar
Daniel Brown committed
1086
            self.constants = constants
1087
        
Daniel Brown's avatar
Daniel Brown committed
1088
1089
1090
1091
1092
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
1093
    
Daniel Brown's avatar
updates    
Daniel Brown committed
1094
1095
1096
1097
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
1098
1099
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
1100
1101
1102
1103
1104
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
1105
        
1106
        for o in list(self.__blocks[name].contents):
1107
1108
1109
            self.remove(o)
        
        del self.__blocks[name]
1110
1111
1112
1113
    
    def __str__(self):
         return "".join(self.generateKatScript())
         
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
    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
1139
    def parseCommands(self, commands, blocks=None, addToBlock=None, preserve=False):
1140
        try:
1141
1142
1143
1144
1145
1146
1147
1148
            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)
                
1149
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
1150
        
1151
            commands=self.remove_comments(commands)
1152
        
1153
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
1154
        
1155
1156
1157
            # 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
1158
        
1159
            for line in commands:
1160
1161
1162
1163
1164
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()