Add documentation for MarkerFactory and TRIG pulse.

BBN-Q · Aug 15, 2017 · f261ed2 · f261ed2
1 parent d10eb66
commit f261ed2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/QGL/ChannelLibrary.py b/QGL/ChannelLibrary.py
@@ -455,6 +455,9 @@ def on_awg_change(self, oldName, newName):
                     self.physicalChannelManager.name_changed(chName, newLabel)
 
 def MarkerFactory(label, **kwargs):
+    '''Return a marker channel by name. Must be defined under top-level `markers`
+    keyword in measurement configuration YAML.
+    '''
     if channelLib and label in channelLib and isinstance(channelLib[label],
                                                         Channels.LogicalMarkerChannel):
         return channelLib[label]

diff --git a/QGL/PulsePrimitives.py b/QGL/PulsePrimitives.py
@@ -779,4 +779,9 @@ def BLANK(chan, length):
     return TAPulse("BLANK", chan.gate_chan, length, 1, 0, 0)
 
 def TRIG(marker_chan, length):
+    '''TRIG(marker_chan, length) generates a trigger output of amplitude 1 on
+    a LogicalMarkerChannel.
+    '''
+    if not isinstance(marker_chan, Channels.LogicalMarkerChannel):
+        raise ValueError("TRIG pulses can only be generated on LogicalMarkerChannels.")
     return TAPulse("TRIG", marker_chan, length, 1.0, 0., 0.)