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

Fix segment registering in coarser mags for non-mag-aligned bounding boxes #8364

Merged
merged 3 commits into from
Feb 3, 2025

Conversation

daniel-wer
Copy link
Member

@daniel-wer daniel-wer commented Jan 29, 2025

When registering segments for a bounding box in a mag other than the finest one and if the bounding box is not mag-aligned it was not taken into account that the getDataForBoundingBox might grow the bounding box to be mag-aligned. In that case more data is returned and the indexing may change, resulting in incorrect segment positions.

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • Create an annotation for l4_v2_sample or another dataset which has mag 16-16-8, choose an empty volume layer and restrict the volume annotation to mag 16-16-8
  • Create a bounding box with topleft and size 1119, 1111, 1103, 640, 653, 903 (this was chosen to be "maximally mag-unaligned" to provoke the bounding box growing)
  • Make a single brush stroke at 1680, 1632, 1920
  • Register Segments for the bounding box
  • Switch to the segments tab and click on the segment - wk should jump to the segment (on master wk jumps somewhere else)

(Please delete unneeded items, merge only when none are left open)

@daniel-wer daniel-wer added the bug label Jan 29, 2025
@daniel-wer daniel-wer self-assigned this Jan 29, 2025
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

📝 Walkthrough

Walkthrough

The pull request introduces changes to WEBKNOSSOS, focusing on new features for dataset rotation configuration, streamlined annotation versioning, and enhanced bounding box handling. Users can initiate a split-merger evaluation during neuron inference, and the "Restore older Version" feature now consolidates annotation history. Bug fixes address issues with tree merging and segment registration in non-mag-aligned bounding boxes. The changelog also notes the removal of volume annotation downsampling.

Changes

File Change Summary
CHANGELOG.unreleased.md Updated with new features, bug fixes, and feature removals related to annotation and dataset handling
frontend/javascripts/oxalis/api/api_latest.ts Added BoundingBox import and modified registerSegmentsForBoundingBox method to improve bounding box handling and alignment

Possibly related PRs

Suggested labels

backend

Suggested reviewers

  • normanrz
  • fm3

Poem

🐰 Hop, hop, through code's domain,
Bounding boxes dance, no more pain!
Rotations spin, versions align,
Merging layers, all intertwine,
A rabbit's code, precise and bright! 🔍


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 73921a2 and 10e2d09.

📒 Files selected for processing (1)
  • CHANGELOG.unreleased.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.unreleased.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: circleci_build

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@fm3 fm3 added the frontend label Jan 30, 2025
Comment on lines +707 to +708
// getDataForBoundingBox grows the bounding box to be mag-aligned which can change the dimensions
const boundingBoxInMag1MagAligned = boundingBoxInMag1.alignWithMag(currentMag, "grow");
Copy link
Contributor

Choose a reason for hiding this comment

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

Just for my understanding, where can I find the code in which getDataForBoundingBox might be growing the bbox?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's quite hidden because the code is complex, which is unfortunate. getDataForBoundingBox requests all buckets that intersect with the mag 1 bounding box (getBucketAddressesInCuboid) so the gathered data usually is larger than the mag 1 bounding box, because the bounding box is not aligned to 32³ buckets. Then, cutOutCuboid is called which converts the mag 1 bounding box to the request mag by using the scaleGlobalPositionWithMagnification method. This method has a ceil argument which is not set for top left (so that is floored) and set for bottom right. This possibly grows the bounding box (when thinking about it in mag 1 coordinates, which is what is done to determine the segment positions).
Does that make sense?

Copy link
Contributor

@knollengewaechs knollengewaechs Jan 31, 2025

Choose a reason for hiding this comment

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

Okay, that makes sense! I understand that to align the bounding box with the given mag, both in cutOutCuboid->scaleGlobalPositionWithMagnification the topLeft (min) is floored and the bottomRight (max) is ceiled, which is the same as what is happening in alignWithMag when it's called with the argument "grow".

Copy link
Contributor

@knollengewaechs knollengewaechs left a comment

Choose a reason for hiding this comment

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

Thank you for fixing this! 🙏
Testing went well and the code makes sense!

@bulldozer-boy bulldozer-boy bot merged commit 9f1a334 into master Feb 3, 2025
3 checks passed
@bulldozer-boy bulldozer-boy bot deleted the fix-register-segments-for-higher-mags branch February 3, 2025 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants