finesse.py 91.8 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
59
60
61
62
63
64
65
66
67
68
try:
    # Python 2
    from itertools import izip_longest
except ImportError:
    # Python 3
    from itertools import zip_longest as izip_longest
"""
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
"""
69
70

from math import erfc, pi
71
from collections import namedtuple, OrderedDict
72

Daniel Brown's avatar
Daniel Brown committed
73
from pykat.node_network import NodeNetwork
74
from pykat.detectors import BaseDetector as Detector
Daniel Brown's avatar
Daniel Brown committed
75
76
from pykat.components import Component
from pykat.commands import Command, xaxis
77
from pykat.SIfloat import *
78
from pykat.param import Param, AttrParam
79
from pykat.external import progressbar
Daniel Brown's avatar
Daniel Brown committed
80

81
82
import pykat.external.six as six

Daniel Brown's avatar
Daniel Brown committed
83
84
import pykat.exceptions as pkex

85
86
87
88
89
90
91
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
92
93
94
95
96

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
97

Daniel Brown's avatar
Daniel Brown committed
98
99
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
100
NO_BLOCK = "NO_BLOCK"
101
102
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
103
104
105
106
107
108
109
# 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
110
111
112
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
113
    
114
    if lkat_location is None:
Daniel Brown's avatar
Daniel Brown committed
115
116
117
        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
118
119
120
121
122
123
124
125
126
127
128
129
130

    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: 
131
        print ("Exception caught in python: ", ex.message)
Daniel Brown's avatar
Daniel Brown committed
132
133
134
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
135
136


137
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
138
139
140
141
142
143
144
145
146
147
148
149
    """
    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()

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    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
177
178
                                )

179
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
180

181
182
183
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
184

185
186
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
187
                     
188
189
190
191
class KatBatch(object):
    """
    
    """
Daniel Brown's avatar
Daniel Brown committed
192

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
    
    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"]
        
214
        return kat.run(**kw)
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
    
    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

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

Daniel Brown's avatar
Daniel Brown committed
264
265
266
267
        if kat.noxaxis:
            print("No xaxis used")
        else:
            print("One xaxis used: %s" % kat.xaxis.getFinesseText())
268
269
270
271
272
273
274
275
276
277
278
            
        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
279
280
        
        
Daniel Brown's avatar
Daniel Brown committed
281
282
283
    def plot(self, detectors=None, filename=None, show=True,
                   yaxis=None, legend=True, loc=0, title=None, styles=None,
                   ylabel=None, y2label=None, xlabel=None, x2label=None):
284
285
286
287
288
289
290
291
        """
        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
292
293
294
295
296
297
298
299
300
301
302
303
304
            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 
