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

Reorder dimensions to start with space and time #236

Closed
niksirbi opened this issue Jul 11, 2024 · 1 comment · Fixed by #351
Closed

Reorder dimensions to start with space and time #236

niksirbi opened this issue Jul 11, 2024 · 1 comment · Fixed by #351
Assignees
Labels
enhancement New optional feature

Comments

@niksirbi
Copy link
Member

Is your feature request related to a problem? Please describe.
In our current dataset structure the order of xarray dimensions is: time, individuals, keypoints, space.

This is not very intuitive, namely because time and space are the most essential dimensions which should always exist regardless of how motion was tracked. As we move toward supporting more types of data, and possibly making non-spacetime dimensions optional (e.g. create keypoints only if more than 1 is present, and ditto for individuals), and it makes more sense to put the "essential" dimensions at the beginning and the optional ones at the end.

This was brought up by @sfmig, and we both think this would make sense.

Describe the solution you'd like
Reorder dimensions in order of "essentiality": time, space, keypoints, individuals, views (if we adopt #196).
This shouldn't be too hard as we could simply add xarray's transpose() methods at the end of our loading functions to get the desired order. But we would have to adapt validators (related to #210), tests and docs.

Describe alternatives you've considered

  • space, time, keypoints, individual, views
  • Keep things as they are, don't fix it if it ain't broken?

Additional context

@vigji
Copy link
Collaborator

vigji commented Jul 11, 2024

I think this would be important yes! Even with the option of optional dimensions, keeping the essential first would be very relevant

@lochhh lochhh self-assigned this Oct 8, 2024
@lochhh lochhh mentioned this issue Nov 25, 2024
13 tasks
@niksirbi niksirbi moved this from 📝 Todo to 🚧 In Progress in movement progress tracker Nov 27, 2024
@github-project-automation github-project-automation bot moved this from 🚧 In Progress to ✅ Done in movement progress tracker Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New optional feature
Projects
Development

Successfully merging a pull request may close this issue.

3 participants