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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
"""
A marker output.
This module contains a class implementing a marker output
"""
__author__ = 'Florian Krause <florian@expyriment.org>, \
Oliver Lindemann <oliver@expyriment.org>'
__version__ = '0.7.0'
__revision__ = '55a4e7e'
__date__ = 'Wed Mar 26 14:33:37 2014 +0100'
import defaults
import expyriment
from _input_output import Output
from expyriment.misc._timer import get_time
class MarkerOutput(Output):
"""A class implementing a marker output."""
def __init__(self, interface, default_code=None, default_duration=None):
"""Create a marker output.
If a default code is specified, it will automatically be applied when
send() is called without a code.
If a default duration is specified, a 0 is sent automatically after
the specifed duration when send() is called without a duration.
Notes
-----
EEG/MEG systems:
If the system is receiving the markers on a parallel port, the
duration between sending a code an the subsequent 0 should be at least
1000/samplerate!
Parameters
----------
interface : io.SerialPort or io.ParallelPort
interface to use
default_code : int, optional
default code
default_duration : int, optional
default duration (in ms) for sending 0 after a code
"""
Output.__init__(self)
self._interface = interface
if default_code is not None:
self._default_code = default_code
else:
self._default_code = defaults.markeroutput_default_code
if default_duration is not None:
self._default_duration = default_duration
else:
self._default_duration = defaults.markeroutput_default_duration
@property
def interface(self):
"""Getter for interface"""
return self._interface
@property
def default_code(self):
"""Getter for default_code"""
return self._default_code
@default_code.setter
def default_code(self, value):
"""Getter for default_code"""
self._default_code = value
@property
def default_duration(self):
"""Getter for default_duration"""
return self._default_duration
@default_duration.setter
def default_duration(self, value):
"""Getter for default_duration"""
self._default_duration = value
def send(self, code=None, duration=None):
"""Send a marker.
This sends a marker via the specified interface.
If a duration is given, a 0 will be sent automatically after each
code.
Note for EEG/MEG systems:
If the system is receiving the markers on a parallel port, the
duration between sending a code an the subsequent 0 should be at least
1000/samplerate!
Parameters
----------
code : int, optional
a specific code
durartion : int, optional
duration (in ms) for sending a 0 after a code
"""
if not code:
code = self.default_code
if not duration:
duration = self.default_duration
self._interface.send(code)
if duration:
start = get_time()
while (get_time() - start) * 1000 < duration:
pass
self._interface.send(0)
if self._logging:
expyriment._active_exp._event_file_log(
"MarkerOutput,sent,{0}".format(code))
|
