Skip to content

Commit

Permalink
Update stub files (#315)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and github-actions[bot] authored Aug 8, 2024
1 parent aad016f commit aebbeb3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions mne_lsl/stream/epochs.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ class EpochsStream:
_tmin_shift: Incomplete
_ch_idx_by_type: Incomplete
_buffer: Incomplete
_buffer_events: Incomplete
_executor: Incomplete

def connect(self, acquisition_delay: float = 0.001) -> EpochsStream:
Expand Down Expand Up @@ -317,6 +318,16 @@ class EpochsStream:
:type: :class:`bool`
"""

@property
def events(self) -> NDArray[np.int16]:
"""Events of the epoched LSL stream.
Contrary to the events stored in ``mne.Epochs.events``, only the integer code
of the event is stored in a :class:`~mne_lsl.stream.EpochsStream` object.
:type: :class:`numpy.ndarray`
"""

@property
def info(self) -> Info:
"""Info of the epoched LSL stream.
Expand Down

0 comments on commit aebbeb3

Please sign in to comment.