305
        """
306
307
308
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt

Daniel Brown's avatar
Daniel Brown committed
309
310
311
        if not show:
            pyplot.ioff()

312
313
314
315
        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)

316
317
        if yaxis is not None:
            kat.yaxis = yaxis
318
319
320
321
322
323
324
325
326
327
328
329
330

        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
331
332
        _func1 = np.abs
        _func2 = None
333

334
335
336
        plot_cmd1 = None
        plot_cmd2 = None
        
Daniel Brown's avatar
Daniel Brown committed
337
338
339
        if "re:im" in kat.yaxis:
            _func1 = np.real
            _func2 = np.imag
340
341
            plot_cmd1 = plot_cmd2 = plot_cmd
            
Daniel Brown's avatar
Daniel Brown committed
342
343
344
345
            dual_plot = True
        elif "abs:deg" in kat.yaxis:
            _func1 = np.abs
            _func2 = lambda x: np.rad2deg(np.angle(x))
346
347

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
348
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
349
            
Daniel Brown's avatar
Daniel Brown committed
350
351
352
353
            dual_plot = True
        elif "db:deg" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
            _func2 = lambda x: np.rad2deg(np.angle(x))
354
355

            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
356
            plot_cmd2 = pyplot.plot if kat.xaxis.scale == "lin" else pyplot.semilogx
357
            
358
            dual_plot = True
Daniel Brown's avatar
Daniel Brown committed
359
        elif "abs" in kat.yaxis:
360
361
            # _func1 = np.abs
            _func1 = np.real
362
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
363
364
        elif "db" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
365
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
366
367
        elif "deg" in kat.yaxis:
            _func1 = lambda x: np.rad2deg(np.angle(x))
368
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
369
370
371
            
        if dual_plot:
            fig = plt.figure(width="full", height=1)
372
        else:
Daniel Brown's avatar
Daniel Brown committed
373
            fig = plt.figure(width="full")   
374

375
376
377
378
379
380
381
        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
382
            if not hasattr(kat, det) or (hasattr(kat, det) and not getattr(kat, det).noplot):
383
                
Daniel Brown's avatar
Daniel Brown committed
384
                if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
385
                    ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
386
387
388
389
                    
                if styles is not None and det in styles:
                    l, = plot_cmd1(self.x, _func1(self[det]), styles[det], label=det)
                else:
390
                    l, = plot_cmd1(self.x, _func1(self[det]), label=det)
Daniel Brown's avatar
Daniel Brown committed
391
392
                
                if dual_plot: 
393
394
                    pyplot.subplot(2,1,2)
                    plot_cmd2(self.x, _func2(self[det]), color=l.get_color(), ls=l.get_linestyle(), label=det)
395

Daniel Brown's avatar
Daniel Brown committed
396
397
398
399
400
401
402
403
404
405
406
407
        if dual_plot:
            if ylabel is None:
                if "abs" in kat.yaxis: ylabel = "Absolute [au]"
                if "re" in kat.yaxis:  ylabel = "Real part [au]"
                
            if y2label is None:
                if "deg" in kat.yaxis: y2label = "Phase [deg]"
                if "im" in kat.yaxis:  y2label = "Imaginary part [au]"
        else:
            if ylabel is None:
                ylabel = "[au]"
        
Daniel Brown's avatar
Daniel Brown committed
408
409
410
411
412
413
        if xlabel is None:
            xlabel = self.xlabel
            
        if x2label is None:
            x2label = self.xlabel
            
Daniel Brown's avatar
Daniel Brown committed
414
415
        font_label_size = pyplot.rcParams["font.size"]-1
        
416
        if dual_plot:
Daniel Brown's avatar
Daniel Brown committed
417
            ax = pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
418
            pyplot.xlabel(xlabel, fontsize=font_label_size)
419
            pyplot.xlim(self.x.min(), self.x.max())
Daniel Brown's avatar
Daniel Brown committed
420
            pyplot.ylabel(ylabel, fontsize=font_label_size)
421
            
Daniel Brown's avatar
Daniel Brown committed
422
423
            if title is not None:
                pyplot.title(title, fontsize=font_label_size)
424
425
    
            pyplot.subplot(2,1,2)
Daniel Brown's avatar
Daniel Brown committed
426
            pyplot.xlabel(x2label, fontsize=font_label_size)
427
            pyplot.xlim(self.x.min(), self.x.max())
Daniel Brown's avatar
Daniel Brown committed
428
            pyplot.ylabel(y2label, fontsize=font_label_size)
429
        else:
Daniel Brown's avatar
Daniel Brown committed
430
431
            pyplot.xlabel(xlabel, fontsize=font_label_size)
            pyplot.ylabel(ylabel)
432
            pyplot.xlim(self.x.min(), self.x.max())
Daniel Brown's avatar
Daniel Brown committed
433
434
435
            
            if title is not None:
                pyplot.title(title, fontsize=font_label_size)
436
437
    
        pyplot.tight_layout()
438
    
439
        if legend:
Daniel Brown's avatar
Daniel Brown committed
440
            fig.axes[0].legend(loc=loc, fontsize=font_label_size)
441
442
443
444
445
446
        
        if filename is not None:
            fig.savefig(filename)
            
        if show:
            pyplot.show(fig)
Daniel Brown's avatar
Daniel Brown committed
447
            pyplot.ion()
448
449
        
        return fig
Daniel Brown's avatar
Daniel Brown committed
450
        
451
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
452
453
454
455
456
457
458
459
460
461
462
        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):
463
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
464
465
        out = None
        
466
        if len(idx) > 0:
467
            #out = self.y[:, idx]
468
            
469
            if len(idx) == 1:
Daniel Brown's avatar
Daniel Brown committed
470
                if "abs:deg" in self.yaxis:
471
                    out = self.y[:, idx[0]]
Daniel Brown's avatar
Daniel Brown committed
472
                elif "re:im" in self.yaxis:
473
474
                    out = self.y[:, idx[0]]
            else: 
Daniel Brown's avatar
Daniel Brown committed
475
                if "abs:deg" in self.yaxis:
476
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
Daniel Brown's avatar
Daniel Brown committed
477
                elif "re:im" in self.yaxis :
478
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
479

480
            if out is None:
481
482
                out = self.y[:, idx]

483
            if out.size == 1:
484
                return out[0].squeeze()
485
            else:
486
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
487
        else:
488
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
489
490
491
      
class katRun2D(object):
    def __init__(self):
492
        self.runtime = None
493
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
494
495
496
497
498
499
500
501
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
502
503
        self.stderr = None
        self.stdout = None
Daniel Brown's avatar
Daniel Brown committed
504
505
506
507
508
509
510
511
512
513
        
    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)
    
514
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
515
516
    
    def __getitem__(self, value):
517
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
518
519
520
521
522
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
523
    
524
        
525
526
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
527
        def __init__(self, param, name, amplitude, phase, signal):
528
529
530
531
532
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
533
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
534
            self.__signal = signal
535
            
536
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
537
            # various parameter names of the components, e.g. mirror xbeta is x 
538
539
540
            # 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:
541
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
542
543
544
            
        def _register_param(self, param):
            self._params.append(param)
545
546
547
        
        @property
        def removed(self): return self.__removed
548
  
549
        def remove(self):
550
551
552
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
553
554
555
            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
556
557
                self.__signal.targets.remove(self)
                self.__remove = True
558
        
559
560
561
562
563
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
564
565
566
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

567
568
569

        @property
        def phase(self): return self.__phase
570
571
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
572
573
574
575
576

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

        @property
577
        def owner(self): return self.__target._owner().name
578
579
580
581
582
583
584
585
586
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
587
    
588
589
590
591
592
593
594
    @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:
595
            return self._default_name
596
597
        else:
            return self.targets[0].name
598
599
            
    @property
Daniel Brown's avatar
Daniel Brown committed
600
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
601

602
603
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
604
            t.remove()
605
606
607
        
        del self.targets[:]
        
608
609
    @property
    def f(self): return self.__f
610
611
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
612
    
Daniel Brown's avatar
Daniel Brown committed
613
    def __init__(self, kat):
614
        self._default_name = "fsignal"
615
616
        self.targets = []
        self._params = []
617
        self.__f = Param("f", self, 0)
618
619
        self._kat = kat
        
620
621
622
623
624
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
625
        if target is None:
626
627
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
628
        if name is None:
629
            name = "sig_" + target._owner().name + "_" + target.name
630
        
Daniel Brown's avatar
Daniel Brown committed
631
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
632
633
634
635
        
    def getFinesseText(self):
        rtn = []
        
636
        if len(self.targets) == 0 and (self.f != 0 and self.f is not None):
637
638
639
640
641
642
            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
643
            
644
645
646
647
648
649
650
                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
651

652
653
654
655
656
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
657
658
659
660
661
662
663
664
665
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
    
666
Constant = namedtuple('Constant', 'name, value, usedBy')
667
668
669

id___ = 0

670
class kat(object):  
671

672
673
674
675
676
677
678
679
680
    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.
681
682
683
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
684
685
        return object.__new__(cnew)
    
686
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
687
688

        self.__looking = False
Daniel Brown's avatar
Daniel Brown committed
689
690
        self.scene = None # scene object for GUI
        self.verbose = True
691
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
692
693
694
695
696
697
698
699
700
701
        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
702
        self.__signals = Signals(self)
703
        self.constants = {}
704
        self.vacuum = []
705
706
        self.__prevrunfilename = None
        self.printmatrix = None
707
708
709
710
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
711
712
713
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
714
715
        self.retrace = None
        self.deriv_h = None
716
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
717
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
718
719
        self.__phase = None
        self.__maxtem = None
720
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
721
        self.__time_code = None
722
        self.__yaxis = "abs" # default yaxis
723
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
724
725
726
727
728
729
730
731
732
        
        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)
733

Daniel Brown's avatar
updates    
Daniel Brown committed
734
735
736
    def deepcopy(self):
        return copy.deepcopy(self)
    
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
    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)
        
756
    def __deepcopy__(self, memo):
757
758
759
760
761
762
763
764
765
766
        """
        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
