ziotom78 / Healpix.jl

Healpix library written in Julia
GNU General Public License v2.0
51 stars 18 forks source link

getAllNeighbours #107

Open aurelio-amerio opened 1 year ago

aurelio-amerio commented 1 year ago

Hello. Following https://healpix.jpl.nasa.gov/html/Healpix_cxx/healpix__base2_8cc-source.html I have implemented the function getAllNeighbours to find the pixels around a given pixel in ring/nest ordering. I have also added a test for it.

You might want to consider whether to rename it "getAllNeighbors", to comform the name with American English...

I hope the contribution is useful!

ziotom78 commented 1 year ago

Thanks a lot! I've added a few review comments. May you please add some documentation for the function in the manual as well? (Adding getAllNeighboursRing and getAllNeighboursNest to the list at the end of file docs/src/pixelfunc.md would be enough.)

codecov[bot] commented 1 year ago

Codecov Report

Attention: 29 lines in your changes are missing coverage. Please review.

Comparison is base (640832f) 91.08% compared to head (38b2701) 89.29%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #107 +/- ## ========================================== - Coverage 91.08% 89.29% -1.79% ========================================== Files 20 20 Lines 1447 1495 +48 ========================================== + Hits 1318 1335 +17 - Misses 129 160 +31 ``` | [Files](https://app.codecov.io/gh/ziotom78/Healpix.jl/pull/107?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Maurizio+Tomasi) | Coverage Δ | | |---|---|---| | [src/pixelfunc.jl](https://app.codecov.io/gh/ziotom78/Healpix.jl/pull/107?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Maurizio+Tomasi#diff-c3JjL3BpeGVsZnVuYy5qbA==) | `87.80% <32.55%> (-9.74%)` | :arrow_down: | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/ziotom78/Healpix.jl/pull/107/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Maurizio+Tomasi)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

aurelio-amerio commented 1 year ago

Hello, I'm not sure where to see your review comments, I only see the codecov comments and will work on them as soon as possible. I'll also add the documentation bit, and a function with Ring/Nest in the name. Anything else?

ziotom78 commented 1 year ago

Hello, I'm not sure where to see your review comments, I only see the codecov comments and will work on them as soon as possible. I'll also add the documentation bit, and a function with Ring/Nest in the name. Anything else?

Thanks a lot! The review comments should be displayed above in this very page (I can see them right now), they appear as normal posts but are associated with specific code snippets.

aurelio-amerio commented 1 year ago

I just wanted to say I've been very busy with work lately and I did't get to do the necessary updates. I will do it as soon as I have a bit more free time

ziotom78 commented 1 year ago

I just wanted to say I've been very busy with work lately and I did't get to do the necessary updates. I will do it as soon as I have a bit more free time

Don't worry! We're all very busy.