finesse.py 88.3 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
        
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
    def plot(self, filename=None, show=True):
        import matplotlib.pyplot as pyplot
        import pykat.plotting as plt

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

        plot_cmd = None

        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
265
266
        _func1 = np.abs
        _func2 = None
267

Daniel Brown's avatar
Daniel Brown committed
268
269
270
271
272
273
274
275
276
277
278
        if "re:im" in kat.yaxis:
            _func1 = np.real
            _func2 = np.imag
            dual_plot = True
        elif "abs:deg" in kat.yaxis:
            _func1 = np.abs
            _func2 = lambda x: np.rad2deg(np.angle(x))
            dual_plot = True
        elif "db:deg" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
            _func2 = lambda x: np.rad2deg(np.angle(x))
279
            dual_plot = True
Daniel Brown's avatar
Daniel Brown committed
280
281
282
283
284
285
286
287
288
        elif "abs" in kat.yaxis:
            _func1 = np.abs
        elif "db" in kat.yaxis:
            _func1 = lambda x: 10*np.log10(x)
        elif "deg" in kat.yaxis:
            _func1 = lambda x: np.rad2deg(np.angle(x))
            
        if dual_plot:
            fig = plt.figure(width="full", height=1)
289
        else:
Daniel Brown's avatar
Daniel Brown committed
290
            fig = plt.figure(width="full")   
291
292
293
294

        for lbl in self.ylabels:
            lbl = lbl.split()[0]
            if not dual_plot:
Daniel Brown's avatar
Daniel Brown committed
295
                plot_cmd(self.x, _func1(self[lbl]))
296
297
            else:
                pyplot.subplot(2,1,1)
Daniel Brown's avatar
Daniel Brown committed
298
                l, = plot_cmd(self.x, _func1(self[lbl]))
299
        
300
                pyplot.subplot(2,1,2)
Daniel Brown's avatar
Daniel Brown committed
301
                pyplot.plot(self.x, _func2(self[lbl]), color=l.get_color(), ls=l.get_linestyle())
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330

        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())
    
            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())
    
        fig.tight_layout()
        
        if filename is not None:
            fig.savefig(filename)
            
        if show:
            pyplot.show(fig)
        
        return fig
Daniel Brown's avatar
Daniel Brown committed
331
        
332
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
333
334
335
336
337
338
339
340
341
342
343
        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):
344
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
345
346
        out = None
        
347
        if len(idx) > 0:
348
            #out = self.y[:, idx]
349
            
350
            if len(idx) == 1:
Daniel Brown's avatar
Daniel Brown committed
351
                if "abs:deg" in self.yaxis:
352
                    out = self.y[:, idx[0]]
Daniel Brown's avatar
Daniel Brown committed
353
                elif "re:im" in self.yaxis:
354
355
                    out = self.y[:, idx[0]]
            else: 
Daniel Brown's avatar
Daniel Brown committed
356
                if "abs:deg" in self.yaxis:
357
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
Daniel Brown's avatar
Daniel Brown committed
358
                elif "re:im" in self.yaxis :
359
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
360

361
            if out is None:
362
363
                out = self.y[:, idx]

364
            if out.size == 1:
365
                return out[0].squeeze()
366
            else:
367
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
368
        else:
369
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
370
371
372
      
class katRun2D(object):
    def __init__(self):
373
        self.runtime = None
374
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
        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)
    
393
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
394
395
    
    def __getitem__(self, value):
396
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
397
398
399
400
401
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
402
    
403
        
404
405
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
406
        def __init__(self, param, name, amplitude, phase, signal):
407
408
409
410
411
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
412
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
413
            self.__signal = signal
414
            
415
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
416
            # various parameter names of the components, e.g. mirror xbeta is x 
417
418
419
            # 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:
420
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
421
422
423
            
        def _register_param(self, param):
            self._params.append(param)
424
425
426
        
        @property
        def removed(self): return self.__removed
427
  
428
        def remove(self):
429
430
431
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
432
433
434
            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
435
436
                self.__signal.targets.remove(self)
                self.__remove = True
437
        
438
439
440
441
442
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
443
444
445
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

446
447
448

        @property
        def phase(self): return self.__phase
449
450
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
451
452
453
454
455

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

        @property
456
        def owner(self): return self.__target._owner().name
457
458
459
460
461
462
463
464
465
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
466
    
467
468
469
470
471
472
473
    @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:
474
            return self._default_name
475
476
        else:
            return self.targets[0].name
477
478
            
    @property
Daniel Brown's avatar
Daniel Brown committed
479
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
480

481
482
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
483
            t.remove()
484
485
486
        
        del self.targets[:]
        
487
488
    @property
    def f(self): return self.__f
489
490
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
491
    
Daniel Brown's avatar
Daniel Brown committed
492
    def __init__(self, kat):
493
        self._default_name = "fsignal"
494
495
        self.targets = []
        self._params = []
496
        self.__f = Param("f", self, 0)
497
498
        self._kat = kat
        
499
500
501
502
503
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
504
        if target is None:
505
506
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
507
        if name is None:
508
            name = "sig_" + target._owner().name + "_" + target.name
509
        
Daniel Brown's avatar
Daniel Brown committed
510
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
511
512
513
514
        
    def getFinesseText(self):
        rtn = []
        
515
        if len(self.targets) == 0 and (self.f != 0 and self.f is not None):
516
517
518
519
520
521
            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
522
            
523
524
525
526
527
528
529
                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
530

531
532
533
534
535
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
536
537
538
539
540
541
542
543
544
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
    
545
Constant = namedtuple('Constant', 'name, value, usedBy')
546
547
548

id___ = 0

549
class kat(object):  
550

551
552
553
554
555
556
557
558
559
    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.
560
561
562
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
563
564
        return object.__new__(cnew)
    
565
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
566
567
        self.scene = None # scene object for GUI
        self.verbose = True
568
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
569
570
571
572
573
574
575
576
577
578
        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
579
        self.__signals = Signals(self)
580
        self.constants = {}
581
        self.vacuum = []
582
583
        self.__prevrunfilename = None
        self.printmatrix = None
584
585
586
587
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
588
589
590
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
591
592
        self.retrace = None
        self.deriv_h = None
593
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
594
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
595
596
        self.__phase = None
        self.__maxtem = None
597
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
598
        self.__time_code = None
599
        self.__yaxis = "abs" # default yaxis
600
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
601
602
603
604
605
606
607
608
609
        
        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)
610

Daniel Brown's avatar
updates    
Daniel Brown committed
611
612
613
    def deepcopy(self):
        return copy.deepcopy(self)
    
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
    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)
        
633
    def __deepcopy__(self, memo):
634
635
636
637
638
639
640
641
642
643
        """
        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
644
        result = self.__class__.__new__(self.__class__.__base__)
645
        memo[id(self)] = result
646
647
648
649
650
651
652
653
654
655
        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()
                
656
657
658
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
659
        
660
661
        return result
    
662
663
664
    @property
    def signals(self): return self.__signals

665
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
Daniel Brown's avatar
Daniel Brown committed
666
    
667
668
669
670
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
Daniel Brown's avatar
Daniel Brown committed
671
672
673
674
675
676
677
678
        values = value.split()
        
        if len(values) == 2:
            scale = values[0]
            mode = values[1]
        else:
            scale = "lin"
            mode = value
679
        
Daniel Brown's avatar
Daniel Brown committed
680
681
682
683
684
        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) ))
685
            
Daniel Brown's avatar
Daniel Brown committed
686
        self.__yaxis = str(scale + " " + mode).strip()
687

Sean Leavey's avatar
Sean Leavey committed
688
689
690
691
692
693
694
695
696
697
698
    @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

699
700
701
702
703
704
705
706
707
708
    @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
709
710
711
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
712
713
714
715
716
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
717
718
719
720
721
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
722
        
Daniel Brown's avatar
Daniel Brown committed
723
    @property
724
725
726
    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
727
    
Daniel Brown's avatar
Daniel Brown committed
728
729
730
731
732
733
734
735
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
736
737
738
739
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
740
741
742
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
743
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
744

745
746
    @staticmethod
    def logo():
747
        print ("""                                              ..-
748
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
749
750
751
752
753
754
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
755
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
756
    
757
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
758
        commands=open(katfile).read()
759
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
760
    
761
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
762
        #commands = code.split("\n")
763
        self.parseCommands(code, blocks=blocks)
764
765
766
767
768
769
770

    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
771
772
773
774
775
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
776
            
Daniel Brown's avatar
Daniel Brown committed
777
                if len(values)>0 and values[0] == 'const':
778
                
Daniel Brown's avatar
Daniel Brown committed
779
780
781
782
783
                    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], [])
784
                    else:
Daniel Brown's avatar
Daniel Brown committed
785
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
786
        
Daniel Brown's avatar
Daniel Brown committed
787
            commands_new = []