767
        result = self.__class__.__new__(self.__class__.__base__)
768
        memo[id(self)] = result
769
770
771
772
773
774
775
776
777
778
        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()
                
779
780
781
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
782
        
783
784
        return result
    
785
786
787
    @property
    def signals(self): return self.__signals

788
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
Daniel Brown's avatar
Daniel Brown committed
789
    
790
791
792
793
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
Daniel Brown's avatar
Daniel Brown committed
794
795
796
797
798
799
800
801
        values = value.split()
        
        if len(values) == 2:
            scale = values[0]
            mode = values[1]
        else:
            scale = "lin"
            mode = value
802
        
Daniel Brown's avatar
Daniel Brown committed
803
804
805
806
807
        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) ))
808
            
Daniel Brown's avatar
Daniel Brown committed
809
        self.__yaxis = str(scale + " " + mode).strip()
810

Sean Leavey's avatar
Sean Leavey committed
811
812
813
814
815
816
817
818
819
820
821
    @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

822
823
824
825
826
827
828
829
830
831
    @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
832
833
834
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
835
836
837
838
839
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
840
841
842
843
844
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
845
        
Daniel Brown's avatar
Daniel Brown committed
846
    @property
847
848
849
    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
850
    
Daniel Brown's avatar
Daniel Brown committed
851
852
853
854
855
856
857
858
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
859
860
861
862
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
863
864
865
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
866
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
867

868
869
    @staticmethod
    def logo():
870
        print ("""                                              ..-
871
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
872
873
874
875
876
877
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
878
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
879
    
880
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
881
        commands=open(katfile).read()
882
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
883
    
884
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
885
        #commands = code.split("\n")
886
        self.parseCommands(code, blocks=blocks)
887
888
889
890
891
892
893

    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
894
895
896
897
898
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
899
            
Daniel Brown's avatar
Daniel Brown committed
900
                if len(values)>0 and values[0] == 'const':
901
                
Daniel Brown's avatar
Daniel Brown committed
902
903
904
905
906
                    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], [])
907
                    else:
Daniel Brown's avatar
Daniel Brown committed
908
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
909
        
Daniel Brown's avatar
Daniel Brown committed
910
            commands_new = []
911
        
Daniel Brown's avatar
Daniel Brown committed
912
913
            for line in commands:
                values = line.split()
914
            
Daniel Brown's avatar
Daniel Brown committed
915
916
917
918
919
                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
920
                        
Daniel Brown's avatar
Daniel Brown committed
921
                            chars = [' ', '+', '-', '*', '/', ')']
922

Daniel Brown's avatar
Daniel Brown committed
923
924
                            for c in chars:
                                none_found = False
925
                            
Daniel Brown's avatar
Daniel Brown committed
926
927
928
929
930
931
                                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
932
                        
Daniel Brown's avatar
Daniel Brown committed
933
934
935
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
936
                        
Daniel Brown's avatar
Daniel Brown committed
937
                    commands_new.append(line)
938
    
Daniel Brown's avatar
Daniel Brown committed
939
            self.constants = constants
940
        
Daniel Brown's avatar
Daniel Brown committed
941
942
943
944
945
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
946
    
Daniel Brown's avatar
updates    
Daniel Brown committed
947
948
949
950
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
951
952
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
953
954
955
956
957
958
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
                
959
960
961
962
        for o in self.__blocks[name].contents:
            self.remove(o)
        
        del self.__blocks[name]
963
964
965
966
    
    def __str__(self):
         return "".join(self.generateKatScript())
         
967
    def parseCommands(self, commands, blocks=None, addToBlock=None):
968
        try:
969
970
971
972
973
974
975
976
            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)
                
977
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
978
        
979
            commands=self.remove_comments(commands)
980
        
981
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
982
        
983
984
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
985
        
986
            for line in commands:
987
988
989
990
991
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
992
                    
993
994
995
996
997
998
999
                    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))    
1000
                        
For faster browsing, not all history is shown. View entire blame