detectors.py 35.6 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
# -*- coding: utf-8 -*-
"""
Daniel Brown's avatar
Daniel Brown committed
3
Created on Fri Feb 01 0split()9:09:10 2013
Daniel Brown's avatar
Daniel Brown committed
4
5
6

@author: Daniel
"""
7
8
9
10
11
12
13
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals

import pykat.external.six as six
if six.PY2:
14
    import exceptions
15

Daniel Brown's avatar
Daniel Brown committed
16
import abc
Daniel Brown's avatar
Daniel Brown committed
17
from pykat.node_network import *
18
from pykat.param import Param, AttrParam
19
from pykat.SIfloat import SIfloat
20

21
import pykat.external.six as six
22
import pykat.exceptions as pkex
23
24

import collections
25
import warnings
26
import copy
Daniel Brown's avatar
Daniel Brown committed
27

28
29
30
31
32
from pykat import USE_GUI, NoGUIException

if USE_GUI:
    import pykat.gui.resources
    from pykat.gui.graphics import *
Daniel Brown's avatar
updates    
Daniel Brown committed
33

34
id_____pykat_class = 0
Daniel Brown's avatar
updates    
Daniel Brown committed
35

36
class BaseDetector(object) :
37
38
39
40
    """
    This is a base class for all detectors. Classes Detector1 and Detector2 should be used directly.
    This base class can handled detectors connected to multiple nodes.
    """
41
    
42
43
    __metaclass__ = abc.ABCMeta
    
Daniel Brown's avatar
updates    
Daniel Brown committed
44
45
46
47
    def __new__(cls, *args, **kwargs):
        # This creates an instance specific class for the component
        # this enables us to add properties to instances rather than
        # all classes
48
49
50
        global id_____pykat_class
        id_____pykat_class += 1
        cnew_name = str("%s.%s_%i" % (cls.__module__, cls.__name__, id_____pykat_class))
Daniel Brown's avatar
updates    
Daniel Brown committed
51
52
53
        
        cnew = type(cnew_name, (cls,), {})
        
54
        return object.__new__(cnew)
Daniel Brown's avatar
updates    
Daniel Brown committed
55
        
56
57
    def __init__(self, name, nodes=None, max_nodes=1):
        
Daniel Brown's avatar
Daniel Brown committed
58
59
60
61
62
63
64
        self.__name = name
        self._svgItem = None
        self._kat = None
        self.noplot = False
        self.enabled = True
        self.tag = None
        self._params = []
65
        self._mask = {}
Daniel Brown's avatar
Daniel Brown committed
66
        self.__scale = []
67
        self.__removed = False
68
        self.noplot = False
69
        
70
71
72
73
74
        self._alternate_beam = []
        self._nodes = []
        self._requested_nodes = []
        
        if nodes != None:
75
76
            if isinstance(nodes, (list, tuple)):
                
77
78
79
80
81
82
83
84
85
86
87
                if len(nodes) > max_nodes:
                    raise pkex.BasePyKatException("Tried to set too many nodes, %s, maximum number is %i." %(str(nodes),max_nodes))
                    
                for n in nodes:
                    if n[-1]=='*':
                        self._alternate_beam.append(True)
                        n = n[:-1]
                    else:
                        self._alternate_beam.append(False)
                        
                    self._requested_nodes.append(n)
88
            elif isinstance(nodes, six.string_types):
89
90
91
92
93
94
95
96
                # if we don't have a collection
                if nodes[-1]=='*':
                    self._alternate_beam.append(True)
                    nodes = nodes[:-1]
                else:
                    self._alternate_beam.append(False)
                    
                self._requested_nodes.append(nodes)
97
98
            else:
                raise pkex.BasePyKatException("Nodes should be a list or tuple of node names or a singular node name as a string.")
Daniel Brown's avatar
updates    
Daniel Brown committed
99
100
101
102
103
104
105
106
107
108
109
110
111
    
    def __deepcopy__(self, memo):
        """
        When deep copying a kat object we need to take into account
        the instance specific properties.
        """
        
        # Here we create a copy of this object based of the base class
        # of this one, otherwise we're making a copy of a copy of a copy...
        result = self.__class__.__new__(self.__class__.__base__)
        result.__dict__ = copy.deepcopy(self.__dict__, memo)
        
        return result
112
                
Daniel Brown's avatar
Daniel Brown committed
113
114
115
116
    def _register_param(self, param):
        self._params.append(param)
        
    def _on_kat_add(self, kat):
117
118
        self._kat = kat
        
119
120
121
        for rn in self._requested_nodes:
            if rn != None:
                self._nodes.append(kat.nodes.createNode(rn))
Daniel Brown's avatar
Daniel Brown committed
122
    
123
124
125
    def _on_kat_remove(self):
        self.__removed = True
        
126
127
128
129
130
131
132
133
    def remove(self):
        if self.__removed:
            raise pkex.BasePyKatException("{0} has already been marked as removed".format(self.name))
        else:
            self._kat.remove(self)
    
        self.__removed = True
        
Daniel Brown's avatar
Daniel Brown committed
134
135
136
137
138
139
    @staticmethod
    def parseFinesseText(text):    
        raise NotImplementedError("This function is not implemented")
        
    def getFinesseText(self):
        """ Base class for individual finesse optical components """    
140
141
142
143
144
145
        #raise NotImplementedError("This function is not implemented")
        
        if self.noplot:
            return ["noplot " + self.name]
        else:
            return []
Daniel Brown's avatar
Daniel Brown committed
146
147
        
    def getQGraphicsItem(self):    
148
149
150
        if not USE_GUI:
            raise NoGUIException
            
Daniel Brown's avatar
Daniel Brown committed
151
        return None
152

153
154
155
    @property
    def removed(self): return self.__removed
    
156
157
158
    @property 
    def scale(self): return self.__scale
    @scale.setter
159
    def scale(self, value):
Daniel Brown's avatar
Daniel Brown committed
160
161
        if value not in self.__scale:
            self.__scale = value
Daniel Brown's avatar
Daniel Brown committed
162
163
164
165
166
167
    
    @property
    def name(self): return self.__name        

    def __str__(self): return self.name

168
    def mask(self, n, m, factor):
169
        _id = str(n)+"_"+str(m)
170
171
172
        
        # if the mask is 1 then remove this so it doesn't get 
        # printed as by default the value is 1.0
173
174
175
176
177
178
        if _id in self._mask and factor == 1.0:
            del self._mask[_id]
                
        self._mask[_id] = factor

    def _set_node(value, index):
179
        if self._kat is None:
180
181
182
183
184
185
186
187
188
189
190
191
192
            raise pkex.BasePyKatException("This detector has not been added to a kat object yet")
        else:
            if value[-1] == '*':
                self._alternate_beam[index] = True
                value = value[:-1]
            else:
                self._alternate_beam[index] = False
                
            if value in self._kat.nodes:
                self._nodes[index] = self._kat.nodes[value]
            else:
                raise pkex.BasePyKatException("There is no node called " + value + " in the kat object this detector is attached to.")
    
Daniel Brown's avatar
Daniel Brown committed
193
194
    def _getScaleCmds(self, rtn):
        if self.scale != None:
195
            if isinstance(self.scale, six.string_types):
Daniel Brown's avatar
Daniel Brown committed
196
197
198
199
200
201
                rtn.append("scale {1} {0}".format(self.name, self.scale))
            elif isinstance(self.scale, (list, tuple)):
                for s in self.scale:
                    rtn.append("scale {1} {0}".format(self.name, s))
            else:
                raise pkex.BasePyKatException("Scale command should either be a list of scales or a single string.")
Daniel Brown's avatar
Daniel Brown committed
202
203
204
205
206
207
208

class Detector0(BaseDetector):
    """
    A detector that attaches to no nodes.
    """
    pass
                        
209
class Detector1(BaseDetector):
210
211
212
    """
    A detector that attaches to one node.
    """
213
    @property 
214
    def node(self): return self._nodes[0]
215
216
217
218
219
220
    @node.setter
    def node(self, value):
        self._set_node(value, 0)      
        
                
class Detector2(BaseDetector):
221
222
223
    """
    A detector that attaches to two node.
    """
224
225
    
    @property 
226
    def node1(self): return self._nodes[0]
227
228
229
230
231
    @node1.setter
    def node(self, value):
        self._set_node(value, 0)
        
    @property 
232
    def node2(self): return self._nodes[1]
233
234
235
236
237
    @node2.setter
    def node(self, value):
        self._set_node(value, 1)
                
                
Daniel Brown's avatar
Daniel Brown committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
class beam(Detector1):
    
    def __init__(self, name, node_name, frequency=None, alternate_beam=False):
        BaseDetector.__init__(self, name, node_name)
        
        self.alternate_beam = alternate_beam
        self.__f = Param("f", self, frequency)        
    
    @property
    def f(self): return self.__f
    
    @f.setter
    def f(self, value):
        self.__f.value = value
        
    @staticmethod
    def parseFinesseText(text):
        
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
257

Daniel Brown's avatar
Daniel Brown committed
258
259
260
261
262
263
        node=values[-1]
        alt_beam = node[-1] == '*'
        
        if len(values) == 3:
            return beam(values[1], node, alternate_beam=alt_beam)
        elif len(values) == 4:
Daniel Brown's avatar
mend    
Daniel Brown committed
264
            return beam(values[1], node, alternate_beam=alt_beam, frequency=SIfloat(values[2]))
Daniel Brown's avatar
Daniel Brown committed
265
266
267
268
        else:
            raise pkex.BasePyKatException('Beam detector code "{0}" is not a valid FINESSE command'.format(text))
    
    def getFinesseText(self) :
269
        rtn = BaseDetector.getFinesseText(self)
Daniel Brown's avatar
Daniel Brown committed
270
271
272
273
274
275
276
277
278
279
        
        if self.alternate_beam:
            alt = '*'
        else:
            alt = ''
        
        if self.f.value is None:
            rtn.append("beam {name} {node}{alt}".format(name=self.name, node=self.node.name, alt=alt))
        else:
            rtn.append("beam {name} {f} {node}{alt}".format(name=self.name, f=str(self.f.value), node=self.node.name, alt=alt))
280
        
Daniel Brown's avatar
Daniel Brown committed
281
282
283
284
285
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
class cp(Detector0):
    
    def __init__(self, name, cavity, direction, parameter):
        BaseDetector.__init__(self, name, None)
        
        self.cavity = str(cavity)
        self.direction = direction
        self.parameter = parameter

    @property
    def direction(self): return self.__direction
    @direction.setter
    def direction(self, value):
        if value.lower() not in ["x", "y"]:
            raise pkex.BasePyKatException('Cavity parameter detector direction must be x or y.')
    
        self.__direction = value
        
        
    @property
    def parameter(self): return self.__param
    @parameter.setter
    def parameter(self, value):
        
        params = ["w0","w","zr","z","r","q","finesse","m","stability","loss","length","fsr","fwhm","pole","gouy","fsep","A","B","C","D"]

        if value not in params:
            raise pkex.BasePyKatException('Cavity parameter detector direction must be one of: ' + ", ".join(params))
    
        self.__param = value


    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
        
        if len(values) == 4:
            # For FINESSE version < 2.1
            # Old format the name of the detector is a combination of the arguments
            return cp(values[1] + "_" + values[2] + "_" + values[3], values[1], values[2], values[3])
        elif len(values) == 5:
            return cp(values[1], values[2], values[3], values[4])
        else:
            raise pkex.BasePyKatException('Cavity parameter detector code "{0}" is not a valid FINESSE command'.format(text))
            
    def getFinesseText(self) :
332
        rtn = BaseDetector.getFinesseText(self)
333
334
335
336
337
338
339
340
        
        rtn.append("cp {name} {cavity} {direction} {parameter}".format(name=self.name,
                                                                   cavity=str(self.cavity),
                                                                   direction=self.direction,
                                                                   parameter=self.parameter))
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
class xd(Detector0):
    
    def __init__(self, name, component, motion):
        BaseDetector.__init__(self, name, None)
        
        self.component = component
        self.motion = motion

    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
        
        if len(values) == 4:
            return xd(values[1], values[2], values[3])
        else:
            raise pkex.BasePyKatException('Motion detector code "{0}" is not a valid FINESSE command'.format(text))
            
    def getFinesseText(self) :
359
        rtn = BaseDetector.getFinesseText(self)
Daniel Brown's avatar
Daniel Brown committed
360
        
Daniel Brown's avatar
Daniel Brown committed
361
362
363
364
365
366
        rtn.append("xd {name} {component} {motion}".format(name=self.name,
                                                           component=self.component,
                                                           motion=self.motion))
        
        return rtn
              
Daniel Brown's avatar
Daniel Brown committed
367
        
368
class ad(Detector1):
Daniel Brown's avatar
Daniel Brown committed
369
370
    
    def __init__(self, name, frequency, node_name, mode=None, alternate_beam=False):
371
        BaseDetector.__init__(self, name, node_name)
Daniel Brown's avatar
Daniel Brown committed
372
373
374
        self.mode = mode
        self.alternate_beam = alternate_beam
        self.__f = Param("f", self, frequency)
Daniel Brown's avatar
Daniel Brown committed
375
    
Daniel Brown's avatar
Daniel Brown committed
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
    @property
    def mode(self): return self.__mode
    @mode.setter
    def mode(self, value):
        if value != None and len(value) != 2:
            raise pkex.BasePyKatException('Mode must be a container of length 2, first element the x mode and second the y mode')
    
        self.__mode = value
        
    @property
    def f(self): return self.__f
    @f.setter
    def f(self, value): 
        self.__f.value = value
        
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
394
395
396

        node=values[-1]
        alt_beam = node[-1] == '*'
Daniel Brown's avatar
Daniel Brown committed
397
398
399
        if len(values) == 6:
            return ad(values[1], values[4], values[5], mode = [int(values[2]), int(values[3])], alternate_beam=alt_beam)
        elif len(values) == 4:
400
            return ad(values[1], values[2], values[3], alternate_beam=alt_beam)
Daniel Brown's avatar
Daniel Brown committed
401
402
403
404
        else:
            raise pkex.BasePyKatException('Amplitude detector code "{0}" is not a valid FINESSE command'.format(text))
            
    def getFinesseText(self) :
405
        rtn = BaseDetector.getFinesseText(self)
Daniel Brown's avatar
Daniel Brown committed
406
407
408
409
410
411
        
        if self.alternate_beam:
            alt = '*'
        else:
            alt = ''
        
412
        if self.mode is None:
Daniel Brown's avatar
Daniel Brown committed
413
414
            rtn.append("ad {name} {f} {node}{alt}".format(name=self.name, f=str(self.f.value), node=self.node.name, alt=alt))
        else:
415
            rtn.append("ad {name} {n} {m} {f} {node}{alt}".format(name=self.name, n=str(self.mode[0]), m=str(self.mode[1]), f=str(self.f.value), node=self.node.name, alt=alt))
Daniel Brown's avatar
Daniel Brown committed
416
417
418
419
420
            
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
421

422
class gouy(Detector1):
423
424
    
    def __init__(self, name, direction, spaces):
425
        BaseDetector.__init__(self, name)
426
427
428
429
430
431
432
433
        self.spaces = copy.copy(spaces)
        self.direction = direction
        self.alternate_beam = False
        
    @property
    def direction(self): return self.__dir
    @direction.setter
    def direction(self, value):
434
        if value is None or (value != 'x' and value != 'y'):
435
436
437
438
439
440
441
442
443
            raise pkex.BasePyKatException('Direction must be either x or y')
    
        self.__dir = value

    @property
    def spaces(self): return self.__spaces
    @spaces.setter
    def spaces(self, value):

444
        if value is None or len(value) < 1:
