Skip to content
Snippets Groups Projects
Verified Commit 1d3fc21c authored by Tamas Gal's avatar Tamas Gal :speech_balloon:
Browse files

Get rid of field access in favour of getters

parent a934c463
No related branches found
No related tags found
1 merge request!34Draft: Detector toolkit
Hide whitespace changes
Inline Side-by-side
src/hardware.jl
+ 18
− 19
View file @ 1d3fc21c
......@@ -49,24 +49,24 @@ struct DetectorModule
id::Int32
pos::Position{Float64}
location::Location
n_pmts::Int8
pmts::Vector{PMT}
q::Union{Quaternion{Float64}, Missing}
status::Int32
t₀::Float64
end
function Base.show(io::IO, m::DetectorModule)
info = m.location.floor == 0 ? "base" : "optical, $(m.n_pmts) PMTs"
info = m.location.floor == 0 ? "base" : "optical, $(length(m)) PMTs"
print(io, "Detectormodule ($(info)) on string $(m.location.string) floor $(m.location.floor)")
end
Base.length(d::DetectorModule) = d.n_pmts
Base.length(d::DetectorModule) = length(d.pmts)
Base.eltype(::Type{DetectorModule}) = PMT
Base.iterate(d::DetectorModule, state=1) = state > d.n_pmts ? nothing : (d.pmts[state], state+1)
Base.iterate(d::DetectorModule, state=1) = state > length(d) ? nothing : (d.pmts[state], state+1)
Base.isless(lhs::DetectorModule, rhs::DetectorModule) = lhs.location < rhs.location
function Base.isapprox(lhs::DetectorModule, rhs::DetectorModule; kwargs...)
for field in [:id, :location, :n_pmts, :status]
for field in [:id, :location, :status]
getfield(lhs, field) == getfield(rhs, field) || return false
end
length(lhs) == length(rhs) || return false
for field in [:pos, :q, :t₀]
isapprox(getfield(lhs, field), getfield(rhs, field); kwargs...) || return false
end
......@@ -88,7 +88,7 @@ isbasemodule(d::DetectorModule) = d.location.floor == 0
"""
Returns true if the module is an optical module.
"""
isopticalmodule(d::DetectorModule) = d.n_pmts > 0
isopticalmodule(d::DetectorModule) = length(d) > 0
getpmts(d::DetectorModule) = d.pmts
"""
Get the PMT for a given DAQ channel ID (TDC)
......@@ -277,7 +277,6 @@ struct Detector
validity::Union{DateRange, Missing}
pos::Union{UTMPosition{Float64}, Missing}
utm_ref_grid::Union{String, Missing}
n_modules::Int32
modules::Dict{Int32, DetectorModule}
locations::Dict{Tuple{Int, Int}, DetectorModule}
strings::Vector{Int}
......@@ -287,12 +286,12 @@ end
Return a vector of all modules of a given detector.
"""
modules(d::Detector) = collect(values(d.modules))
Base.show(io::IO, d::Detector) = print(io, "Detector $(d.id) (v$(d.version)) with $(length(d.strings)) strings and $(d.n_modules) modules.")
Base.length(d::Detector) = d.n_modules
Base.show(io::IO, d::Detector) = print(io, "Detector $(d.id) (v$(d.version)) with $(length(d.strings)) strings and $(length(d)) modules.")
Base.length(d::Detector) = length(d.modules)
Base.eltype(::Type{Detector}) = DetectorModule
function Base.iterate(d::Detector, state=(Int[], 1))
module_ids, count = state
count > d.n_modules && return nothing
count > length(d) && return nothing
if count == 1
module_ids = collect(keys(d.modules))
end
......@@ -427,11 +426,11 @@ function read_datx(io::IO)
pmt_status = read(io, Int32)
push!(pmts, PMT(pmt_id, pmt_pos, pmt_dir, pmt_t₀, pmt_status))
end
m = DetectorModule(module_id, module_pos, location, n_pmts, pmts, q, module_status, module_t₀)
m = DetectorModule(module_id, module_pos, location, pmts, q, module_status, module_t₀)
modules[module_id] = m
locations[(location.string, location.floor)] = m
end
Detector(version, det_id, validity, utm_position, utm_ref_grid, n_modules, modules, locations, strings, comments)
Detector(version, det_id, validity, utm_position, utm_ref_grid, modules, locations, strings, comments)
end
@inline _readstring(io) = String(read(io, read(io, Int32)))
......@@ -543,13 +542,13 @@ function read_detx(io::IO)
end
end
m = DetectorModule(module_id, pos, Location(string, floor), n_pmts, pmts, q, status, t₀)
m = DetectorModule(module_id, pos, Location(string, floor), pmts, q, status, t₀)
modules[module_id] = m
locations[(string, floor)] = m
idx += n_pmts + 1
end
Detector(version, det_id, validity, utm_position, utm_ref_grid, n_modules, modules, locations, strings, comments)
Detector(version, det_id, validity, utm_position, utm_ref_grid, modules, locations, strings, comments)
end
......@@ -629,7 +628,7 @@ function write(io::IO, d::Detector; version=:same)
end
end
if version == 1
writeln(io, "$(d.id) $(d.n_modules)")
writeln(io, "$(d.id) $(length(d))")
elseif version > 1
writeln(io, "$(d.id) v$(version)")
end
......@@ -658,13 +657,13 @@ function write(io::IO, d::Detector; version=:same)
end
if version > 1
writeln(io, "$(d.n_modules)")
writeln(io, "$(length(d))")
end
# TODO: module sorting is not needed according to specs but Jpp has problems with it
for mod in sort(collect(values(d.modules)); by=m->(m.location.string, m.location.floor))
if version < 4
writeln(io, "$(mod.id) $(mod.location.string) $(mod.location.floor) $(mod.n_pmts)")
writeln(io, "$(mod.id) $(mod.location.string) $(mod.location.floor) $(length(mod))")
else
if ismissing(mod.q)
q0, qx, qy, qz = (0, 0, 0, 0)
......@@ -672,10 +671,10 @@ function write(io::IO, d::Detector; version=:same)
q0, qx, qy, qz = mod.q
end
if version == 4
@printf(io, "%d %d %d %.8f %.8f %.8f %.8f %.8f %.8f %.8f %.8f %d\n", mod.id, mod.location.string, mod.location.floor, mod.pos.x, mod.pos.y, mod.pos.z, q0, qx, qy, qz, mod.t₀, mod.n_pmts)
@printf(io, "%d %d %d %.8f %.8f %.8f %.8f %.8f %.8f %.8f %.8f %d\n", mod.id, mod.location.string, mod.location.floor, mod.pos.x, mod.pos.y, mod.pos.z, q0, qx, qy, qz, mod.t₀, length(mod))
end
if version > 4
@printf(io, "%d %d %d %.8f %.8f %.8f %.8f %.8f %.8f %.8f %.8f %d %d\n", mod.id, mod.location.string, mod.location.floor, mod.pos.x, mod.pos.y, mod.pos.z, q0, qx, qy, qz, mod.t₀, mod.status, mod.n_pmts)
@printf(io, "%d %d %d %.8f %.8f %.8f %.8f %.8f %.8f %.8f %.8f %d %d\n", mod.id, mod.location.string, mod.location.floor, mod.pos.x, mod.pos.y, mod.pos.z, q0, qx, qy, qz, mod.t₀, mod.status, length(mod))
end
end
for pmt in mod
......
test/acoustics.jl
+ 4
− 4
View file @ 1d3fc21c
......@@ -12,22 +12,22 @@ const SAMPLES_DIR = joinpath(@__DIR__, "samples")
@test 0.0031588078f0 == signal.pcm[1]
@test 0.0033951998f0 == signal.pcm[end]
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), 0, PMT[], missing, 0, 0)
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), PMT[], missing, 0, 0)
@test hydrophoneenabled(mod)
@test piezoenabled(mod)
status = 1 << KM3io.MODULE_STATUS.PIEZO_DISABLE
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), 0, PMT[], missing, status, 0)
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), PMT[], missing, status, 0)
@test !piezoenabled(mod)
@test hydrophoneenabled(mod)
status = 1 << KM3io.MODULE_STATUS.HYDROPHONE_DISABLE
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), 0, PMT[], missing, status, 0)
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), PMT[], missing, status, 0)
@test piezoenabled(mod)
@test !hydrophoneenabled(mod)
status = (1 << KM3io.MODULE_STATUS.HYDROPHONE_DISABLE) | (1 << KM3io.MODULE_STATUS.PIEZO_DISABLE)
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), 0, PMT[], missing, status, 0)
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), PMT[], missing, status, 0)
@test !piezoenabled(mod)
@test !hydrophoneenabled(mod)
end
test/hardware.jl
+ 2
− 4
View file @ 1d3fc21c
......@@ -64,7 +64,7 @@ const SAMPLES_DIR = joinpath(@__DIR__, "samples")
@test 9999999999.0 == datetime2unix(d.validity.to)
end
@test 31 == d.modules[808992603].n_pmts
@test 31 == length(d.modules[808992603])
@test 30 == d.modules[817287557].location.string
@test 18 == d.modules[817287557].location.floor
@test Location(30, 18) == d[817287557].location
......@@ -95,8 +95,6 @@ const SAMPLES_DIR = joinpath(@__DIR__, "samples")
@test isapprox([116.60000547853453, 106.95689770873874, 60.463039635848226], d.modules[808992603].pos; atol=0.008)
@test 78.3430067946102 ≈ getpmt(d[15, 13], 0).pos.x
m = d[15, 13]
@test m.n_pmts == length(getpmts(m))
end
comments = Detector(joinpath(SAMPLES_DIR, "v3.detx")).comments
......@@ -203,7 +201,7 @@ end
end
@testset "utilities" begin
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), 0, PMT[], missing, 0, 0)
mod = DetectorModule(1, UTMPosition(0, 0, 0), Location(0, 0), PMT[], missing, 0, 0)
@test hydrophoneenabled(mod)
@test piezoenabled(mod)
for version ∈ 1:5
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment