Skip to content
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

AnnotationSeries should optionally contain a target #587

Open
bendichter opened this issue Aug 1, 2024 · 1 comment
Open

AnnotationSeries should optionally contain a target #587

bendichter opened this issue Aug 1, 2024 · 1 comment
Assignees
Labels
category: proposal proposed enhancements or new features

Comments

@bendichter
Copy link
Contributor

- neurodata_type_def: AnnotationSeries
neurodata_type_inc: TimeSeries
doc: Stores user annotations made during an experiment. The data[]
field stores a text array, and timestamps are stored for each annotation (ie,
interval=1). This is largely an alias to a standard TimeSeries storing a text
array but that is identifiable as storing annotations in a machine-readable way.
datasets:
- name: data
dtype: text
dims:
- num_times
shape:
- null
doc: Annotations made during an experiment.
attributes:
- name: resolution
dtype: float32
value: -1.0
doc: Smallest meaningful difference between values in data. Annotations have
no units, so the value is fixed to -1.0.
- name: unit
dtype: text
value: n/a
doc: Base unit of measurement for working with the data. Annotations have
no units, so the value is fixed to 'n/a'.

I am looking into creating a tutorial for AnnotationSeries. I think this is a useful type to keep around, and different enough from Event structures. However, I think it would be more useful if it was able to point to a TimeSeries. What do you all think about adding an optional link to a TimeSeries object?

@rly
Copy link
Contributor

rly commented Aug 1, 2024

What would be the meaning/relevance of the linked TimeSeries? Can you give an example where neither the EventsTable nor the TimeIntervals table would be appropriate?

Maybe if the camera was moved starting at time A and was reset to its original position at time B, then you would want to say just the SpatialSeries from time A to time B is invalid. That's more of a time interval than an event. And in TimeIntervals, we can already link to specific TimeSeries.

@rly rly added the category: proposal proposed enhancements or new features label Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: proposal proposed enhancements or new features
Projects
None yet
Development

No branches or pull requests

2 participants