445
446
447
448
449
450
451
452
453
454
455
456
457
458
            raise pkex.BasePyKatException('Must be a list of space names')
    
        self.__spaces = value
        
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()

        if len(values) > 3:
            return gouy(str(values[1]), str(values[2]), values[3:])
        else:
            raise pkex.BasePyKatException('Gouy detector code "{0}" is not a valid FINESSE command'.format(text))
            
    def getFinesseText(self) :
459
        rtn = BaseDetector.getFinesseText(self)
460
461
462
463
464
465
466
467
468
469

        rtn.append("gouy {name} {dir} {spaces}".format(name=self.name, dir=str(self.direction), spaces=" ".join(self.spaces)))
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn



470
class bp(Detector1):
471
472
473
    acceptedParameters = ['w', 'w0', 'z', 'zr', 'g', 'r', 'q']
    
    def __init__(self, name, direction, parameter, node, alternate_beam=False):
474
        BaseDetector.__init__(self, name, node)
475
476
477
        self.parameter = parameter
        self.direction = direction
        self.alternate_beam = alternate_beam
Daniel Brown's avatar
Daniel Brown committed
478
        
479
480
481
482
    @property
    def direction(self): return self.__dir
    @direction.setter
    def direction(self, value):
483
        if value is None or (value != 'x' and value != 'y'):
484
485
486
487
488
489
490
491
492
            raise pkex.BasePyKatException('Direction must be either x or y')
    
        self.__dir = value

    @property
    def parameter(self): return self.__param
    @parameter.setter
    def parameter(self, value):
        
493
        if value is None or (value not in self.acceptedParameters) :
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
            raise pkex.BasePyKatException('Parameter must be one of: %s'%(", ".join(self.acceptedParameters)))
    
        self.__param = value
        
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
        
        node=values[-1]
        alt_beam = node[-1] == '*'
        
        if len(values) > 3:
            return bp(str(values[1]), str(values[2]), str(values[3]), str(values[4]), alternate_beam=alt_beam)
        else:
            raise pkex.BasePyKatException('Gouy detector code "{0}" is not a valid FINESSE command'.format(text))
            
    def getFinesseText(self) :
511
        rtn = BaseDetector.getFinesseText(self)
512
513
514
515
516
517
518
519
520
521
522
523
524

        if self.alternate_beam:
            alt = "*"
        else:
            alt = ""
            
        rtn.append("bp {name} {dir} {param} {node}{alt}".format(name=self.name, dir=str(self.direction), param=self.parameter, node=self.node.name, alt=alt))
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn

Daniel Brown's avatar
Daniel Brown committed
525
id___2 = 0
526

527
class pd(Detector1):
528

529
530
531
532
    def __new__(cls, *args, **kwargs):
        # This creates an instance specific class for the component
        # this enables us to add properties to instances rather than
        # all classes
Daniel Brown's avatar
Daniel Brown committed
533
534
535
536
537
538
        global id___2
        id___2 += 1
        cnew_name = str("%s.%s_%i" % (cls.__module__, cls.__name__, id___2))
    
        cnew = type(cnew_name, (cls,), {})
    
539
        return object.__new__(cnew)
Daniel Brown's avatar
Daniel Brown committed
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554

    def __deepcopy__(self, memo):
        """
        When deep copying a kat object we need to take into account
        the instance specific properties.
        """
        
        # Here we create a copy of this object based of the base class
        # of this one, otherwise we're making a copy of a copy of a copy...
        result = self.__class__.__new__(self.__class__.__base__)
        result.__dict__ = copy.deepcopy(self.__dict__, memo)
        
        result.__set_demod_attrs()
        
        return result
555
556

    def __init__(self, name=None, num_demods=1, node_name=None, senstype=None, alternate_beam=False, pdtype=None, **kwargs):
557
        BaseDetector.__init__(self, name, node_name)
Daniel Brown's avatar
Daniel Brown committed
558
559
560
        
        self.__num_demods = num_demods
        self.__senstype = senstype
Daniel Brown's avatar
Daniel Brown committed
561
        self.alternate_beam = alternate_beam
562
563
        self.__pdtype = pdtype

Daniel Brown's avatar
Daniel Brown committed
564
565
566
567
        # create the parameters for all 5 demodulations regardless
        # of how many the user specifies. Later we add properties to
        # those which correspond to the number of demodulations
        
568
569
570
571
572
        self.__f1 = Param("f1", self, None)
        self.__f2 = Param("f2", self, None)
        self.__f3 = Param("f3", self, None)
        self.__f4 = Param("f4", self, None)
        self.__f5 = Param("f5", self, None)
Daniel Brown's avatar
Daniel Brown committed
573
        
Daniel Brown's avatar
Daniel Brown committed
574
575
576
577
578
        self.__phase1 = Param("phase1", self, None)
        self.__phase2 = Param("phase2", self, None)
        self.__phase3 = Param("phase3", self, None)
        self.__phase4 = Param("phase4", self, None)
        self.__phase5 = Param("phase5", self, None)
Daniel Brown's avatar
Daniel Brown committed
579
        
580
        fs = [self.__f1, self.__f2, self.__f3, self.__f4, self.__f5]
Daniel Brown's avatar
Daniel Brown committed
581
        ps = [self.__phase1, self.__phase2, self.__phase3, self.__phase4, self.__phase5]
582

583
584
        for i in range(num_demods):
            f = 'f{0}'.format(i+1)
