[DOC] Add documentation for grid_intersections

[CHrlS98]

Quick description

Grid_intersections documentation. closes #745

Type of change

Check the relevant options.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Provide data, screenshots, command line to test (if relevant)

Checklist

• My code follows the style guidelines of this project (run autopep8)
• I added relevant citations to scripts, modules and functions docstrings and descriptions
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I moved all functions from the script file (except the argparser and main) to scilpy modules
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[AntoineTheb]

Good description. I would rename the function something like "regrid_streamlines_at_voxel_faces" or something.

[frheault]

I propose renaming the function to
voxel_boundary_intersection or something like subdivide_segment_to_voxel_boundary

Also I am not sure the variable name <all_crossed_indices> is appropriate? Would it be better to say <all_crossed_coordinates>?

[pep8speaks]

Hello @CHrlS98, Thank you for updating !

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2024-12-12 20:00:53 UTC

[codecov]

Codecov Report

Attention: Patch coverage is 80.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 69.48%. Comparing base (e256482) to head (06c9a77).
Report is 31 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1079      +/-   ##
==========================================
+ Coverage   69.46%   69.48%   +0.02%     
==========================================
  Files         447      447              
  Lines       24052    24052              
  Branches     3291     3291              
==========================================
+ Hits        16708    16713       +5     
+ Misses       5946     5941       -5     
  Partials     1398     1398              

Components	Coverage Δ
Scripts	70.26% <ø> (ø)
Library	68.44% <80.00%> (+0.04%)	⬆️

[AntoineTheb]

Need to fix pep8 and conflicts with the main branch but otherwise LGTM

[CHrlS98]

@AntoineTheb Do we really care about pep8 for setup.py? It was already busting the limit for line length.

[AlexVCaron]

@AntoineTheb Do we really care about pep8 for setup.py? It was already busting the limit for line length.

You can add the comment # noqa at the end of lines you want pep8 to skip. It does however skip all checks, but could be good if sparsely used.

[arnaudbore]

GTG