Merge branch 'add-angle' into 'main'

Add angle

See merge request !26

.gitlab-ci.yml

@@ -57,7 +57,7 @@ Julia 1.9:
 
 
 docs:
-  image: docker.km3net.de/base/julia:1.8-tex
+  image: docker.km3net.de/base/julia:1.9-tex
   stage: docs
   script:
     - |

Project.toml

 name = "KM3io"
 uuid = "2cab5852-6f21-4982-99b0-6a4792870cfb"
 authors = ["Tamas Gal", "Johannes Schumann"]
-version = "0.16.2"
+version = "0.16.3"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

docs/src/api.md

@@ -150,3 +150,8 @@ bestaashower
 RecStageRange
 hashistory
 ```
+
+### Math
+```@docs
+angle
+```

src/KM3io.jl

@@ -102,6 +102,7 @@ include("tools/general.jl")
 include("tools/daq.jl")
 include("tools/trigger.jl")
 include("tools/reconstruction.jl")
+include("tools/math.jl")
 include("tools/helpers.jl")
 
 include("physics.jl")

src/tools/math.jl

+"""
+Calculate the angle between two vectors.
+"""
+Base.angle(d1::Direction, d2::Direction) = acos(min(dot(normalize(d1), normalize(d2)), 1))
+Base.angle(a::T, b::T) where {T<:Union{KM3io.AbstractCalibratedHit, KM3io.PMT}} = Base.angle(a.dir, b.dir)
+Base.angle(a, b::Union{KM3io.AbstractCalibratedHit, KM3io.PMT}) = Base.angle(a, b.dir)
+Base.angle(a::Union{KM3io.AbstractCalibratedHit, KM3io.PMT}, b) = Base.angle(a.dir, b)

test/tools.jl

@@ -327,3 +327,11 @@ end
     @assert 111 == length(mc_event.mc_hits)
     @assert 4 == length(mc_event.mc_trks)
 end
+
+
+@testset "math" begin
+    @test 0 == angle(Direction(1.,0,0), Direction(1.,0,0))
+    @test π/2 ≈ angle(Direction(1.,0,0), Direction(0.,1,0))
+    @test π/2 ≈ angle(Direction(1.,0,0), Direction(0.,0,1))
+    @test π ≈ angle(Direction(1.,0,0), Direction(-1.,0,0))
+end