Skip to content

Conversation

niksirbi
Copy link
Member

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
Closes #415

What does this PR do?

Adds a new "Time spent in regions of interest" example based on the Elevated Plus Maze (EPM) dataset.
This example guides the user through:

  • Drawing ROIs as napari Shapes and saving the using native napari functionality
  • Loading said shaped into movement PolygonOfInterest objects
  • Conputing occupancy across the defined regions
  • Quantifying % time spent per region

References

Closes #415
Closes #410

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?

No.

Does this PR require an update to the documentation?

This PR is mostly an update to the documentaiton.

Checklist:

  • The code has been tested locally
  • 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

@niksirbi niksirbi force-pushed the niko-region-occupancy-example branch from d8d4085 to 8c6b3fc Compare June 17, 2025 17:48
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Copy link

codecov bot commented Jun 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6fe3ffc) to head (8c6b3fc).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #615   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           32        32           
  Lines         1786      1786           
=========================================
  Hits          1786      1786           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Write new sphinx-gallery example, showcasing time spent in regions of interest Example for "quick plot" functions

1 participant