finesse.py 90.9 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 09:56:53 2013

PyKat - Python interface and wrapper for FINESSE
Copyright (C) 2013 Daniel David Brown

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact at ddb@star.sr.bham.ac.uk

@author: Daniel Brown
"""
26
27
28
29
30
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals

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

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

from math import erfc, pi
68
from collections import namedtuple, OrderedDict
69

Daniel Brown's avatar
Daniel Brown committed
70
from pykat.node_network import NodeNetwork
71
from pykat.detectors import BaseDetector as Detector
Daniel Brown's avatar
Daniel Brown committed
72
73
from pykat.components import Component
from pykat.commands import Command, xaxis
74
from pykat.SIfloat import *
75
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
76

77
78
import pykat.external.six as six

Daniel Brown's avatar
Daniel Brown committed
79
80
import pykat.exceptions as pkex

81
82
83
84
85
86
87
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
88
89
90
91
92

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
93

Daniel Brown's avatar
Daniel Brown committed
94
95
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
96
NO_BLOCK = "NO_BLOCK"
97
98
pykat_web = "www.gwoptics.org/pykat"

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

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


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

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

175
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
176

177
178
179
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
180

181
182
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
183
                     
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
class KatBatch(object):
    """
    
    """
    
    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"]
        
        return kat.run(printerr=1, **kw)
    
    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

                                  
225
226
227
228
229
230
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
231
232
class katRun(object):
    def __init__(self):
233
234
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
235
236
237
238
239
240
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
241
        self.yaxis = None
242
        
Daniel Brown's avatar
Daniel Brown committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
    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()
        
        print("--- Output info ---")
        print("Run date and time: %s" % self.StartDateTime)
        print("Detectors used: %s" % (", ".join(detectors)))
        
        if kat.noxaxis:
            print("No xaxis used")
        else:
            print("One xaxis used: %s" % kat.xaxis.getFinesseText())
        
        
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
    def plot(self, detectors=None, filename=None, show=True, yaxis=None, legend=True, loc=0, title=None):
        """
        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:
        
            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.
        """
279
280
281
282
283
284
285
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt

        kat = pykat.finesse.kat()
        kat.verbose = False
        kat.parseCommands(self.katScript)

286
287
        if yaxis is not None:
            kat.yaxis = yaxis
288
289
290
291
292
293
294
295
296
297
298
299
300

        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
301
302
        _func1 = np.abs
        _func2 = None
303

304
305
306
        plot_cmd1 = None
        plot_cmd2 = None
        
Daniel Brown's avatar
Daniel Brown committed
307
308
309
        if "re:im" in kat.yaxis:
            _func1 = np.real
            _func2 = np.imag
310
311
            plot_cmd1 = plot_cmd2 = plot_cmd
            
Daniel Brown's avatar
Daniel Brown committed
312
313
314
315
            dual_plot = True
        elif "abs:deg" in kat.yaxis:
            _func1 = np.abs
            _func2 = lambda x: np.rad2deg(np.angle(x))
316
317
318
319

            plot_cmd1 = plot_cmd
            plot_cmd2 = pyplot.plot
            
Daniel Brown's avatar
Daniel Brown committed
320
321
322
323
            dual_plot = True
        elif "db:deg" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
            _func2 = lambda x: np.rad2deg(np.angle(x))
324
325
326
327

            plot_cmd1 = plot_cmd
            plot_cmd2 = pyplot.plot
            
328
            dual_plot = True
Daniel Brown's avatar
Daniel Brown committed
329
330
        elif "abs" in kat.yaxis:
            _func1 = np.abs
331
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
332
333
        elif "db" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
334
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
335
336
        elif "deg" in kat.yaxis:
            _func1 = lambda x: np.rad2deg(np.angle(x))
337
            plot_cmd1 = plot_cmd
Daniel Brown's avatar
Daniel Brown committed
338
339
340
            
        if dual_plot:
            fig = plt.figure(width="full", height=1)
341
        else:
Daniel Brown's avatar
Daniel Brown committed
342
            fig = plt.figure(width="full")   
343

344
345
346
347
348
349
350
351
352
353
354
355
356
        if detectors is None:
            detectors = [lbl.split()[0] for lbl in self.ylabels]
            
        detectors = list(set(detectors))
        detectors.sort()
        
        for det in detectors:
            if not getattr(kat, det).noplot:
                if not dual_plot:
                    plot_cmd1(self.x, _func1(self[det]), label=det)
                else:
                    pyplot.subplot(2,1,1)
                    l, = plot_cmd1(self.x, _func1(self[det]), label=det)
357
        
358
359
                    pyplot.subplot(2,1,2)
                    plot_cmd2(self.x, _func2(self[det]), color=l.get_color(), ls=l.get_linestyle(), label=det)
360
361
362
363
364

        if dual_plot:
            pyplot.subplot(2,1,1)
            pyplot.xlabel(self.xlabel, fontsize=pyplot.rcParams["font.size"])
            pyplot.xlim(self.x.min(), self.x.max())
365
366
            if title is not None: pyplot.title(title, fontsize=pyplot.rcParams["font.size"]-1)
            
367
368
369
370
371
372
373
374
375
376
377
378
379
            if "abs" in kat.yaxis: pyplot.ylabel("Absolute [au]", fontsize=pyplot.rcParams["font.size"])
            if "re" in kat.yaxis: pyplot.ylabel("Real part [au]", fontsize=pyplot.rcParams["font.size"])
    
            pyplot.subplot(2,1,2)
            pyplot.xlabel(self.xlabel, fontsize=pyplot.rcParams["font.size"])
            pyplot.xlim(self.x.min(), self.x.max())
    
            if "deg" in kat.yaxis: pyplot.ylabel("Phase [deg]", fontsize=pyplot.rcParams["font.size"])
            if "im" in kat.yaxis: pyplot.ylabel("Imaginary part [au]", fontsize=pyplot.rcParams["font.size"])
        else:
            pyplot.xlabel(self.xlabel, fontsize=pyplot.rcParams["font.size"])
            pyplot.ylabel(" [au]")
            pyplot.xlim(self.x.min(), self.x.max())
380
381
382
            if title is not None: pyplot.title(title, fontsize=pyplot.rcParams["font.size"]-1)
    
        pyplot.tight_layout()
383
    
384
385
        if legend:
            fig.axes[0].legend(loc=loc, fontsize=pyplot.rcParams["font.size"]-1)
386
387
388
389
390
391
392
393
        
        if filename is not None:
            fig.savefig(filename)
            
        if show:
            pyplot.show(fig)
        
        return fig
Daniel Brown's avatar
Daniel Brown committed
394
        
395
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
396
397
398
399
400
401
402
403
404
405
406
        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):
407
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
408
409
        out = None
        
410
        if len(idx) > 0:
411
            #out = self.y[:, idx]
412
            
413
            if len(idx) == 1:
Daniel Brown's avatar
Daniel Brown committed
414
                if "abs:deg" in self.yaxis:
415
                    out = self.y[:, idx[0]]
Daniel Brown's avatar
Daniel Brown committed
416
                elif "re:im" in self.yaxis:
417
418
                    out = self.y[:, idx[0]]
            else: 
Daniel Brown's avatar
Daniel Brown committed
419
                if "abs:deg" in self.yaxis:
420
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
Daniel Brown's avatar
Daniel Brown committed
421
                elif "re:im" in self.yaxis :
422
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
423

424
            if out is None:
425
426
                out = self.y[:, idx]

427
            if out.size == 1:
428
                return out[0].squeeze()
429
            else:
430
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
431
        else:
432
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
433
434
435
      
class katRun2D(object):
    def __init__(self):
436
        self.runtime = None
437
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
        
    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)
    
456
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
457
458
    
    def __getitem__(self, value):
459
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
460
461
462
463
464
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
465
    
466
        
467
468
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
469
        def __init__(self, param, name, amplitude, phase, signal):
470
471
472
473
474
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
475
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
476
            self.__signal = signal
477
            
478
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
479
            # various parameter names of the components, e.g. mirror xbeta is x 
480
481
482
            # 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:
483
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
484
485
486
            
        def _register_param(self, param):
            self._params.append(param)
487
488
489
        
        @property
        def removed(self): return self.__removed
490
  
491
        def remove(self):
492
493
494
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
495
496
497
            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
498
499
                self.__signal.targets.remove(self)
                self.__remove = True
500
        
501
502
503
504
505
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
506
507
508
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

509
510
511

        @property
        def phase(self): return self.__phase
512
513
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
514
515
516
517
518

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

        @property
519
        def owner(self): return self.__target._owner().name
520
521
522
523
524
525
526
527
528
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
529
    
530
531
532
533
534
535
536
    @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:
537
            return self._default_name
538
539
        else:
            return self.targets[0].name
540
541
            
    @property
Daniel Brown's avatar
Daniel Brown committed
542
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
543

544
545
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
546
            t.remove()
547
548
549
        
        del self.targets[:]
        
550
551
    @property
    def f(self): return self.__f
552
553
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
554
    
Daniel Brown's avatar
Daniel Brown committed
555
    def __init__(self, kat):
556
        self._default_name = "fsignal"
557
558
        self.targets = []
        self._params = []
559
        self.__f = Param("f", self, 0)
560
561
        self._kat = kat
        
562
563
564
565
566
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
567
        if target is None:
568
569
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
570
        if name is None:
571
            name = "sig_" + target._owner().name + "_" + target.name
572
        
Daniel Brown's avatar
Daniel Brown committed
573
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
574
575
576
577
        
    def getFinesseText(self):
        rtn = []
        
578
        if len(self.targets) == 0 and (self.f != 0 and self.f is not None):
579
580
581
582
583
584
            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
585
            
586
587
588
589
590
591
592
                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
593

594
595
596
597
598
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
599
600
601
602
603
604
605
606
607
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
    
608
Constant = namedtuple('Constant', 'name, value, usedBy')
609
610
611

id___ = 0

612
class kat(object):  
613

614
615
616
617
618
619
620
621
622
    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.
623
624
625
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
626
627
        return object.__new__(cnew)
    
628
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
629
630
        self.scene = None # scene object for GUI
        self.verbose = True
631
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
632
633
634
635
636
637
638
639
640
641
        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
642
        self.__signals = Signals(self)
643
        self.constants = {}
644
        self.vacuum = []
645
646
        self.__prevrunfilename = None
        self.printmatrix = None
647
648
649
650
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
651
652
653
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
654
655
        self.retrace = None
        self.deriv_h = None
656
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
657
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
658
659
        self.__phase = None
        self.__maxtem = None
660
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
661
        self.__time_code = None
662
        self.__yaxis = "abs" # default yaxis
663
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
664
665
666
667
668
669
670
671
672
        
        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)
673

Daniel Brown's avatar
updates    
Daniel Brown committed
674
675
676
    def deepcopy(self):
        return copy.deepcopy(self)
    
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
    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)
        
696
    def __deepcopy__(self, memo):
697
698
699
700
701
702
703
704
705
706
        """
        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
707
        result = self.__class__.__new__(self.__class__.__base__)
708
        memo[id(self)] = result
709
710
711
712
713
714
715
716
717
718
        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()
                
719
720
721
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
722
        
723
724
        return result
    
725
726
727
    @property
    def signals(self): return self.__signals

728
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
Daniel Brown's avatar
Daniel Brown committed
729
    
730
731
732
733
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
Daniel Brown's avatar
Daniel Brown committed
734
735
736
737
738
739
740
741
        values = value.split()
        
        if len(values) == 2:
            scale = values[0]
            mode = values[1]
        else:
            scale = "lin"
            mode = value
742
        
Daniel Brown's avatar
Daniel Brown committed
743
744
745
746
747
        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) ))
748
            
Daniel Brown's avatar
Daniel Brown committed
749
        self.__yaxis = str(scale + " " + mode).strip()
750

Sean Leavey's avatar
Sean Leavey committed
751
752
753
754
755
756
757
758
759
760
761
    @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

762
763
764
765
766
767
768
769
770
771
    @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
772
773
774
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
775
776
777
778
779
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
780
781
782
783
784
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
785
        
Daniel Brown's avatar
Daniel Brown committed
786
    @property
787
788
789
    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
790
    
Daniel Brown's avatar
Daniel Brown committed
791
792
793
794
795
796
797
798
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
799
800
801
802
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
803
804
805
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
806
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
807

808
809
    @staticmethod
    def logo():
810
        print ("""                                              ..-
811
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
812
813
814
815
816
817
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
818
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
819
    
820
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
821
        commands=open(katfile).read()
822
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
823
    
824
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
825
        #commands = code.split("\n")
826
        self.parseCommands(code, blocks=blocks)
827
828
829
830
831
832
833

    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
834
835
836
837
838
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
839
            
Daniel Brown's avatar
Daniel Brown committed
840
                if len(values)>0 and values[0] == 'const':
841
                
Daniel Brown's avatar
Daniel Brown committed
842
843
844
845
846
                    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], [])
847
                    else:
Daniel Brown's avatar
Daniel Brown committed
848
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
849
        
Daniel Brown's avatar
Daniel Brown committed
850
            commands_new = []
851
        
Daniel Brown's avatar
Daniel Brown committed
852
853
            for line in commands:
                values = line.split()
854
            
Daniel Brown's avatar
Daniel Brown committed
855
856
857
858
859
                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
860
                        
Daniel Brown's avatar
Daniel Brown committed
861
                            chars = [' ', '+', '-', '*', '/', ')']
862

Daniel Brown's avatar
Daniel Brown committed
863
864
                            for c in chars:
                                none_found = False
865
                            
Daniel Brown's avatar
Daniel Brown committed
866
867
868
869
870
871
                                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
872
                        
Daniel Brown's avatar
Daniel Brown committed
873
874
875
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
876
                        
Daniel Brown's avatar
Daniel Brown committed
877
                    commands_new.append(line)
878
    
Daniel Brown's avatar
Daniel Brown committed
879
            self.constants = constants
880
        
Daniel Brown's avatar
Daniel Brown committed
881
882
883
884
885
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
886
    
Daniel Brown's avatar
updates    
Daniel Brown committed
887
888
889
890
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
891
892
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
893
894
895
896
897
898
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
                
899
900
901
902
        for o in self.__blocks[name].contents:
            self.remove(o)
        
        del self.__blocks[name]
Daniel Brown's avatar
Daniel Brown committed
903
        
904
    def parseCommands(self, commands, blocks=None, addToBlock=None):
905
        try:
906
907
908
909
910
911
912
913
            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)
                
914
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
915
        
916
            commands=self.remove_comments(commands)
917
        
918
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
919
        
920
921
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
922
        
923
            for line in commands:
924
925
926
927
928
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
929
                    
930
931
932
933
934
935
936
                    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))    
937
                        
938
939
                                if newTag in self.__blocks:
                                    raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
940
                        
941
942
                                self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                                self.__currentTag = newTag
943
                    
944
945
                            if values[1] == "FTend":
                                self.__currentTag = NO_BLOCK
946
                    
947
948
949
                            continue
                    else:
                        self.__currentTag = addToBlock
Daniel Brown's avatar
Daniel Brown committed
950

951
952
953
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
954
                
955
956
957
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
958
            
959
960
961
962
963
964
965
                    # 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
966
            
967
968
                    first = line.split(" ",1)[0]
                    obj = None
969

970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
                    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)
                    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
994
995
                    elif(first[0:4] == "beam"):
                        obj = pykat.detectors.beam.parseFinesseText(line)
996
997
998
999
1000
                    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"):
For faster browsing, not all history is shown. View entire blame