-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Ayushmore1214
wants to merge
3
commits into
mne-tools:main
Choose a base branch
from
Ayushmore1214:fix-to_data_frame-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 ' '. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?