finesse.py 93.2 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# -*- 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

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

51
52
from subprocess import Popen, PIPE

53
54
55
56
57
58
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
59
60
61
62
63
64
65
66


try:
    # Add exception in Python 2
    FileNotFoundError
except NameError:
    FileNotFoundError = IOError
    
67
68
69
70
71
72
73
74
75
76
"""
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
"""
77
78

from math import erfc, pi
79
from collections import namedtuple, OrderedDict
80

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

89
90
import pykat.external.six as six

Daniel Brown's avatar
Daniel Brown committed
91
92
import pykat.exceptions as pkex

93
94
95
96
97
98
99
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
100
101
102
103
104

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
105

Daniel Brown's avatar
Daniel Brown committed
106
107
from multiprocessing import Process, Manager

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

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

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


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

158
159
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
    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
185
186
                                )

187
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
188

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

193
194
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
195
                     
196
197
198
199
class KatBatch(object):
    """
    
    """
Daniel Brown's avatar
Daniel Brown committed
200

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    
    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"]
        
222
        return kat.run(**kw)
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    
    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

                                  
238
239
240
241
242
243
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)
            
Daniel Brown's avatar
Daniel Brown committed
244
245
class katRun(object):
    def __init__(self):
246
247
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
248
249
250
251
252
253
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
254
        self.yaxis = None
255
        
Daniel Brown's avatar
Daniel Brown committed
256
257
258
259
260
261
262
263
264
    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()
        
265
        print("")
Daniel Brown's avatar
Daniel Brown committed
266
        print("--- Output info ---")
267
        print("")
Daniel Brown's avatar
Daniel Brown committed
268
269
        print("Run date and time: %s" % self.StartDateTime)
        print("Detectors used: %s" % (", ".join(detectors)))
270
271
        print("")

Daniel Brown's avatar
Daniel Brown committed
272
273
274
275
        if kat.noxaxis:
            print("No xaxis used")
        else:
            print("One xaxis used: %s" % kat.xaxis.getFinesseText())
276
277
278
279
280
281
282
283
284
285
286
            
        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
287
288
        
        
Daniel Brown's avatar
Daniel Brown committed
289
290
    def plot(self, detectors=None, filename=None, show=True,
                   yaxis=None, legend=True, loc=0, title=None, styles=None,
291
292
                   ylabel=None, y2label=None, xlabel=None, x2label=None,
                   xlim=None, x2lim=None, ylim=None, y2lim=None):
293
294
295
296
297
298
299
300
        """
        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
301
302
303
304
305
306
307
308
309
310
311
312
313
            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
            y2label, x2label:   Text for the second plot x and y labels 
314
        """
315
316
317
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt

Daniel Brown's avatar
Daniel Brown committed
318
319
320
        if not show:
            pyplot.ioff()

321
322
323
324
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)

325
326
        if yaxis is not None:
            kat.yaxis = yaxis
327
328
329
330
331
332
333
334
335
336
337
338
339

        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
340
341
        _func1 = np.abs
        _func2 = None
342

343
344
345
        plot_cmd1 = None
        plot_cmd2 = None
        
Daniel Brown's avatar
Daniel Brown committed
346
347
348
        if "re:im" in kat.yaxis:
            _func1 = np.real
            _func2 = np.imag
349
350
            plot_cmd1 = plot_cmd2 = plot_cmd
            
Daniel Brown's avatar
Daniel Brown committed
351
352
353
354
            dual_plot = True
        elif "abs:deg" in kat.yaxis:
            _func1 = np.abs
            _func2 = lambda x: np.rad2deg(np.angle(x))
355
356

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
357
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
358
            
Daniel Brown's avatar
Daniel Brown committed
359
360
361
362
            dual_plot = True
        elif "db:deg" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
            _func2 = lambda x: np.rad2deg(np.angle(x))
363
364

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
365
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
366
            
367
            dual_plot = True
Daniel Brown's avatar
Daniel Brown committed
368
        elif "abs" in kat.yaxis:
369
370
            # _func1 = np.abs
            _func1 = np.real
371
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
372
373
        elif "db" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
374
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
375
376
        elif "deg" in kat.yaxis:
            _func1 = lambda x: np.rad2deg(np.angle(x))
377
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
378
379
380
            
        if dual_plot:
            fig = plt.figure(width="full", height=1)
381
        else:
Daniel Brown's avatar
Daniel Brown committed
382
            fig = plt.figure(width="full")   
383

384
385
386
387
388
389
390
        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
391
            if not hasattr(kat, det) or (hasattr(kat, det) and not getattr(kat, det).noplot):
392
                
Daniel Brown's avatar
Daniel Brown committed
393
                if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
394
                    ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
395
396
397
398
                    
                if styles is not None and det in styles:
                    l, = plot_cmd1(self.x, _func1(self[det]), styles[det], label=det)
                else:
399
                    l, = plot_cmd1(self.x, _func1(self[det]), label=det)
Daniel Brown's avatar
Daniel Brown committed
400
401
                
                if dual_plot: 
402
403
                    pyplot.subplot(2,1,2)
                    plot_cmd2(self.x, _func2(self[det]), color=l.get_color(), ls=l.get_linestyle(), label=det)
404

Daniel Brown's avatar
Daniel Brown committed
405
406
407
408
        if dual_plot:
            if ylabel is None:
                if "abs" in kat.yaxis: ylabel = "Absolute [au]"
                if "re" in kat.yaxis:  ylabel = "Real part [au]"
409
                    
Daniel Brown's avatar
Daniel Brown committed
410
411
412
            if y2label is None:
                if "deg" in kat.yaxis: y2label = "Phase [deg]"
                if "im" in kat.yaxis:  y2label = "Imaginary part [au]"
413
414
415
416
417
418
419
                    
            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
420
421
422
        else:
            if ylabel is None:
                ylabel = "[au]"
423
424
425
426
                
            if xlim is None:
                xlim = (self.x.min(), self.x.max())
            
Daniel Brown's avatar
Daniel Brown committed
427
        
Daniel Brown's avatar
Daniel Brown committed
428
429
430
431
432
433
        if xlabel is None:
            xlabel = self.xlabel
            
        if x2label is None:
            x2label = self.xlabel
            
Daniel Brown's avatar
Daniel Brown committed
434
435
        font_label_size = pyplot.rcParams["font.size"]-1
        
436
        if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
437
            ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
438
439
            pyplot.xlabel(xlabel, fontsize=font_label_size)
            pyplot.ylabel(ylabel, fontsize=font_label_size)
440
441
442
443
            pyplot.xlim(xlim[0], xlim[1])
            if ylim is not None:
                pyplot.ylim(ylim[0],ylim[1])

Daniel Brown's avatar
Daniel Brown committed
444
445
            if title is not None:
                pyplot.title(title, fontsize=font_label_size)
446
447
    
            pyplot.subplot(2,1,2)
Daniel Brown's avatar
Daniel Brown committed
448
449
            pyplot.xlabel(x2label, fontsize=font_label_size)
            pyplot.ylabel(y2label, fontsize=font_label_size)
450
451
452
453
454
        
            pyplot.xlim(x2lim[0], x2lim[1])
            if y2lim is not None:
                pyplot.ylim(y2lim[0],y2lim[1])
            
455
        else:
Daniel Brown's avatar
Daniel Brown committed
456
457
            pyplot.xlabel(xlabel, fontsize=font_label_size)
            pyplot.ylabel(ylabel)
458
            pyplot.xlim(self.x.min(), self.x.max())
Daniel Brown's avatar
Daniel Brown committed
459
460
461
            
            if title is not None:
                pyplot.title(title, fontsize=font_label_size)
462
463
            if ylim is not None:
                pyplot.ylim(ylim[0],ylim[1])
464
465
    
        pyplot.tight_layout()
466
    
467
        if legend:
Daniel Brown's avatar
Daniel Brown committed
468
            fig.axes[0].legend(loc=loc, fontsize=font_label_size)
469
470
471
472
473
474
        
        if filename is not None:
            fig.savefig(filename)
            
        if show:
            pyplot.show(fig)
Daniel Brown's avatar
Daniel Brown committed
475
            pyplot.ion()
476
477
        
        return fig
Daniel Brown's avatar
Daniel Brown committed
478
        
479
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
480
481
482
483
484
485
486
487
488
489
490
        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):
491
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
492
493
        out = None
        
494
        if len(idx) > 0:
495
            #out = self.y[:, idx]
496
            
497
            if len(idx) == 1:
Daniel Brown's avatar
Daniel Brown committed
498
                if "abs:deg" in self.yaxis:
499
                    out = self.y[:, idx[0]]
Daniel Brown's avatar
Daniel Brown committed
500
                elif "re:im" in self.yaxis:
501
502
                    out = self.y[:, idx[0]]
            else: 
Daniel Brown's avatar
Daniel Brown committed
503
                if "abs:deg" in self.yaxis:
504
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
Daniel Brown's avatar
Daniel Brown committed
505
                elif "re:im" in self.yaxis :
506
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
507

508
            if out is None:
509
510
                out = self.y[:, idx]

511
            if out.size == 1:
512
                return out[0].squeeze()
513
            else:
514
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
515
        else:
516
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
517
518
519
      
class katRun2D(object):
    def __init__(self):
520
        self.runtime = None
521
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
522
523
524
525
526
527
528
529
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
530
531
        self.stderr = None
        self.stdout = None
Daniel Brown's avatar
Daniel Brown committed
532
533
534
535
536
537
538
539
540
541
        
    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)
    
542
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
543
544
    
    def __getitem__(self, value):
545
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
546
547
548
549
550
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
551
    
552
        
553
554
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
555
        def __init__(self, param, name, amplitude, phase, signal):
556
557
558
559
560
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
561
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
562
            self.__signal = signal
563
            
564
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
565
            # various parameter names of the components, e.g. mirror xbeta is x 
566
567
568
            # 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:
569
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
570
571
572
            
        def _register_param(self, param):
            self._params.append(param)
573
574
575
        
        @property
        def removed(self): return self.__removed
576
  
577
        def remove(self):
578
579
580
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
581
582
583
            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
584
585
                self.__signal.targets.remove(self)
                self.__remove = True
586
        
587
588
589
590
591
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
592
593
594
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

595
596
597

        @property
        def phase(self): return self.__phase
598
599
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
600
601
602
603
604

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

        @property
605
        def owner(self): return self.__target._owner().name
606
607
608
609
610
611
612
613
614
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
615
    
616
617
618
619
620
621
622
    @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:
623
            return self._default_name
624
625
        else:
            return self.targets[0].name
626
627
            
    @property
Daniel Brown's avatar
Daniel Brown committed
628
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
629

630
631
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
632
            t.remove()
633
634
635
        
        del self.targets[:]
        
636
637
    @property
    def f(self): return self.__f
638
639
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
640
    
Daniel Brown's avatar
Daniel Brown committed
641
    def __init__(self, kat):
642
        self._default_name = "fsignal"
643
644
        self.targets = []
        self._params = []
645
        self.__f = Param("f", self, 0)
646
647
        self._kat = kat
        
648
649
650
651
652
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
653
        if target is None:
654
655
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
656
        if name is None:
657
            name = "sig_" + target._owner().name + "_" + target.name
658
        
Daniel Brown's avatar
Daniel Brown committed
659
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
660
661
662
663
        
    def getFinesseText(self):
        rtn = []
        
664
        if len(self.targets) == 0 and (self.f != 0 and self.f is not None):
665
666
667
668
669
670
            rtn.append("fsig {name} {frequency}"
                            .format(name = self.name,
                                    frequency=str(self.f)))
        else:
            for t in self.targets:
                rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
671
            
672
673
674
675
676
677
678
                rtn.append("fsig {name} {comp} {target} {frequency} {phase} {amplitude}"
                                .format(name = t.name,
                                        comp=t.owner,
                                        target=t.target,
                                        frequency=str(self.f),
                                        phase=str(t.phase),
                                        amplitude=str(t.amplitude if t.amplitude != None else "")))
Daniel Brown's avatar
Daniel Brown committed
679

680
681
682
683
684
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
685
686
687
688
689
690
691
692
693
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
    
694
Constant = namedtuple('Constant', 'name, value, usedBy')
695
696
697

id___ = 0

698
class kat(object):  
699

700
701
702
703
704
705
706
707
708
    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.
709
710
711
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
712
713
        return object.__new__(cnew)
    
714
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
715
716

        self.__looking = False
Daniel Brown's avatar
Daniel Brown committed
717
718
        self.scene = None # scene object for GUI
        self.verbose = True
719
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
720
721
722
723
724
725
726
727
728
729
        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
730
        self.__signals = Signals(self)
731
        self.constants = {}
732
        self.vacuum = []
733
734
        self.__prevrunfilename = None
        self.printmatrix = None
735
736
737
738
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
739
740
741
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
742
743
        self.retrace = None
        self.deriv_h = None
744
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
745
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
746
747
        self.__phase = None
        self.__maxtem = None
748
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
749
        self.__time_code = None
750
        self.__yaxis = "abs" # default yaxis
751
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
752
753
754
755
756
757
758
759
760
        
        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)
761

Daniel Brown's avatar
updates    
Daniel Brown committed
762
763
764
    def deepcopy(self):
        return copy.deepcopy(self)
    
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
    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)
        
784
    def __deepcopy__(self, memo):
785
786
787
788
789
790
791
792
793
794
        """
        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
795
        result = self.__class__.__new__(self.__class__.__base__)
796
        memo[id(self)] = result
797
798
799
800
801
802
803
804
805
806
        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()
                
807
808
809
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
810
        
811
812
        return result
    
813
814
815
    @property
    def signals(self): return self.__signals

816
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
Daniel Brown's avatar
Daniel Brown committed
817
    
818
819
820
821
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
Daniel Brown's avatar
Daniel Brown committed
822
823
824
825
826
827
828
829
        values = value.split()
        
        if len(values) == 2:
            scale = values[0]
            mode = values[1]
        else:
            scale = "lin"
            mode = value
830
        
Daniel Brown's avatar
Daniel Brown committed
831
832
833
834
835
        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) ))
836
            
Daniel Brown's avatar
Daniel Brown committed
837
        self.__yaxis = str(scale + " " + mode).strip()
838

Sean Leavey's avatar
Sean Leavey committed
839
840
841
842
843
844
845
846
847
848
849
    @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

850
851
852
853
854
855
856
857
858
859
    @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
860
861
862
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
863
864
865
866
867
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
868
869
870
871
872
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
873
        
Daniel Brown's avatar
Daniel Brown committed
874
    @property
875
876
877
    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
878
    
Daniel Brown's avatar
Daniel Brown committed
879
880
881
882
883
884
885
886
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
887
888
889
890
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
891
892
893
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
894
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
895

896
897
    @staticmethod
    def logo():
898
        print ("""                                              ..-
899
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
900
901
902
903
904
905
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
906
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
907
    
908
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
909
        commands=open(katfile).read()
910
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
911
    
912
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
913
        #commands = code.split("\n")
914
        self.parseCommands(code, blocks=blocks)
915
916
917
918
919
920
921

    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
922
923
924
925
926
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
927
            
Daniel Brown's avatar
Daniel Brown committed
928
                if len(values)>0 and values[0] == 'const':
929
                
Daniel Brown's avatar
Daniel Brown committed
930
931
932
933
934
                    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], [])
935
                    else:
Daniel Brown's avatar
Daniel Brown committed
936
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
937
        
Daniel Brown's avatar
Daniel Brown committed
938
            commands_new = []
939
        
Daniel Brown's avatar
Daniel Brown committed
940
941
            for line in commands:
                values = line.split()
942
            
Daniel Brown's avatar
Daniel Brown committed
943
944
945
946
947
                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
948
                        
Daniel Brown's avatar
Daniel Brown committed
949
                            chars = [' ', '+', '-', '*', '/', ')']
950

Daniel Brown's avatar
Daniel Brown committed
951
952
                            for c in chars:
                                none_found = False
953
                            
Daniel Brown's avatar
Daniel Brown committed
954
955
956
957
958
959
                                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
960
                        
Daniel Brown's avatar
Daniel Brown committed
961
962
963
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
964
                        
Daniel Brown's avatar
Daniel Brown committed
965
                    commands_new.append(line)
966
    
Daniel Brown's avatar
Daniel Brown committed
967
            self.constants = constants
968
        
Daniel Brown's avatar
Daniel Brown committed
969
970
971
972
973
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
974
    
Daniel Brown's avatar
updates    
Daniel Brown committed
975
976
977
978
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
979
980
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
981
982
983
984
985
986
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
                
987
988
989
990
        for o in self.__blocks[name].contents:
            self.remove(o)
        
        del self.__blocks[name]
991
992
993
994
    
    def __str__(self):
         return "".join(self.generateKatScript())
         
995
    def parseCommands(self, commands, blocks=None, addToBlock=None):
996
        try:
997
998
999
1000
1001
1002
1003
1004
            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)
                
1005
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
1006
        
1007
            commands=self.remove_comments(commands)
1008
        
1009
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
1010
        
1011
1012
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
1013
        
1014
            for line in commands:
1015
1016
1017
1018
1019
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
1020
                    
1021
1022
1023
1024
1025
1026
1027
                    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))    
1028
                        
1029
1030
                                if newTag in self.__blocks:
                                    raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
1031
                        
1032
1033
                                self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                                self.__currentTag = newTag
1034
                    
1035
1036
                            if values[1] == "FTend":
                                self.__currentTag = NO_BLOCK
1037
                    
1038
1039
1040
                            continue
                    else:
                        self.__currentTag = addToBlock
Daniel Brown's avatar
Daniel Brown committed
1041

1042
1043
1044
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
1045
                
1046
1047
1048
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
1049
            
1050
1051
1052
1053
1054
1055
1056
                    # check if block comment is being used
                    if not blockComment and line[0:2] == "/*":
                        blockComment = True
                        continue
                    elif blockComment and line[0:2] == "*/":
                        blockComment = False
                        continue
1057
            
1058
1059
                    first = line.split(" ",1)[0]
                    obj = None
1060

1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
                    if(first == "m" or first == "m1" or first == "m2"):
                        obj = pykat.components.mirror.parseFinesseText(line)
                    elif(first == "s"):
                        obj = pykat.components.space.parseFinesseText(line)
                    elif(first == "l"):
                        obj = pykat.components.laser.parseFinesseText(line)
                    elif(first == "sq"):
                        obj = pykat.components.squeezer.parseFinesseText(line)
                    elif(first[0:2] == "bs"):
                        obj = pykat.components.beamSplitter.parseFinesseText(line)
                    elif(first[0:2] == "gr"):
                        obj = pykat.components.grating.parseFinesseText(line)
                    elif(first[0:4] == "isol"):
                        obj = pykat.components.isolator.parseFinesseText(line)
                    elif(first[0:4] == "lens"):
                        obj = pykat.components.lens.parseFinesseText(line)
                    elif(first[0:3] == "mod"):
                        obj = pykat.components.modulator.parseFinesseText(line)
                    elif(first[0:2] == "ad"):
                        obj = pykat.detectors.ad.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
1081
1082
1083
1084
                    elif(first[0:2] == "xd"):
                        obj = pykat.detectors.xd.parseFinesseText(line)
                    elif(first[0:2] == "tf"):
                        obj = pykat.commands.tf.parseFinesseText(line)
1085
1086
                    elif(first[0:2] == "cp"):
                        obj = pykat.detectors.cp.parseFinesseText(line)
1087
1088
1089
1090
                    elif(first[0:2] == "bp"):
                        obj = pykat.detectors.bp.parseFinesseText(line)
                    elif(first[0:4] == "gouy"):
                        obj = pykat.detectors.gouy.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
1091
1092
                    elif(first[0:4] == "beam"):
                        obj = pykat.detectors.beam.parseFinesseText(line)
1093
1094
1095
1096
1097
1098
1099
                    elif(first[0:2] == "pd" and first != "pdtype"):
                        obj = pykat.detectors.pd.parseFinesseText(line)
                    elif(first == "qshot" or first == "qshotS" or first == "qshotN"):
                        obj = pykat.detectors.qshot.parseFinesseText(line)
                    elif(first == "qnoised" or first == "qnoisedS" or first == "qnoisedN"):
                        obj = pykat.detectors.qnoised.parseFinesseText(line)
                    elif(first == "xaxis" or first == "xaxis*"):
1100
                        self.noxaxis = False
1101
                        obj = pykat.commands.xaxis.parseFinesseText(line)
1102
1103
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
1104
1105
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
1106
1107
1108
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
1109
                        after_process.append((line, self.__currentTag))
1110
                    elif(first == "scale"):
1111
                        after_process.append((line, self.__currentTag))