585
            #print("i {0} fs {1} f {2} keys {3}".format(i,len(fs),f, kwargs.keys()))
586
587
588
589
590
591
            
            if f in kwargs:
                fs[i].value = kwargs[f]
            else:
                raise pkex.BasePyKatException("Missing demodulation frequency {0} (f{0})".format(i+1))    
        
592
            p = 'phase{0}'.format(i+1)
593
594
            
            if p in kwargs:
595
                if kwargs[p] is None and i<num_demods-1:
596
                    raise pkex.BasePyKatException("Missing demodulation phase {0} (phase{0})".format(i+1))
597
598
599
                    
                ps[i].value = kwargs[p]
            elif i<num_demods-1:
600
                raise pkex.BasePyKatException("Missing demodulation phase {0} (phase{0})".format(i+1))
601
        
602
   
Daniel Brown's avatar
Daniel Brown committed
603
        self.__set_demod_attrs()
604
                
Daniel Brown's avatar
Daniel Brown committed
605
606
607
608
609
610
611
612
613
614
615
    @property
    def senstype(self): return self.__senstype
    @senstype.setter
    def senstype(self,value):
        if value == "": value = None
        
        if value != "S" and value != "N" and value != None: 
            raise pkex.BasePyKatException("Photodiode sensitivity type can either be 'N', 'S' or None.")
            
        self.__senstype = value
        
616
    @property
Daniel Brown's avatar
Daniel Brown committed
617
618
619
620
621
622
623
624
    def num_demods(self): return self.__num_demods
    @num_demods.setter
    def num_demods(self, value): 
        if value < 0 or value > 5:
            raise pkex.BasePyKatException("Number of demodulations must be between 0 and 5")
        
        self.__num_demods = value
        self.__set_demod_attrs()
625
626
627
628
629

    @property
    def pdtype(self): return self.__pdtype
    @pdtype.setter
    def pdtype(self, value): self.__pdtype = value
Daniel Brown's avatar
Daniel Brown committed
630
631
    
    def __get_fphi(self, name):
Daniel Brown's avatar
Daniel Brown committed
632
        return getattr(self, '_pd__' + name)
Daniel Brown's avatar
Daniel Brown committed
633
634
    
    def __set_f(self, num, value):
Daniel Brown's avatar
Daniel Brown committed
635
636
637
638
        value = SIfloat(value)
        
        p = getattr(self, '_pd__f' + num)
        p.value = value
Daniel Brown's avatar
Daniel Brown committed
639
640
    
    def __set_phi(self, num, value):
Daniel Brown's avatar
Daniel Brown committed
641
642
        value = SIfloat(value)
        
643
        if value is None and num != self.num_demods:
Daniel Brown's avatar
Daniel Brown committed
644
645
646
            # check if we are setting no phase that this is only on the last
            # demodulation phase.
            raise pkex.BasePyKatException("Only last demodulation phase can be set to None")
647
        elif isinstance(value, six.string_types) and not isinstance(value,float) and value.lower() != "max":
Daniel Brown's avatar
Daniel Brown committed
648
            raise pkex.BasePyKatException("Demodulation phase can only be set to a 'max' or a number (or None if the last demodulation phase)")
Daniel Brown's avatar
Daniel Brown committed
649
          
650
        p = getattr(self, '_pd__phase' + num)  
Daniel Brown's avatar
Daniel Brown committed
651
        p.value = value
Daniel Brown's avatar
Daniel Brown committed
652
653
654
655
656
657
658
659
660
661
662
663
664
        
    def __set_demod_attrs(self):
        """
        For the set number of demodulations the correct number of 
        Parameters are created.
        """
        
        # if there are demodulations present then we want to add
        # the various parameters so they are available for users
        # to play with.
        if self.__num_demods > 0:
            for i in range(1,6):
                name = str(i)
Daniel Brown's avatar
Daniel Brown committed
665
                
Daniel Brown's avatar
Daniel Brown committed
666
667
                if i <= self.num_demods:
                    if not hasattr(self, "f"+name):
Daniel Brown's avatar
Daniel Brown committed
668
669
670
671
                        fget = lambda self, i=i:        self.__get_fphi('f'+str(i))
                        fset = lambda self, value, i=i: self.__set_f(str(i), value)
                        
                        setattr(self.__class__, "f"+name, property(fget=fget, fset=fset))
Daniel Brown's avatar
Daniel Brown committed
672
                    
673
674
                    if not hasattr(self, "phase"+name):
                        setattr(self.__class__, "phase"+name, property(fget=lambda self, i=i: self.__get_fphi('phase'+str(i)), fset=lambda self, value, i=i: self.__set_phi(str(i), value)))
Daniel Brown's avatar
Daniel Brown committed
675
676
677
                else:
                    if hasattr(self, "f"+name):
                        delattr(self.__class__, "f"+name)
Daniel Brown's avatar
Daniel Brown committed
678
                        
679
680
                    if hasattr(self, "phase"+name):
                        delattr(self.__class__, "phase"+name)
Daniel Brown's avatar
Daniel Brown committed
681
682
683
        else:
            return
    
684
685
    @staticmethod
    def parseFinesseText(text): 
Daniel Brown's avatar
Daniel Brown committed
686
        values = text.split()
687
688
689
690
691
692
693
694
        demods = 0
        senstype = None

        if len(values[0]) == 4:
            senstype = values[0][2]
            demods = int(values[0][3])
        elif len(values[0]) == 3:
            demods = int(values[0][2])
Daniel Brown's avatar
Daniel Brown committed
695
        elif len(values[0]) != 2:
696
            raise pkex.BasePyKatException("Photodiode code format incorrect '{0}' (1)".format(text))
697
698
        
        if len(values) <= 3 and demods > 0:
699
            raise pkex.BasePyKatException("Photodiode code format incorrect '{0}' (2)".format(text))
Daniel Brown's avatar
Daniel Brown committed
700
        elif len(values) > 3 and demods == 0:
701
            raise pkex.BasePyKatException("Photodiode code format incorrect '{0}' (3)".format(text))
702
703
704
705
            
        num_f_phs = len(values) - 3
        expected_f_phs = demods * 2
        
706
707
        if not (num_f_phs == expected_f_phs or num_f_phs == expected_f_phs-1):
            raise pkex.BasePyKatException("Photodiode code format incorrect '{0}' (4)".format(text))
708
709
710
711
712
713
714
        
        f = values[2:len(values)-1:2]    
        phs = values[3:len(values)-1:2]
        
        dict = {}
        
        for i in range(len(f)):
Daniel Brown's avatar
Daniel Brown committed
715
            dict['f{0}'.format(i+1)] = SIfloat(f[i])
716
        for i in range(len(phs)):
Daniel Brown's avatar
Daniel Brown committed
717
            if phs[i] == "max":
718
                dict['phase{0}'.format(i+1)] = "max"
Daniel Brown's avatar
Daniel Brown committed
719
            else:
720
                dict['phase{0}'.format(i+1)] = SIfloat(phs[i])
721
722
723
724
725
726
727
728
729
730
            
        node = values[-1]
        alt_beam = node[-1] == '*'
        
        if alt_beam:
            node = node[0:-1]
        
        return pd(values[1], demods, node, senstype=senstype, alternate_beam=alt_beam, **dict)

        
Daniel Brown's avatar
Daniel Brown committed
731
    def getFinesseText(self) :
732
        rtn = BaseDetector.getFinesseText(self)
Daniel Brown's avatar
Daniel Brown committed
733
734
735
736
737
        
        if self.enabled:
            alt_str = ""
            fphi_str = ""
            
Daniel Brown's avatar
Daniel Brown committed
738
            if self.alternate_beam:
Daniel Brown's avatar
Daniel Brown committed
739
740
741
                alt_str = "*"
                
            for n in range(1, 1+self.num_demods):
742
743
744
745
746
747
748
                _f = self.__getattribute__("f"+str(n))
                
                if _f == "$fs":
                    fphi_str += " $fs"
                else:
                    fphi_str += " {0:.16g}".format(float(_f))
                    
749
                phi_val = self.__getattribute__("phase"+str(n))
Daniel Brown's avatar
Daniel Brown committed
750
751
                
                if phi_val != None:
752
753
754
755
                    if type(phi_val) == float:
                        fphi_str += " {0:.16g}".format(float(phi_val))
                    else:
                        fphi_str += " {0}".format(phi_val)
Daniel Brown's avatar
Daniel Brown committed
756
757
758
            
            senstype = self.senstype
            
759
            if senstype is None:
Daniel Brown's avatar
Daniel Brown committed
760
                senstype = ""
761
            
Sean Leavey's avatar
Sean Leavey committed
762
            rtn.append("pd{0}{1} {2}{3} {4}{5}".format(senstype, self.num_demods, self.name, fphi_str, self.node.name, alt_str))
763

Daniel Brown's avatar
Daniel Brown committed
764
765
            self._getScaleCmds(rtn)
            
766
767
            if self.pdtype != None:
                rtn.append("pdtype {0} {1}".format(self.name, self.pdtype))
768
                
769
770
            for p in self._params:
                rtn.extend(p.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
771
772
            
        return rtn
773
  
Daniel Brown's avatar
Daniel Brown committed
774
class qnoised(pd):
775
776
    
    def __init__(self, name, num_demods, node_name, alternate_beam=False, pdtype=None, **kwargs):
Daniel Brown's avatar
Daniel Brown committed
777
        super(qnoised, self).__init__(name, num_demods, node_name, alternate_beam=alternate_beam, pdtype=pdtype, **kwargs)
778
779
780
781
782
783
784
785
786
    
        self.__homangle = AttrParam("homangle", self, None)
    
    @property
    def homangle(self): return self.__homangle
    @homangle.setter
    def homangle(self, value): self.__homangle.value = value
    
    @pd.pdtype.setter
Daniel Brown's avatar
Daniel Brown committed
787
788
    def pdtype(self, value):
        raise pkex.BasePyKatException("Setting pdtype is not possible with qnoised detectors")
789
    
Daniel Brown's avatar
Daniel Brown committed
790
791
792
793
794
795
796
    def parseAttributes(self, values):
        
        for key in values.keys():
            if key in ["homangle"]:
                self.__homangle.value = values[key]
            else:
                raise pkex.BasePyKatException("No attribute {0} for qnoised".format(key))
797
798
799
800
    
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
Daniel Brown's avatar
Daniel Brown committed
801

802
        if len(values) <= 3:
Daniel Brown's avatar
Daniel Brown committed
803
            raise pkex.BasePyKatException("qnoised code format incorrect '{0}' (2)".format(text))
Daniel Brown's avatar
Daniel Brown committed
804
            
Daniel Brown's avatar
Daniel Brown committed
805
        demods = int(values[2])
806
        
807
        if len(values) <= 4 and demods > 0:
Daniel Brown's avatar
Daniel Brown committed
808
            raise pkex.BasePyKatException("qnoised code format incorrect '{0}' (2)".format(text))
809
        elif len(values) > 4 and demods == 0:
Daniel Brown's avatar
Daniel Brown committed
810
            raise pkex.BasePyKatException("qnoised code format incorrect '{0}' (3)".format(text))
811
812
813
814
            
        num_f_phs = len(values) - 4
        expected_f_phs = demods * 2
        
Daniel Brown's avatar
Daniel Brown committed
815
816
        if not (num_f_phs == expected_f_phs or num_f_phs == (expected_f_phs-1)):
            raise pkex.BasePyKatException("qnoised code format incorrect '{0}' (4)".format(text))
817
818
819
820
821
        
        f = values[3:len(values)-1:2]    
        phs = values[4:len(values)-1:2]
        
        dict = {}
Daniel Brown's avatar
Daniel Brown committed
822
        
823
824
825
        for i in range(len(f)):
            dict['f{0}'.format(i+1)] = f[i]
        for i in range(len(phs)):
826
            dict['phase{0}'.format(i+1)] = phs[i]
Daniel Brown's avatar
Daniel Brown committed
827
            
828
829
830
831
832
833
        node = values[-1]
        alt_beam = node[-1] == '*'
        
        if alt_beam:
            node = node[0:-1]
        
834
835
836
837
838
839
840
841
        if values[0].endswith('S'):
            sens='S'
        elif values[0].endswith('N'):
            sens='N'
        else:
            sens=None
            
        return qnoised(values[1], demods, node, senstype=sens, alternate_beam=alt_beam, **dict)
842
843
    
    def getFinesseText(self) :
844
        rtn = BaseDetector.getFinesseText(self)
845
846
847
848
849
850
851
        
        if self.enabled:
            alt_str = ""
            fphi_str = ""
            
            if self.alternate_beam:
                alt_str = "*"
852
            
853
            for n in range(1, 1+self.num_demods):
854
855
856
857
858
859
860
                _f = self.__getattribute__("f"+str(n))
                
                if _f == "$fs":
                    fphi_str += " $fs"
                else:
                    fphi_str += " {0:.16g}".format(float(_f))
                    
861
                phi_val = self.__getattribute__("phase"+str(n))
862
863
                
                if phi_val != None:
864
865
866
867
                    if type(phi_val) == float:
                        fphi_str += " {0:.16g}".format(float(phi_val))
                    else:
                        fphi_str += " " + str(phi_val)
868
869
870
            
            senstype = self.senstype
            
871
            if senstype is None:
872
873
                senstype = ""
                
874
            rtn.append("qnoised{5} {0} {1} {2} {3}{4}".format(self.name, self.num_demods, fphi_str, self.node.name, alt_str, senstype))
Andreas Freise's avatar
Andreas Freise committed
875

Daniel Brown's avatar
Daniel Brown committed
876
            self._getScaleCmds(rtn)
877
878
879
880
881
                
            for p in self._params:
                rtn.extend(p.getFinesseText())
            
        return rtn
Daniel Brown's avatar
Daniel Brown committed
882

883
class qshot(pd):
Daniel Brown's avatar
Daniel Brown committed
884
885
    
    def __init__(self, name, num_demods, node_name, alternate_beam=False, **kwargs):
886
        super(qshot, self).__init__(name, num_demods, node_name, alternate_beam=alternate_beam, pdtype=None, **kwargs)     
887

Daniel Brown's avatar
Daniel Brown committed
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
    @pd.pdtype.setter
    def pdtype(self, value):
        raise pkex.BasePyKatException("Setting pdtype is not possible with qshot detectors")
    
    @pd.senstype.setter
    def senstype(self,value):
        raise pkex.BasePyKatException("qshot detector has no sensitvity type")
    
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()

        if len(values) <= 3:
            raise pkex.BasePyKatException("qshot code format incorrect '{0}' (2)".format(text))
            
        demods = int(values[2])
        
        if len(values) <= 4 and demods > 0:
            raise pkex.BasePyKatException("qshot code format incorrect '{0}' (2)".format(text))
        elif len(values) > 4 and demods == 0:
            raise pkex.BasePyKatException("qshot code format incorrect '{0}' (3)".format(text))
            
        num_f_phs = len(values) - 4
        expected_f_phs = demods * 2
        
        if not (num_f_phs == expected_f_phs or num_f_phs == (expected_f_phs-1)):
            raise pkex.BasePyKatException("qshot code format incorrect '{0}' (4)".format(text))
        
        f = values[3:len(values)-1:2]    
        phs = values[4:len(values)-1:2]
        
        dict = {}
        
        for i in range(len(f)):
            dict['f{0}'.format(i+1)] = f[i]
        for i in range(len(phs)):
924
            dict['phase{0}'.format(i+1)] = phs[i]
Daniel Brown's avatar
Daniel Brown committed
925
926
927
928
929
930
            
        node = values[-1]
        alt_beam = node[-1] == '*'
        
        if alt_beam:
            node = node[0:-1]
931
932
933
934
935
936
937
            
        if values[0].endswith('S'):
            sens='S'
        elif values[0].endswith('N'):
            sens='N'
        else:
            sens=None
Daniel Brown's avatar
Daniel Brown committed
938
        
939
        return qshot(values[1], demods, node, senstype=sens, alternate_beam=alt_beam, **dict)
940
    
Daniel Brown's avatar
Daniel Brown committed
941
    def getFinesseText(self) :
942
        rtn = BaseDetector.getFinesseText(self)
Daniel Brown's avatar
Daniel Brown committed
943
944
945
946
947
948
949
950
951
        
        if self.enabled:
            alt_str = ""
            fphi_str = ""
            
            if self.alternate_beam:
                alt_str = "*"
                
            for n in range(1, 1+self.num_demods):
952
953
954
955
956
957
958
                _f = self.__getattribute__("f"+str(n))
                
                if _f == "$fs":
                    fphi_str += " $fs"
                else:
                    fphi_str += " {0:.16g}".format(float(_f))
                    
959
                phi_val = self.__getattribute__("phase"+str(n))
Daniel Brown's avatar
Daniel Brown committed
960
961
                
                if phi_val != None:
962
963
964
965
                    if type(phi_val) == float:
                        fphi_str += " {0:.16g}".format(float(phi_val))
                    else:
                        fphi_str += " " + str(phi_val)
Daniel Brown's avatar
Daniel Brown committed
966
967
968
            
            senstype = self.senstype
            
969
            if senstype is None:
Daniel Brown's avatar
Daniel Brown committed
970
971
                senstype = ""
                
972
            rtn.append("qshot{5} {0} {1} {2} {3}{4}".format(self.name, self.num_demods, fphi_str, self.node.name, alt_str,senstype))
Daniel Brown's avatar
Daniel Brown committed
973

Daniel Brown's avatar
Daniel Brown committed
974
            self._getScaleCmds(rtn)
Daniel Brown's avatar
Daniel Brown committed
975
976
977
978
979
                
            for p in self._params:
                rtn.extend(p.getFinesseText())
            
        return rtn
Daniel Brown's avatar
Daniel Brown committed
980
    
981
982
983
984
985
986
    
class hd(Detector2):
    
    def __init__(self, name, phase, node1_name, node2_name):
        BaseDetector.__init__(self, name, (node1_name, node2_name), max_nodes=2)
    
987
        self.__phase = Param("phase", self, phase)
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self, value): self.__phase.value = value
    
    def parseAttributes(self, values):
        raise pkex.BasePyKatException("hd detector %s has no attributes to set" % self.name)
    
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
        
        return hd(values[1], float(values[2]), str(values[3]), str(values[4]))
    
    def getFinesseText(self):
