implement distance to surface and add the surface types to HPGe object

[tdixon97]

This implements a calculation of the distance between points and the surface.

• methods for distance to surface for cylindrical detectors,
• tests
• add an attribute to HPGe class of the surface type,
• adds method to compute surface area
• distance to different surface (n+,p+ etc.)
• check on if point is inside / outside (attach a direction to the distance),
  Also slightly refactors definitions of the surface for some detector types so that if there is no groove the p+ surface is still always separate from the others.

We should also add.

• generalization to asymmetric detectors (including the surface types), add later. Only P00664A, V02160A

But these could be added later since the correct exceptions are raised in these cases currently.

[codecov]

Codecov Report

Attention: Patch coverage is 68.51852% with 85 lines in your changes missing coverage. Please review.

Project coverage is 77.86%. Comparing base (a7c9b2c) to head (ad7b135).
Report is 64 commits behind head on main.

Files with missing lines	Patch %	Lines
src/legendhpges/utils.py	53.22%	29 Missing ⚠️
src/legendhpges/draw.py	0.00%	22 Missing ⚠️
src/legendhpges/base.py	91.80%	5 Missing ⚠️
src/legendhpges/p00664b.py	54.54%	5 Missing ⚠️
src/legendhpges/ppc.py	54.54%	5 Missing ⚠️
src/legendhpges/invcoax.py	73.33%	4 Missing ⚠️
src/legendhpges/v02160a.py	73.33%	4 Missing ⚠️
src/legendhpges/v07646a.py	75.00%	4 Missing ⚠️
src/legendhpges/semicoax.py	72.72%	3 Missing ⚠️
src/legendhpges/bege.py	83.33%	2 Missing ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #51      +/-   ##
==========================================
- Coverage   79.74%   77.86%   -1.88%     
==========================================
  Files          14       16       +2     
  Lines         548      768     +220     
==========================================
+ Hits          437      598     +161     
- Misses        111      170      +59     

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

[ManuelHu]

just an idea: maybe it would make sense to split utils into two parts; one that creates geometry (i.e. helpers for contacts, maybe spherical segments later on) and one for consuming geometry (i.e. calculating distances)?

[tdixon97]

Yes probably you are right

[gipert]

Another thing to take care of: I think that because of finite numerical precision some hits could be found outside the detector by a tiny amount -> we should push them back in

[ManuelHu]

just some minor stuff I found while looking at the docs

[tdixon97]

Another thing to take care of: I think that because of finite numerical precision some hits could be found outside the detector by a tiny amount -> we should push them back in

This is not necessarily so trivial, need to compute if a point is inside vs outside, i.e. attach a sign to the distance.

[gipert]

I left some comments.

All of this can be very easily sped up with Numba, let's do that.

[tdixon97]

I left some comments.

All of this can be very easily sped up with Numba, let's do that.

Now done.

[tdixon97]

Any more issues? Can we merge this ?

[ManuelHu]

for me it looks fine, we can always iterate later if we need to.

[tdixon97]

Should have now fixed your last comments @gipert

[gipert]

I have removed the pre-commit commits and pushed some cosmetic stuff, getting ready to merge