Add HPGeEnvironment (#91)

Author: hervasa2

Project.toml

@@ -62,7 +62,7 @@ Pkg = "1"
 Plots = "<0.0.1, 1"
 Printf = "<0.0.1, 1"
 ProgressMeter = "1.5"
-PropDicts = "0.2.4"
+PropDicts = "0.2.9"
 PropertyDicts = "0.2.1"
 PropertyFunctions = "0.2.2"
 RecipesBase = "1"

ext/LegendDataManagementSolidStateDetectorsExt.jl

@@ -19,35 +19,27 @@ LegendDataManagement provides an extension for SolidStateDetectors, a
 `SolidStateDetector` can be constructed from LEGEND metadata using the
 methods above.
 """
-function SolidStateDetectors.SolidStateDetector(data::LegendData, detector::DetectorIdLike)
-    SolidStateDetectors.SolidStateDetector{_SSDDefaultNumtype}(data, detector)
+function SolidStateDetectors.SolidStateDetector(data::LegendData, meta::Union{<:String, <:AbstractDict, <:DetectorIdLike}, env::HPGeEnvironment = HPGeEnvironment())
+    SolidStateDetector{_SSDDefaultNumtype}(data, meta, env)
 end
 
-function SolidStateDetectors.SolidStateDetector{T}(data::LegendData, detector::DetectorIdLike) where {T<:AbstractFloat}
+function SolidStateDetectors.SolidStateDetector{T}(data::LegendData, detector::DetectorIdLike, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
     detector_props = getproperty(data.metadata.hardware.detectors.germanium.diodes, Symbol(detector))
     xtal_props = getproperty(data.metadata.hardware.detectors.germanium.crystals, Symbol(string(detector)[1:end-1]))
-    SolidStateDetector{T}(LegendData, detector_props, xtal_props)
+    SolidStateDetector{T}(LegendData, detector_props, xtal_props, env)
 end
 
-function SolidStateDetectors.SolidStateDetector{T}(::Type{LegendData}, filename::String) where {T<:AbstractFloat}
-    SolidStateDetector{T}(LegendData, readprops(filename, subst_pathvar = false, subst_env = false, trim_null = false))
+function SolidStateDetectors.SolidStateDetector{T}(::Type{LegendData}, filename::String, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
+    SolidStateDetector{T}(LegendData, readprops(filename, subst_pathvar = false, subst_env = false, trim_null = false), env)
 end
 
-function SolidStateDetectors.SolidStateDetector(::Type{LegendData}, filename::String)
-    SolidStateDetector{_SSDDefaultNumtype}(LegendData, filename)
+function SolidStateDetectors.SolidStateDetector{T}(::Type{LegendData}, meta::AbstractDict, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
+    SolidStateDetector{T}(LegendData, convert(PropDict, meta), LegendDataManagement.NoSuchPropsDBEntry("",[]), env)
 end
 
-function SolidStateDetectors.SolidStateDetector(::Type{LegendData}, meta::AbstractDict)
-    SolidStateDetectors.SolidStateDetector{_SSDDefaultNumtype}(LegendData, meta)
-end
-
-function SolidStateDetectors.SolidStateDetector{T}(::Type{LegendData}, meta::AbstractDict) where {T<:AbstractFloat}
-    SolidStateDetectors.SolidStateDetector{T}(LegendData, convert(PropDict, meta), LegendDataManagement.NoSuchPropsDBEntry("",[]))
-end
-
-function SolidStateDetectors.SolidStateDetector{T}(::Type{LegendData}, meta::PropDict, xtal_meta::Union{PropDict, LegendDataManagement.NoSuchPropsDBEntry}) where {T<:AbstractFloat}
-    config_dict = create_SSD_config_dict_from_LEGEND_metadata(meta, xtal_meta)
-    return SolidStateDetector{T}(config_dict, SolidStateDetectors.construct_units(config_dict))
+function SolidStateDetectors.SolidStateDetector{T}(::Type{LegendData}, meta::PropDict, xtal_meta::Union{PropDict, LegendDataManagement.NoSuchPropsDBEntry}, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
+    config_dict = create_SSD_config_dict_from_LEGEND_metadata(meta, xtal_meta, env)
+    SolidStateDetector{T}(config_dict, SolidStateDetectors.construct_units(config_dict))
 end
 
 """
@@ -59,39 +51,30 @@ LegendDataManagement provides an extension for SolidStateDetectors, a
 `Simulation` can be constructed from LEGEND metadata using the
 methods above.
 """
-function SolidStateDetectors.Simulation(data::LegendData, detector::DetectorIdLike)
-    SolidStateDetectors.Simulation{_SSDDefaultNumtype}(data, detector)
+function SolidStateDetectors.Simulation(::Type{LegendData}, meta::Union{<:String, <:AbstractDict, <:DetectorIdLike}, env::HPGeEnvironment = HPGeEnvironment())
+    Simulation{_SSDDefaultNumtype}(LegendData, meta, env)
 end
 
-function SolidStateDetectors.Simulation{T}(data::LegendData, detector::DetectorIdLike) where {T<:AbstractFloat}
+function SolidStateDetectors.Simulation{T}(data::LegendData, detector::DetectorIdLike, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
     detector_props = getproperty(data.metadata.hardware.detectors.germanium.diodes, Symbol(detector))
     xtal_props = getproperty(data.metadata.hardware.detectors.germanium.crystals, Symbol(string(detector)[1:end-1]))
-    Simulation{T}(LegendData, detector_props, xtal_props)
+    Simulation{T}(LegendData, detector_props, xtal_props, env)
 end
 
-function SolidStateDetectors.Simulation{T}(::Type{LegendData}, filename::String) where {T<:AbstractFloat}
-    Simulation{T}(LegendData, readprops(filename, subst_pathvar = false, subst_env = false, trim_null = false))
+function SolidStateDetectors.Simulation{T}(::Type{LegendData}, filename::String, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
+    Simulation{T}(LegendData, readprops(filename, subst_pathvar = false, subst_env = false, trim_null = false), env)
 end
 
-function SolidStateDetectors.Simulation(::Type{LegendData}, filename::String)
-    Simulation{_SSDDefaultNumtype}(LegendData, filename)
+function SolidStateDetectors.Simulation{T}(::Type{LegendData}, meta::AbstractDict, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
+    Simulation{T}(LegendData, convert(PropDict, meta), LegendDataManagement.NoSuchPropsDBEntry("", []), env)
 end
 
-function SolidStateDetectors.Simulation(::Type{LegendData}, meta::AbstractDict)
-    SolidStateDetectors.Simulation{_SSDDefaultNumtype}(LegendData, meta)
+function SolidStateDetectors.Simulation{T}(::Type{LegendData}, meta::PropDict, xtal_meta::Union{PropDict, LegendDataManagement.NoSuchPropsDBEntry}, env::HPGeEnvironment = HPGeEnvironment()) where {T<:AbstractFloat}
+    config_dict = create_SSD_config_dict_from_LEGEND_metadata(meta, xtal_meta, env)
+    Simulation{T}(config_dict)
 end
 
-function SolidStateDetectors.Simulation{T}(::Type{LegendData}, meta::AbstractDict) where {T<:AbstractFloat}
-    SolidStateDetectors.Simulation{T}(LegendData, convert(PropDict, meta), LegendDataManagement.NoSuchPropsDBEntry("", []))
-end
-
-function SolidStateDetectors.Simulation{T}(::Type{LegendData}, meta::PropDict, xtal_meta::Union{PropDict, LegendDataManagement.NoSuchPropsDBEntry}) where {T<:AbstractFloat}
-    config_dict = create_SSD_config_dict_from_LEGEND_metadata(meta, xtal_meta)
-    return Simulation{T}(config_dict)
-end
-
-
-function create_SSD_config_dict_from_LEGEND_metadata(meta::PropDict, xtal_meta::X; dicttype = Dict{String,Any}) where {X <: Union{PropDict, LegendDataManagement.NoSuchPropsDBEntry}}
+function create_SSD_config_dict_from_LEGEND_metadata(meta::PropDict, xtal_meta::X, env::HPGeEnvironment = HPGeEnvironment(); dicttype = Dict{String,Any}) where {X <: Union{PropDict, LegendDataManagement.NoSuchPropsDBEntry}}
 
     # Not all possible configurations are yet implemented!
     # https://github.com/legend-exp/legend-metadata/blob/main/hardware/detectors/detector-metadata_1.pdf
@@ -139,7 +122,7 @@ function create_SSD_config_dict_from_LEGEND_metadata(meta::PropDict, xtal_meta::
                 )
             )
         ),
-        "medium" => "vacuum",
+        "medium" => env.medium,
         "detectors" => []
     )
 
@@ -151,7 +134,7 @@ function create_SSD_config_dict_from_LEGEND_metadata(meta::PropDict, xtal_meta::
             ),
             # "impurity_density" => dicttype("parameters" => Vector()),
             "geometry" => dicttype(),
-            "temperature" => 78
+            "temperature" => ustrip(u"K", env.temperature)
         ),
         "contacts" => []
         ))

src/LegendDataManagement.jl

@@ -35,10 +35,13 @@ using TypedTables
 import Markdown
 using MIMEs: mime_from_extension
 
+export HPGeEnvironment
+
 include("legend_report.jl")
 include("status_types.jl")
 include("atomic_fcreate.jl")
 include("filekey.jl")
+include("hpge_environment.jl")
 include("dataset.jl")
 include("data_config.jl")
 include("props_db.jl")

src/hpge_environment.jl

@@ -0,0 +1,25 @@
+"""
+    struct HPGeEnvironment{T}
+
+Struct to describe the environment of a HPGe detector which are not set in metadata.
+
+## Parametric types
+* `T`: Temperature type
+
+## Fields
+* `medium::AbstractString`: Name of the medium.
+* `temperature::T`: Temperature of detector/medium with units. 
+
+## Default constructor for vacuum cryostat at 78 K:
+
+* `HPGeEnvironment()`.
+"""
+
+struct HPGeEnvironment{T<:Unitful.Temperature{<:Number}}
+    medium::AbstractString
+    temperature::T
+    
+    HPGeEnvironment(m::AbstractString,t::T) where {T} = new{T}(m,t)
+end
+
+HPGeEnvironment() = HPGeEnvironment("vacuum", 78u"K")

test/test_ext_ssd.jl

@@ -35,4 +35,13 @@ include("testing_utils.jl")
             @test !isfile(lh5name)
         end
     end
+
+    @testset "Test HPGeEnvironment" begin
+        detname = :V99000A
+        env = LegendDataManagement.HPGeEnvironment("LAr", 87u"K")
+        sim = Simulation{Float64}(l200, detname, env)
+        @test sim isa Simulation
+        @test sim.medium == SolidStateDetectors.material_properties[:LAr]
+        @test sim.detector.semiconductor.temperature == 87
+    end
 end