1004
        rtn = BaseDetector.getFinesseText(self)
1005
1006
        
        if self.enabled:   
1007
1008
            n1 = self.node1.name
            n2 = self.node2.name
1009
            
1010
1011
            if self._alternate_beam[0]: n1 += "*"
            if self._alternate_beam[1]: n2 += "*"
1012
1013
1014
            
            rtn.append("hd {0} {1} {2} {3}".format(self.name, self.phase, n1, n2))

Daniel Brown's avatar
Daniel Brown committed
1015
            self._getScaleCmds(rtn)
1016
1017
1018
1019
                
            for p in self._params:
                rtn.extend(p.getFinesseText())
            
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
        return rtn
        
class qhd(Detector2):
    
    def __init__(self, name, phase, node1_name, node2_name, sensitivity=""):
        BaseDetector.__init__(self, name, (node1_name, node2_name), max_nodes=2)
    
        self.__phase = Param("phase", self, phase)
        self.sensitivity = sensitivity
        
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self, value): self.__phase.value = value
    
    @property
    def sensitivity(self): 
        return self.__sensitivity
    @sensitivity.setter
    def sensitivity(self, value):
        if value == 'S' or value == 'N':
            self.__sensitivity = value
1042
        elif value is None or value == '':
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
            self.__sensitivity = ""
        else:
            raise pkex.BasePyKatException("qhd (%s) sensitivity option '%s' is not available, use either 'S' or 'N'." % (self.name, value))
        
    
    def parseAttributes(self, values):
        raise pkex.BasePyKatException("hd detector %s has no attributes to set" % self.name)
    
    @staticmethod
    def parseFinesseText(text): 
        values = text.split()
        
Daniel Brown's avatar
Daniel Brown committed
1055
1056
1057
1058
1059
1060
        sens = values[0][-1]
        
        if sens != 'S' and sens != 'N':
            sens = None
            
        return qhd(values[1], float(values[2]), str(values[3]), str(values[4]), sensitivity = sens)
1061
1062
    
    def getFinesseText(self):
1063
        rtn = BaseDetector.getFinesseText(self)
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
        
        if self.enabled:   
            n1 = self.node1.name
            n2 = self.node2.name
            
            if self._alternate_beam[0]: n1 += "*"
            if self._alternate_beam[1]: n2 += "*"
            
            rtn.append("qhd{4} {0} {1} {2} {3}".format(self.name, self.phase, n1, n2, self.sensitivity))

Daniel Brown's avatar
Daniel Brown committed
1074
            self._getScaleCmds(rtn)
1075
1076
1077
1078
                
            for p in self._params:
                rtn.extend(p.getFinesseText())
            
1079
        return rtn