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

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

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

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

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

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

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

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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
    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

        if ":" in kat.yaxis:
            fig = plt.figure(width="full", height=1)
            dual_plot = True
        else:
            fig = plt.figure(width="full")

        for lbl in self.ylabels:
            lbl = lbl.split()[0]
            if not dual_plot:
                plot_cmd(self.x, np.abs(self[lbl]))
            else:
                pyplot.subplot(2,1,1)
                plot_cmd(self.x, np.abs(self[lbl]))
279
        
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
                pyplot.subplot(2,1,2)
                plot_cmd(self.x, np.angle(self[lbl]))

        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
311
        
312
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
313
314
315
316
317
318
319
320
321
322
323
        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):
324
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
325
326
        out = None
        
327
        if len(idx) > 0:
328
            #out = self.y[:, idx]
329
            
330
331
332
333
334
335
336
            if len(idx) == 1:
                if self.yaxis == "abs:deg":
                    out = self.y[:, idx[0]]
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]]
            else: 
                if self.yaxis == "abs:deg":
337
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
338
339
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
340

341
            if out is None:
342
343
                out = self.y[:, idx]

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

        @property
        def amplitude(self): return self.__amplitude
423
424
425
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

426
427
428

        @property
        def phase(self): return self.__phase
429
430
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
431
432
433
434
435

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

        @property
436
        def owner(self): return self.__target._owner().name
437
438
439
440
441
442
443
444
445
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
446
    
447
448
449
450
451
452
453
    @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:
454
            return self._default_name
455
456
        else:
            return self.targets[0].name
457
458
            
    @property
Daniel Brown's avatar
Daniel Brown committed
459
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
460

461
462
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
463
            t.remove()
464
465
466
        
        del self.targets[:]
        
467
468
    @property
    def f(self): return self.__f
469
470
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
471
    
Daniel Brown's avatar
Daniel Brown committed
472
    def __init__(self, kat):
473
        self._default_name = "fsignal"
474
475
        self.targets = []
        self._params = []
476
        self.__f = Param("f", self, 0)
477
478
        self._kat = kat
        
479
480
481
482
483
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
484
        if target is None:
485
486
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
487
        if name is None:
488
            name = "sig_" + target._owner().name + "_" + target.name
489
        
Daniel Brown's avatar
Daniel Brown committed
490
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
491
492
493
494
        
    def getFinesseText(self):
        rtn = []
        
495
        if len(self.targets) == 0 and (self.f != 0 and self.f is not None):
496
497
498
499
500
501
            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
502
            
503
504
505
506
507
508
509
                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
510

511
512
513
514
515
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
516
517
518
519
520
521
522
523
524
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
    
525
Constant = namedtuple('Constant', 'name, value, usedBy')
526
527
528

id___ = 0

529
class kat(object):  
530

531
532
533
534
535
536
537
538
539
    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.
540
541
542
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
543
544
        return object.__new__(cnew)
    
545
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
546
547
        self.scene = None # scene object for GUI
        self.verbose = True
548
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
549
550
551
552
553
554
555
556
557
558
        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
559
        self.__signals = Signals(self)
560
        self.constants = {}
561
        self.vacuum = []
562
563
        self.__prevrunfilename = None
        self.printmatrix = None
564
565
566
567
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
568
569
570
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
571
572
        self.retrace = None
        self.deriv_h = None
573
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
574
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
575
576
        self.__phase = None
        self.__maxtem = None
577
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
578
        self.__time_code = None
579
        self.__yaxis = "abs" # default yaxis
580
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
581
582
583
584
585
586
587
588
589
        
        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)
590

Daniel Brown's avatar
updates    
Daniel Brown committed
591
592
593
    def deepcopy(self):
        return copy.deepcopy(self)
    
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
    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)
        
613
    def __deepcopy__(self, memo):
614
615
616
617
618
619
620
621
622
623
        """
        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
624
        result = self.__class__.__new__(self.__class__.__base__)
625
        memo[id(self)] = result
626
627
628
629
630
631
632
633
634
635
        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()
                
636
637
638
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
639
        
640
641
        return result
    
642
643
644
    @property
    def signals(self): return self.__signals

645
646
647
648
649
650
651
652
653
654
655
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
        
        if not str(value) in self.yaxis_options:
            raise pkex.BasePyKatException("yaxis value '{0}' is not a value option. Valid options are: {1}".format(str(value), ",".join(self.yaxis_options) ))
            
        self.__yaxis = str(value)

Sean Leavey's avatar
Sean Leavey committed
656
657
658
659
660
661
662
663
664
665
666
    @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

667
668
669
670
671
672
673
674
675
676
    @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
677
678
679
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
680
681
682
683
684
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
685
686
687
688
689
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
690
        
Daniel Brown's avatar
Daniel Brown committed
691
    @property
692
693
694
    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
695
    
Daniel Brown's avatar
Daniel Brown committed
696
697
698
699
700
701
702
703
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
704
705
706
707
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
708
709
710
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
711
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
712

713
714
    @staticmethod
    def logo():
715
        print ("""                                              ..-
716
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
717
718
719
720
721
722
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
723
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
724
    
725
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
726
        commands=open(katfile).read()
727
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
728
    
729
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
730
        #commands = code.split("\n")
731
        self.parseCommands(code, blocks=blocks)
732
733
734
735
736
737
738

    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
739
740
741
742
743
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
744
            
Daniel Brown's avatar
Daniel Brown committed
745
                if len(values)>0 and values[0] == 'const':
746
                
Daniel Brown's avatar
Daniel Brown committed
747
748
749
750
751
                    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], [])
752
                    else:
Daniel Brown's avatar
Daniel Brown committed
753
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
754
        
Daniel Brown's avatar
Daniel Brown committed
755
            commands_new = []
756
        
Daniel Brown's avatar
Daniel Brown committed
757
758
            for line in commands:
                values = line.split()
759
            
Daniel Brown's avatar
Daniel Brown committed
760
761
762
763
764
                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
765
                        
Daniel Brown's avatar
Daniel Brown committed
766
                            chars = [' ', '+', '-', '*', '/', ')']
767

Daniel Brown's avatar
Daniel Brown committed
768
769
                            for c in chars:
                                none_found = False
770
                            
Daniel Brown's avatar
Daniel Brown committed
771
772
773
774
775
776
                                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
777
                        
Daniel Brown's avatar
Daniel Brown committed
778
779
780
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
781
                        
Daniel Brown's avatar
Daniel Brown committed
782
                    commands_new.append(line)
783
    
Daniel Brown's avatar
Daniel Brown committed
784
            self.constants = constants
785
        
Daniel Brown's avatar
Daniel Brown committed
786
787
788
789
790
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
791
    
Daniel Brown's avatar
updates    
Daniel Brown committed
792
793
794
795
    def getBlocks(self):
        return self.__blocks.keys()
    
    def removeBlock(self, name, failOnBlockNotFound=True):
796
797
        
        if name not in self.__blocks:
Daniel Brown's avatar
updates    
Daniel Brown committed
798
799
800
801
802
803
            if failOnBlockNotFound:
                pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
                sys.exit(1)
            else:
                return
                
804
805
806
807
        for o in self.__blocks[name].contents:
            self.remove(o)
        
        del self.__blocks[name]
Daniel Brown's avatar
Daniel Brown committed
808
        
809
    def parseCommands(self, commands, blocks=None, addToBlock=None):
810
        try:
811
812
813
814
815
816
817
818
            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)
                
819
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
820
        
821
            commands=self.remove_comments(commands)
822
        
823
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
824
        
825
826
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
827
        
828
            for line in commands:
829
830
831
832
833
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
834
                    
835
836
837
838
839
840
841
                    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))    
842
                        
843
844
                                if newTag in self.__blocks:
                                    raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
845
                        
846
847
                                self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                                self.__currentTag = newTag
848
                    
849
850
                            if values[1] == "FTend":
                                self.__currentTag = NO_BLOCK
851
                    
852
853
854
                            continue
                    else:
                        self.__currentTag = addToBlock
Daniel Brown's avatar
Daniel Brown committed
855

856
857
858
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
859
                
860
861
862
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
863
            
864
865
866
867
868
869
870
                    # 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
871
            
872
873
                    first = line.split(" ",1)[0]
                    obj = None
874

875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
                    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
899
900
                    elif(first[0:4] == "beam"):
                        obj = pykat.detectors.beam.parseFinesseText(line)
901
902
903
904
905
906
907
                    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*"):
908
                        self.noxaxis = False
909
                        obj = pykat.commands.xaxis.parseFinesseText(line)
910
911
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
912
913
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
914
915
916
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
917
                        after_process.append((line, self.__currentTag))
918
                    elif(first == "scale"):
919
                        after_process.append((line, self.__currentTag))
920
                    elif(first == "pdtype"):
921
                        after_process.append((line, self.__currentTag))
922
                    elif(first == "cav"):
923
924
925
926
927
928
929
                        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))
930
                    elif(first == "attr"):
931
                        after_process.append((line, self.__currentTag))
932
933
934
935
936
937
938
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
                        v = line.split()
939
                
940
941
942
943
944
945
946
947
948
949
950
951
952
                        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":
953
                                self.maxtem = -1
954
                            else:
955
                                self.maxtem = int(v[1])
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
                    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))
972
                        else:
973
974
975
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
976
                            print ("Ignoring Gnuplot/Python terminal command '{0}'".format(line))
Daniel Brown's avatar
Daniel Brown committed
977
                    elif(first == "fsig"):
978
                        after_process.append((line, self.__currentTag))
979
                    elif(first == "noplot"):
980
                        after_process.append((line, self.__currentTag))
981
                    else:
982
                        if self.verbose:
983
                            print ("Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line))
984
                    
985
986
987
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
988
            
989
                    if obj != None and not isinstance(obj, six.string_types):
990
991
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
992
                            print ("Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line))
993
                    
994
                        self.add(obj, block=self.__currentTag)
995
996
                
                
997
998
            # now process all the varous gauss/attr etc. commands which require
            # components to exist first before they can be processed
999
1000
            for item in after_process:
                line = item[0]
1001
                first, rest = line.split(" ",1)
1002
1003
                block = item[1]
                
1004
1005
                if first == "gauss" or first == "gauss*" or first == "gauss**":
                    pykat.commands.gauss.parseFinesseText(line, self)
1006
1007
                    
                elif (first == "cav"):
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
                    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)
1018
1019
1020
1021
1022
                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
1023
                    
1024
1025
                elif (first == "scale"):
                    v = line.split()
1026
                    accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "deg", "rad", "1/deg", "1/rad",]
Daniel Brown's avatar
Daniel Brown committed
1027
                
1028
1029
                    if len(v) == 3:
                        component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
1030
                    
1031
1032
1033
1034
1035
1036
1037
                        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
1038
                            
1039
1040
1041
1042
1043
1044
1045
1046
1047
                        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])
1048
                    else:
1049
1050
1051
1052
1053
1054
1055
1056
1057
                        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))
1058
                    else:
1059
1060
1061
                        raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
                elif(first == "attr"):
                    v = line.split()
1062

1063
1064
                    if len(v) < 4:
                        raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
1065
                    else:
1066
1067
1068
1069
1070
1071
1072
                        # 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
1073
                
1074
1075
                        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
1076
                                                
1077
1078
1079
                        # 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
1080

1081
                        comp.parseAttributes(kv)
1082
                    
1083
                elif(first == "fsig"):
1084
                
1085
                    v = line.split()
1086
                
1087
                    name = str(v[1])
Daniel Brown's avatar
Daniel Brown committed
1088
                
1089
1090
1091
1092
1093
1094
                    if len(v) == 3:
                        self.signals._default_name = name
                        self.signals.f = SIfloat(v[2])
                    else:
                        if v[2] not in self.__components:
                            raise pkex.BasePyKatException("Could not find the component '{0}'. Line: '{1}'".format(v[2], line))
1095
                
1096
                        comp = self.__components[v[2]]
Daniel Brown's avatar
Daniel Brown committed
1097
                
1098
1099
                        if comp._default_fsig() is None:
                            raise pkex.BasePyKatException("Component '{0}' cannot be fsig'd. Line: '{1}'".format(comp.name, line))
Daniel Brown's avatar
Daniel Brown committed
1100
                    
1101
1102
                        param_name = None
                        amp = None
Daniel Brown's avatar
Daniel Brown committed
1103
                    
1104
1105
1106
1107
1108
                        if len(v) == 3:
                            self.signals._default_name = name
                            freq = SIfloat(v[3])
                        elif len(v) == 5:
                            #param is None
Daniel Brown's avatar
Daniel Brown committed
1109
1110
                            freq = SIfloat(v[3])
                            phase = SIfloat(v[4])
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
                        elif len(v) == 6:
                        
                            try:
                                SIfloat(v[3])
                                isFloat = True
                            except:
                                isFloat = False
                            
                            if isFloat:
                                freq = SIfloat(v[3])
                                phase = SIfloat(v[4])
                                amp = SIfloat(v[5])
                            else:
                                param_name = v[3]
                                freq = SIfloat(v[4])
                                phase = SIfloat(v[5])
                        
                        elif len(v) == 7:
1129
                            param_name = v[3]
Daniel Brown's avatar
Daniel Brown committed
1130
1131
                            freq = SIfloat(v[4])
                            phase = SIfloat(v[5])
1132
1133
1134
                            amp = SIfloat(v[6])
                        else:
                            raise pkex.BasePyKatException("'{0}' isnot a valid fsig command".format(line))
1135
                    
1136
                        self.signals.f = freq
1137
                    
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
                        param = None
                
                        if param_name is None:
                            param = comp._default_fsig()
                        else:
                            for p in comp._params:
                                if p.canFsig and p.fsigName == param_name:
                                    param = p
                                    break
                    
                            if param is None:
                                raise pkex.BasePyKatException("Line: '{0}': {1} is not a valid fsig target for {2}".format(line, param_name, comp.name))