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

Add the option for multiple views loading - take2 #346

Merged
merged 5 commits into from
Nov 22, 2024

Conversation

vigji
Copy link
Collaborator

@vigji vigji commented Nov 20, 2024

Before submitting a pull request (PR), please read the contributing guide.

Just moving code from #197

Description

What is this PR

  • Bug fix
  • [ x] Addition of a new feature
  • Other

Why is this PR needed?

What does this PR do?

References

Please reference any existing issues/PRs that relate to this PR.

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

If this PR breaks any existing functionality, please explain how and why.

Does this PR require an update to the documentation?

If any features have changed, or have been added. Please explain how the
documentation has been updated.

Checklist:

  • [x ] The code has been tested locally
  • [x ] Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.78%. Comparing base (a3956c4) to head (a753281).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #346   +/-   ##
=======================================
  Coverage   99.77%   99.78%           
=======================================
  Files          14       14           
  Lines         907      912    +5     
=======================================
+ Hits          905      910    +5     
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@niksirbi niksirbi self-requested a review November 21, 2024 11:59
Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

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

Thanks for re-opening this PR @vigji.

I think this is basically ready to go. I consider the new function sufficiently tested for what it does. If you find hiccups/stumbling blocks in day-to-day usage, you are welcome to fix them with additional PRs.

Regarding documentation, I think for now it would be sufficient to add the following snippet to the end of the "Dimensions and Coordinates" section of the "movement datasets" page:

:::{dropdown} Additional dimensions
:color: info
:icon: info
The above **dimensions** and **coordinates** are created
by default when loading a `movement` dataset from a single
file containing pose or bounding boxes tracks.

In some cases, you may encounter or create datasets with extra
**dimensions**. For example, the
{func}`movement.io.load_poses.from_multiview_files()` function
creates an additional `views` **dimension**,
with the **coordinates** being the names given to each camera view.
:::

This should render a dropdown like this:

Screenshot 2024-11-21 at 12 28 49

Additional documentation, in form of an example, can be added later when we have some appropriate sample data and perhaps triangulation functionality.

With the above addition, I'll be happy to merge this.

movement/io/load_poses.py Outdated Show resolved Hide resolved
vigji and others added 2 commits November 21, 2024 16:37
Co-authored-by: Niko Sirmpilatze <niko.sirbiladze@gmail.com>
@vigji
Copy link
Collaborator Author

vigji commented Nov 21, 2024

Ok, this should have been taken care of now!

@niksirbi niksirbi added this pull request to the merge queue Nov 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 22, 2024
@niksirbi niksirbi added this pull request to the merge queue Nov 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 22, 2024
@niksirbi niksirbi added this pull request to the merge queue Nov 22, 2024
Merged via the queue into neuroinformatics-unit:main with commit 174817d Nov 22, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants