finesse.py 93.5 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
            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
313
314
315
316
317
318
            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.
319
        """
320
321
322
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt

Daniel Brown's avatar
Daniel Brown committed
323
324
325
        if not show:
            pyplot.ioff()

326
327
328
329
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)

330
331
        if yaxis is not None:
            kat.yaxis = yaxis
332
333
334
335
336
337
338
339
340
341
342
343
344

        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
345
346
        _func1 = np.abs
        _func2 = None
347

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

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

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

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

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

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

513
            if out is None:
514
515
                out = self.y[:, idx]

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

        @property
        def amplitude(self): return self.__amplitude
597
598
599
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

600
601
602

        @property
        def phase(self): return self.__phase
603
604
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
605
606
607
608
609

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

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

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

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

id___ = 0

703
class kat(object):  
704

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

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

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

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

Sean Leavey's avatar
Sean Leavey committed
844
845
846
847
848
849
850
851
852
853
854
    @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

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

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

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

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

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

1047
1048
1049
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
1050
                
1051
1052
1053
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
1054
            
1055
1056
1057
1058
1059
1060
1061
                    # 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
1062
            
1063
1064
                    first = line.split(" ",1)[0]
                    obj = None
1065

1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
                    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
1086
1087
1088
1089
                    elif(first[0:2] == "xd"):
                        obj = pykat.detectors.xd.parseFinesseText(line)
                    elif(first[0:2] == "tf"):
                        obj = pykat.commands.tf.parseFinesseText(line)
1090
1091
                    elif(first[0:2] == "cp"):
                        obj = pykat.detectors.cp.parseFinesseText(line)
1092
1093
1094
1095
                    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
1096
1097
                    elif(first[0:4] == "beam"):
                        obj = pykat.detectors.beam.parseFinesseText(line)
1098
1099
1100
1101
1102
1103
1104
                    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*"):
1105
                        self.noxaxis = False
1106
                        obj = pykat.commands.xaxis.parseFinesseText(line)
1107
1108
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
1109
1110
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
1111
1112
1113
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
1114
                        after_process.append((line, self.__currentTag))