Skip to content

Fix to_data_frame doc in Annotations #13177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added Advanced
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a few files were added in error, like this one?

Empty file.
Empty file added App
Empty file.
Empty file added Apps
Empty file.
22 changes: 13 additions & 9 deletions mne/annotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,21 +132,25 @@ class Annotations:
description : array of str, shape (n_annotations,) | str
Array of strings containing description for each annotation. If a
string, all the annotations are given the same description. To reject
epochs, use description starting with keyword 'bad'. See example above.
epochs, use description starting with keyword 'bad'.
orig_time : float | str | datetime | tuple of int | None
A POSIX Timestamp, datetime or a tuple containing the timestamp as the
A POSIX Timestamp, datetime, or tuple containing the timestamp as the
first element and microseconds as the second element. Determines the
starting time of annotation acquisition. If None (default),
starting time is determined from beginning of raw data acquisition.
In general, ``raw.info['meas_date']`` (or None) can be used for syncing
the annotations with raw data if their acquisition is started at the
same time. If it is a string, it should conform to the ISO8601 format.
More precisely to this '%%Y-%%m-%%d %%H:%%M:%%S.%%f' particular case of
the ISO8601 format where the delimiter between date and time is ' '.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this errantly removed?

starting time of annotation acquisition.

%(ch_names_annot)s

.. versionadded:: 0.23

Attributes
----------
onset : ndarray
The starting times of annotations in seconds relative to `orig_time`.
duration : ndarray
Durations of the annotations in seconds.
description : ndarray
Description labels for each annotation.

See Also
--------
mne.annotations_from_events
Expand Down
Loading