788
        
Daniel Brown's avatar
Daniel Brown committed
789
790
            for line in commands:
                values = line.split()
791
            
Daniel Brown's avatar
Daniel Brown committed
792
793
794
795
796
                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
797
                        
Daniel Brown's avatar
Daniel Brown committed
798
                            chars = [' ', '+', '-', '*', '/', ')']
799

Daniel Brown's avatar
Daniel Brown committed
800
801
                            for c in chars:
                                none_found = False
802
                            
Daniel Brown's avatar
Daniel Brown committed
803
804
805
806
807
808
                                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
809
                        
Daniel Brown's avatar
Daniel Brown committed
810
811
812
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
813
                        
Daniel Brown's avatar
Daniel Brown committed
814
                    commands_new.append(line)
815
    
Daniel Brown's avatar
Daniel Brown committed
816
            self.constants = constants
817
        
Daniel Brown's avatar
Daniel Brown committed
818
819
820
821
822
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
823
    
Daniel Brown's avatar
updates    
Daniel Brown committed
824
825
826
827
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
828
829
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
830
831
832
833
834
835
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
                
836
837
838
839
        for o in self.__blocks[name].contents:
            self.remove(o)
        
        del self.__blocks[name]
Daniel Brown's avatar
Daniel Brown committed
840
        
841
    def parseCommands(self, commands, blocks=None, addToBlock=None):
842
        try:
843
844
845
846
847
848
849
850
            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)
                
851
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
852
        
853
            commands=self.remove_comments(commands)
854
        
855
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
856
        
857
858
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
859
        
860
            for line in commands:
861
862
863
864
865
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
866
                    
867
868
869
870
871
872
873
                    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))    
874
                        
875
876
                                if newTag in self.__blocks:
                                    raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
877
                        
878
879
                                self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                                self.__currentTag = newTag
880
                    
881
882
                            if values[1] == "FTend":
                                self.__currentTag = NO_BLOCK
883
                    
884
885
886
                            continue
                    else:
                        self.__currentTag = addToBlock
Daniel Brown's avatar
Daniel Brown committed
887

888
889
890
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
891
                
892
893
894
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
895
            
896
897
898
899
900
901
902
                    # 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
903
            
904
905
                    first = line.split(" ",1)[0]
                    obj = None
906

907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
                    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
931
932
                    elif(first[0:4] == "beam"):
                        obj = pykat.detectors.beam.parseFinesseText(line)
933
934
935
936
937
938
939
                    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*"):
940
                        self.noxaxis = False
941
                        obj = pykat.commands.xaxis.parseFinesseText(line)
942
943
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
944
945
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
946
947
948
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
949
                        after_process.append((line, self.__currentTag))
950
                    elif(first == "scale"):
951
                        after_process.append((line, self.__currentTag))
952
                    elif(first == "pdtype"):
953
                        after_process.append((line, self.__currentTag))
954
                    elif(first == "cav"):
955
956
957
958
959
960
961
                        after_process.append((line, self.__currentTag))
                    elif(first == "func"):
                        after_process.append((line, self.__currentTag))
                    elif(first == "variable"):
                        after_process.append((line, self.__currentTag))
                    elif(first == "lock"):
                        after_process.append((line, self.__currentTag))
962
                    elif(first == "attr"):
963
                        after_process.append((line, self.__currentTag))
964
965
966
967
968
969
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
Daniel Brown's avatar
Daniel Brown committed
970
                        v = line.split(" ", 1)
971
972
973
974
975
976
977
978
979
980
981
982
983
                        self.yaxis = v[-1]
                    elif(first == "phase"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
                        else:
                            self.phase = int(v[1])
                    elif(first == "maxtem"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                        else:
                            if v[1] == "off":
984
                                self.maxtem = -1
985
                            else:
986
                                self.maxtem = int(v[1])
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
                    elif(first == "trace"):
                        v = line.split()
                        if len(v) > 2:
                            raise pkex.BasePyKatException("Trace command `{0}` is incorrect.".format(line))
                        elif len(v) == 2:
                            self.trace = v[1]
                    elif(first == "retrace"):
                        v = line.split()
                        if len(v) > 2:
                            raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
                        elif len(v) == 2:
                            self.retrace = v[1]                        
                    elif(first == "deriv_h"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
1003
                        else:
1004
1005
1006
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
1007
                            print ("Ignoring Gnuplot/Python terminal command '{0}'".format(line))
Daniel Brown's avatar
Daniel Brown committed
1008
                    elif(first == "fsig"):
1009
                        after_process.append((line, self.__currentTag))
1010
                    elif(first == "noplot"):
1011
                        after_process.append((line, self.__currentTag))
1012
                    else:
1013
                        if self.verbose:
1014
                            print ("Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line))
1015
                    
1016
1017
1018
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
1019
            
1020
                    if obj != None and not isinstance(obj, six.string_types):
1021
1022
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
1023
                            print ("Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line))
1024
                    
1025
                        self.add(obj, block=self.__currentTag)
1026
1027
                
                
1028
1029
            # now process all the varous gauss/attr etc. commands which require
            # components to exist first before they can be processed
1030
1031
            for item in after_process:
                line = item[0]
1032
                first, rest = line.split(" ",1)
1033
1034
                block = item[1]
                
1035
1036
                if first == "gauss" or first == "gauss*" or first == "gauss**":
                    pykat.commands.gauss.parseFinesseText(line, self)
1037
1038
                    
                elif (first == "cav"):
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
                    self.add(pykat.commands.cavity.parseFinesseText(line, self), block=block)
                    
                elif (first == "lock"):
                    self.add(pykat.commands.lock.parseFinesseText(line, self), block=block)
                    
                elif (first == "func"):
                    self.add(pykat.commands.func.parseFinesseText(line, self), block=block)
                    
                elif (first == "variable"):
                    self.add(pykat.commands.variable.parseFinesseText(line, self), block=block)
1049
1050
1051
1052
1053
                elif (first == "noplot"):
                    if not hasattr(self, rest):
                        raise pkex.BasePyKatException("noplot command `{0}` refers to non-existing detector".format(line))
                        
                    getattr(self, rest).noplot = True
1054
                    
1055
1056
                elif (first == "scale"):
                    v = line.split()
1057
                    accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "deg", "rad", "1/deg", "1/rad",]
Daniel Brown's avatar
Daniel Brown committed
1058
                
1059
1060
                    if len(v) == 3:
                        component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
1061
                    
1062
1063
1064
1065
1066
1067
1068
                        if v[1].lower() in accepted:
                            val = v[1]
                        else:
                            try:
                                val = SIfloat(v[1])
                            except ValueError as ex:
                                raise pkex.BasePyKatException("Line `{0}`:\nAccepted scale values are decimal numbers or %s." % (line,str(accepted)))
Daniel Brown's avatar
Daniel Brown committed
1069
                            
1070
1071
1072
1073
1074
1075
1076
1077
1078
                        if component_name in self.__detectors :
                            self.__detectors[component_name].scale.append(val)
                        else:
                            raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
                    elif len(v) == 2:
                        if v[1] == "meter" or v[1] == "ampere" or v[1] == "deg":
                            self.scale = v[1]
                        else:
                            self.scale = SIfloat(v[1])
1079
                    else:
1080
1081
1082
1083
1084
1085
1086
1087
1088
                        raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
                elif (first == "pdtype"):
                    v = line.split()
                    if len(v) == 3:
                        component_name = v[1]
                        if component_name in self.__detectors :
                            self.__detectors[component_name].pdtype = v[2]
                        else:
                            raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
1089
                    else:
1090
1091
1092
                        raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
                elif(first == "attr"):
                    v = line.split()
1093

1094
1095
                    if len(v) < 4:
                        raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
1096
                    else:
1097
1098
1099
1100
1101
1102
1103
                        # get the component/detector in question
                        if v[1] in self.__components:
                            comp = self.__components[v[1]]
                        elif v[1] in self.__detectors:
                            comp = self.__detectors[v[1]]
                        else:
                            raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
Daniel Brown's avatar
Daniel Brown committed
1104
                
1105
1106
                        if len(v[2:]) % 2 == 1:
                            raise pkex.BasePyKatException("Attr command '{0}' must specify both parameter and value pairs".format(line))
Daniel Brown's avatar
Daniel Brown committed
1107
                                                
1108
1109
1110
                        # convert split list to key value pairs
                        #kv = dict(itertools.izip_longest(*[iter(v[2:])] * 2, fillvalue=None))
                        kv = dict(izip_longest(*[iter(v[2:])] * 2, fillvalue=None))
Daniel Brown's avatar
Daniel Brown committed
1111

1112
                        comp.parseAttributes(kv)
1113
                    
1114
                elif(first == "fsig"):
1115
                
1116
                    v = line.split()
1117
                
1118
                    name = str(v[1])