Skip to content

Clarify documentation of IndexSeries #605

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
h-mayorquin opened this issue Jan 28, 2025 · 1 comment · May be fixed by #614
Open

Clarify documentation of IndexSeries #605

h-mayorquin opened this issue Jan 28, 2025 · 1 comment · May be fixed by #614
Assignees
Labels
category: question questions about code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation

Comments

@h-mayorquin
Copy link
Contributor

The documentation of IndexSeries looks confusing to me in the sense that the case of indexing an ImageSeries and the static images of an Images container seem to be mixed in the explanation:

- neurodata_type_def: IndexSeries
neurodata_type_inc: TimeSeries
doc: Stores indices to image frames stored in an ImageSeries. The purpose of the
IndexSeries is to allow a static image stack to be stored in an Images
object, and the images in the stack to be referenced out-of-order. This can be for
the display of individual images, or of movie segments (as a movie is simply a
series of images). The data field stores the index of the frame in the referenced
Images object, and the timestamps array indicates when that image
was displayed.

Are both cases supported?
I can improve it to clarify that it can be used for both cases but I wanted to be sure.

@stephprince stephprince added priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation category: question questions about code or code behavior labels Feb 20, 2025
@rly rly self-assigned this Feb 20, 2025
@rly
Copy link
Contributor

rly commented Feb 20, 2025

@h-mayorquin can you please create a PR to clarify the doc? We want to discourage the use of ImageSeries, and encourage the use of Images.

@rly rly assigned h-mayorquin and unassigned rly Feb 20, 2025
@h-mayorquin h-mayorquin linked a pull request Mar 13, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: question questions about code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants