finesse.py 74.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
66

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
"""
67
68

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

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

78
79
import pykat.external.six as six

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

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

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
94

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

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

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

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


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

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
173
    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
174
175
                                )

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

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

182
183
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
184
                     
185
                                             
186
187
188
189
190
191
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
192
193
class katRun(object):
    def __init__(self):
194
195
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
196
197
198
199
200
201
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
202
        self.yaxis = None
203
        
204
    def plot(self, logy=False):
205
206
207
        import pylab
        
        pylab.plot(self.x, self.y)
208
        pylab.legend(self.ylabels,0)
209
210
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
211
        
212
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
213
214
215
216
217
218
219
220
221
222
223
        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):
224
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
225
226
        out = None
        
227
        if len(idx) > 0:
228
            #out = self.y[:, idx]
229
            
230
231
232
233
234
235
236
            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":
237
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
238
239
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
240
241
242
243

            if out == None:
                out = self.y[:, idx]

244
            if out.size == 1:
245
                return out[0].squeeze()
246
            else:
247
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
248
        else:
249
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
250
251
252
      
class katRun2D(object):
    def __init__(self):
253
254
        self.runtime
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
        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)
    
273
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
274
275
    
    def __getitem__(self, value):
276
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
277
278
279
280
281
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
282
    
283
        
284
285
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
286
        def __init__(self, param, name, amplitude, phase, signal):
287
288
289
290
291
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
292
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
293
            self.__signal = signal
294
            
295
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
296
            # various parameter names of the components, e.g. mirror xbeta is x 
297
298
299
            # 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:
300
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
301
302
303
            
        def _register_param(self, param):
            self._params.append(param)
304
305
306
        
        @property
        def removed(self): return self.__removed
307
  
308
        def remove(self):
309
310
311
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
312
313
314
            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
315
316
                self.__signal.targets.remove(self)
                self.__remove = True
317
        
318
319
320
321
322
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
323
324
325
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

326
327
328

        @property
        def phase(self): return self.__phase
329
330
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
331
332
333
334
335

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

        @property
336
        def owner(self): return self.__target._owner().name
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
    @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:
353
            return "fsignal"
354
355
        else:
            return self.targets[0].name
356
357
            
    @property
Daniel Brown's avatar
Daniel Brown committed
358
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
359

360
361
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
362
            t.remove()
363
364
365
        
        del self.targets[:]
        
366
367
    @property
    def f(self): return self.__f
368
369
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
370
    
Daniel Brown's avatar
Daniel Brown committed
371
    def __init__(self, kat):
372
373
374
        self.targets = []
        self._params = []
        self.__f = Param("f", self, 1)
375
376
        self._kat = kat
        
377
378
379
380
381
382
383
384
385
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
        if target == None:
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
        if name == None:
386
            name = "sig_" + target._owner().name + "_" + target.name
387
        
Daniel Brown's avatar
Daniel Brown committed
388
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
389
390
391
392
393
394
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
395
396
397
398
399
400
401
402
403
            
            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 "")))

404
405
406
407
408
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
409
410
411
412
413
414
415
416
417
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
    
418
419
420
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
421

422
423
424
425
426
427
428
429
430
431
432
433
    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.
        return object.__new__(type(pykat.finesse.kat.__name__, (pykat.finesse.
                                                                kat,), {}), *args, **kwargs)
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
434
435
436
        
        self.scene = None # scene object for GUI
        self.verbose = True
437
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
438
439
440
441
442
443
444
445
446
447
        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
448
        self.__signals = Signals(self)
449
        self.constants = {}
450
        self.vacuum = []
451
452
        self.__prevrunfilename = None
        self.printmatrix = None
453
454
455
456
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
457
458
459
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
460
461
        self.retrace = None
        self.deriv_h = None
462
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
463
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
464
465
        self.__phase = None
        self.__maxtem = None
466
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
467
        self.__time_code = None
468
        self.__yaxis = "abs" # default yaxis
469
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
470
471
472
473
474
475
476
477
478
        
        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)
479

480
481
482
483
484
485
486
487
488
489
490
491
492
493
    def __deepcopy__(self, memo):
        cls = self.__class__
        result = cls.__new__(cls)
        memo[id(self)] = result
        
        for k, v in self.__dict__.items():
            setattr(result, k, copy.deepcopy(v, memo))
        
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
            
        return result
    
494
495
496
    @property
    def signals(self): return self.__signals

497
498
499
500
501
502
503
504
505
506
507
    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
508
509
510
511
512
513
514
515
516
517
518
    @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

519
520
521
522
523
524
525
526
527
528
    @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
529
530
531
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
532
533
534
535
536
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
537
538
539
540
541
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
542
        
Daniel Brown's avatar
Daniel Brown committed
543
    @property
544
545
546
    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
547
    
Daniel Brown's avatar
Daniel Brown committed
548
549
550
551
552
553
554
555
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
556
557
558
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
559
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
560

561
562
    @staticmethod
    def logo():
563
        print ("""                                              ..-
564
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
565
566
567
568
569
570
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
571
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
572
    
573
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
574
        commands=open(katfile).read()
575
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
576
    
577
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
578
        #commands = code.split("\n")
579
        self.parseCommands(code, blocks=blocks)
580
581
582
583
584
585
586

    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
587
588
589
590
591
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
592
            
Daniel Brown's avatar
Daniel Brown committed
593
                if len(values)>0 and values[0] == 'const':
594
                
Daniel Brown's avatar
Daniel Brown committed
595
596
597
598
599
                    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], [])
600
                    else:
Daniel Brown's avatar
Daniel Brown committed
601
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
602
        
Daniel Brown's avatar
Daniel Brown committed
603
            commands_new = []
604
        
Daniel Brown's avatar
Daniel Brown committed
605
606
            for line in commands:
                values = line.split()
607
            
Daniel Brown's avatar
Daniel Brown committed
608
609
610
611
612
                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
613
                        
Daniel Brown's avatar
Daniel Brown committed
614
                            chars = [' ', '+', '-', '*', '/', ')']
615

Daniel Brown's avatar
Daniel Brown committed
616
617
                            for c in chars:
                                none_found = False
618
                            
Daniel Brown's avatar
Daniel Brown committed
619
620
621
622
623
624
                                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
625
                        
Daniel Brown's avatar
Daniel Brown committed
626
627
628
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
629
                        
Daniel Brown's avatar
Daniel Brown committed
630
                    commands_new.append(line)
631
    
Daniel Brown's avatar
Daniel Brown committed
632
            self.constants = constants
633
        
Daniel Brown's avatar
Daniel Brown committed
634
635
636
637
638
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
Daniel Brown's avatar
Daniel Brown committed
639
        
640
    def parseCommands(self, commands, blocks=None):
641
642
        try:
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
643
        
644
            commands=self.remove_comments(commands)
645
        
646
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
647
        
648
649
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
650
        
651
            for line in commands:
652
653
654
655
656
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
657
            
658
659
660
                    if values[0] == "%%%":
                        if values[1] == "FTblock":
                            newTag = values[2]
661
                    
662
663
                            if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
                                warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
664
                        
665
666
                            if newTag in self.__blocks:
                                raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
667
                        
668
669
                            self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                            self.__currentTag = newTag
670
                    
671
672
                        if values[1] == "FTend":
                            self.__currentTag = NO_BLOCK
673
                    
674
                        continue
Daniel Brown's avatar
Daniel Brown committed
675

676
677
678
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
679
                
680
681
682
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
683
            
684
685
686
687
688
689
690
                    # 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
691
            
692
693
                    first = line.split(" ",1)[0]
                    obj = None
694
                
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
                    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)
                    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*"):
                        obj = pykat.commands.xaxis.parseFinesseText(line)
727
728
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
729
730
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
                        after_process.append(line)
                    elif(first == "scale"):
                        after_process.append(line)
                    elif(first == "pdtype"):
                        after_process.append(line)
                    elif(first == "attr"):
                        after_process.append(line)
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
                        v = line.split()
748
                
749
750
751
752
753
754
755
756
757
758
759
760
761
                        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":
762
                                self.maxtem = -1
763
                            else:
764
                                self.maxtem = int(v[1])
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
                    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))
781
                        else:
782
783
784
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
785
                            print ("Ignoring Gnuplot/Python terminal command '{0}'".format(line))
Daniel Brown's avatar
Daniel Brown committed
786
787
                    elif(first == "fsig"):
                        after_process.append(line)
788
789
790
                    elif(first == "noplot"):
                        obj = line
                        self.__blocks[self.__currentTag].contents.append(line) 
791
                    else:
792
                        if self.verbose:
793
                            print ("Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line))
794
                    
795
796
797
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
798
            
799
                    if obj != None and not isinstance(obj, six.string_types):
800
801
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
802
                            print ("Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line))
803
                    
804
805
806
                        self.add(obj)
                
                
807
808
809
810
811
812
813
814
815
            # now process all the varous gauss/attr etc. commands which require
            # components to exist first before they can be processed
            for line in after_process:
                first = line.split(" ",1)[0]            
                if first == "gauss" or first == "gauss*" or first == "gauss**":
                    pykat.commands.gauss.parseFinesseText(line, self)
                elif (first == "scale"):
                    v = line.split()
                    accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "degs"]
Daniel Brown's avatar
Daniel Brown committed
816
                
817
818
                    if len(v) == 3:
                        component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
819
                    
820
821
822
823
824
825
826
                        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
827
                            
828
829
830
831
832
833
834
835
836
                        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])
837
                    else:
838
839
840
841
842
843
844
845
846
                        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))
847
                    else:
848
849
850
                        raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
                elif(first == "attr"):
                    v = line.split()
851

852
853
                    if len(v) < 4:
                        raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
854
                    else:
855
856
857
858
859
860
861
                        # 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
862
                
863
864
                        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
865
                                                
866
867
868
                        # 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
869

870
                        comp.parseAttributes(kv)
871
                    
872
                elif(first == "fsig"):
873
                
874
                    v = line.split()
875
                
876
                    name = str(v[1])
Daniel Brown's avatar
Daniel Brown committed
877
                
878
879
                    if v[2] not in self.__components:
                        raise pkex.BasePyKatException("Could not find the component '{0}'. Line: '{1}'".format(v[2], line))
880
                
881
                    comp = self.__components[v[2]]
Daniel Brown's avatar
Daniel Brown committed
882
                
883
884
                    if comp._default_fsig() == None:
                        raise pkex.BasePyKatException("Component '{0}' cannot be fsig'd. Line: '{1}'".format(comp.name, line))
Daniel Brown's avatar
Daniel Brown committed
885
                    
886
887
                    param = None
                    amp = None
Daniel Brown's avatar
Daniel Brown committed
888
                
889
890
                    if len(v) == 5:
                        param == None
891
892
                        freq = float(v[3])
                        phase = float(v[4])
893
894
895
896
897
898
899
900
901
902
                    elif len(v) == 6:
                        if v[3].isdigit():
                            freq = float(v[3])
                            phase = float(v[4])
                            amp = float(v[5])
                        else:
                            param = v[3]
                            freq = float(v[4])
                            phase = float(v[5])
                    elif len(v) == 7:
903
904
905
                        param = v[3]
                        freq = float(v[4])
                        phase = float(v[5])
906
907
908
                        amp = float(v[6])
                    else:
                        raise pkex.BasePyKatException("'{0}' isnot a valid fsig command".format(line))
909
910
                    
                    self.signals.f = freq
911
                    self.signals.apply(comp._default_fsig(), amp, phase, name)
912
                
913
914
                else:
                    raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
915
                    
916
            self.__currentTag = NO_BLOCK 
917
        
918
919
920
921
922

        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error parsing line: '%s':"%  line, ex)
            sys.exit(1)
            
Daniel Brown's avatar
Daniel Brown committed
923
924
925
926
927
928
929
930
931
932
933
934
    def saveScript(self, filename=None):
        """
        Saves the current kat object to a Finesse input file
        """
        try:
            katScript = "".join(self.generateKatScript())       
            katfile = open(filename,'w')
            katfile.writelines(katScript)
            katfile.flush()
            katfile.close()

        except pkex.BasePyKatException as ex:
935
            print (ex)
Daniel Brown's avatar
Daniel Brown committed
936

Daniel Brown's avatar
Daniel Brown committed
937
            
Daniel Brown's avatar
Daniel Brown committed
938
939
940
941
942
943
944
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
945
946

    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False, kat_name=None, cmd_args=None, getTraceData=False):
Daniel Brown's avatar
Daniel Brown committed
947
948
949
950
        """ 
        Runs the current simulation setup that has been built thus far.
        It returns a katRun or katRun2D object which is populated with the various
        data from the simulation run.
Sean Leavey's avatar
Sean Leavey committed
951
        printout=1 prints the Finesse banner
952
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
953
954
955
956
957
        plot (string) - Sets gnuterm for plotting
        save_output (bool) - if true does not delete out file
        save_kat (bool) - if true does not delete kat file
        kat_name (string) - name of kat file if needed, will be randomly generated otherwise
        cmd_args (list of strings) - command line flags to pass to FINESSE
958
959
960
961
962
        getTraceData (bool) - If true a list of dictionaries is returned along with the
        output file. Each dictionary is the result of the beam tracing
        that Finesse performs, the keys are the node names and the values
        are the x and y beam parameters. If no tracing is done a None
        is returned.
Daniel Brown's avatar
Daniel Brown committed
963
964
965
966
967
968
969
970
971
972
973
974
        """
        start = datetime.datetime.now()
        
        try:        
            if not hasattr(self, "xaxis") and self.noxaxis != None and self.noxaxis == False:
                raise pkex.BasePyKatException("No xaxis was defined")
            
            if len(self.__katdir) == 0:
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
                if self.__finesse_dir == None :
975
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
            else:
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
            
            # check if kat file exists and it is executable by user        
            if not (os.path.isfile(kat_exec) and os.access(kat_exec, os.X_OK)):
991
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
992
                
993
994
            if self.verbose: print ("--------------------------------------------------------------")
            if self.verbose: print ("Running kat - Started at " + str(start))
Daniel Brown's avatar
Daniel Brown committed
995
            
996
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
997
998
999
1000
                r = katRun2D()
            else:
                r = katRun()
                
For faster browsing, not all history is shown. View entire blame