search

marcomusy / vedo

A python module for scientific analysis of 3D data based on VTK and Numpy
https://vedo.embl.es
MIT License
1.98k stars 257 forks source link

bugfix: add tolerance to contains #1105

Closed JeffreyWardman closed 2 months ago

JeffreyWardman commented 2 months ago

As per https://numpy.org/doc/stable/reference/generated/numpy.isclose.html, numpy.isclose(a, b, rtol=1e-05, atol=1e-08, equal_nan=False)

Currently, b is set to tol, which defaults to 0. It should always be 0 and the tol should either be relative or absolute (rtol/atol). Therefore the setting of input variables is incorrect at the moment.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The primary update focuses on refining the precision of the contains method in the vedo library by introducing an additional atol parameter in the isclose function call. This adjustment enhances the method's accuracy in determining point containment within shapes by providing a more customizable tolerance setting, thereby improving its utility across various computational scenarios.

Changes

File Summary of Changes
vedo/shapes.py Adjusted tolerance parameter in contains method with the addition of atol in isclose function call.
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between d874911da97979712c96a8bacf8eaba11dc822e4 and d9c12f6bbdf4a6406b808e1f6fdce5c233b2c016.
Files selected for processing (1) * vedo/shapes.py (1 hunks)
Additional Context Used
Ruff (24)
vedo/shapes.py (24)
3939-3939: Multiple statements on one line (colon) --- 3940-3940: Multiple statements on one line (colon) --- 3941-3941: Multiple statements on one line (colon) --- 3942-3942: Multiple statements on one line (colon) --- 3943-3943: Multiple statements on one line (colon) --- 3962-3962: Do not use bare `except` --- 3986-3986: Do not use bare `except` --- 3994-3994: Do not use bare `except` --- 4322-4322: Multiple statements on one line (colon) --- 4323-4323: Multiple statements on one line (colon) --- 4324-4324: Multiple statements on one line (colon) --- 4325-4325: Multiple statements on one line (colon) --- 4464-4464: Multiple statements on one line (colon) --- 4465-4465: Multiple statements on one line (colon) --- 4466-4466: Multiple statements on one line (colon) --- 4726-4726: Multiple statements on one line (colon) --- 4727-4727: Multiple statements on one line (colon) --- 4728-4728: Multiple statements on one line (colon) --- 4730-4730: Multiple statements on one line (colon) --- 4731-4731: Multiple statements on one line (colon) --- 4732-4732: Multiple statements on one line (colon) --- 4734-4734: Multiple statements on one line (colon) --- 4735-4735: Multiple statements on one line (colon) --- 4736-4736: Multiple statements on one line (colon)
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.