legend-pygeom-hades 0.1.0a0__py3-none-any.whl

pygeomhades/models/dummy/source_th_dummy.gdml

@@ -0,0 +1,134 @@
+<?xml version="1.0" ?>
+<gdml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://service-spi.web.cern.ch/service-spi/app/releases/GDML/schema/gdml.xsd">
+
+	<define>
+		<constant name="TWOPI" value="2.*pi"/>
+		<quantity name="source_z" type="length" value="source_height" unit="mm"/>
+		<quantity name="source_radius" type="length" value="source_width/2" unit="mm"/>
+		<quantity name="source_capsule_z" type="length" value="source_capsule_height" unit="mm"/>
+		<quantity name="source_capsule_radius" type="length" value="source_capsule_width/2" unit="mm"/>
+		<quantity name="source_epoxy_z" type="length" value="source_epoxy_height" unit="mm"/>
+		<quantity name="source_epoxy_radius" type="length" value="source_epoxy_width/2" unit="mm"/>
+		<quantity name="CuSource_holder_z" type="length" value="CuSource_holder_height" unit="mm"/>
+		<quantity name="CuSource_holder_radius" type="length" value="CuSource_holder_width/2" unit="mm"/>
+		<quantity name="CuSource_holder_cavity_radius" type="length" value="CuSource_holder_cavity_width/2" unit="mm"/>
+		<quantity name="CuSource_holder_bottom_z" type="length" value="CuSource_holder_bottom_height" unit="mm"/>
+		<quantity name="CuSource_holder_bottom_radius" type="length" value="CuSource_holder_bottom_width/2" unit="mm"/>
+		<quantity name="CuSource_holder_all_z" type="length" value="CuSource_holder_height+CuSource_holder_bottom_height" unit="mm"/>
+		<quantity name="source_offset_z" type="length" value="source_offset_height" unit="mm" />
+		<position name="pos_source_capsule" z="0"/>
+		<position name="pos_source_epoxy" z="(source_capsule_z-source_epoxy_z)/2"/>
+		<position name="pos_source_encapsulated" z="CuSource_holder_all_z-source_capsule_z/2-source_offset_z"/>
+		<position name="pos_CuSource_holder_cavity" z="0"/>
+	</define>
+
+	<materials>
+		<element Z="1" formula="H" name="Hydrogen" >
+			<atom value="1" />
+		</element>
+		<element Z="6" formula="C" name="Carbon" >
+			<atom value="12.01" />
+		</element>
+		<element Z="7" formula="N" name="Nitrogen" >
+			<atom value="14.01" />
+		</element>
+		<element Z="8" formula="O" name="Oxygen" >
+			<atom value="16" />
+		</element>
+		<element Z="14" formula="Si" name="Silicon" >
+			<atom value="28.09" />
+		</element>
+		<element Z="24" formula="Cr" name="Chromium" >
+			<atom value="51.9961" />
+		</element>
+		<element Z="25" formula="Mn" name="Manganese" >
+			<atom value="54.93805" />
+		</element>
+		<element Z="26" formula="Fe" name="Iron" >
+			<atom value="55.845" />
+		</element>
+		<element Z="28" formula="Ni" name="Nickel" >
+			<atom value="58.9332" />
+		</element>
+		<material name="epoxy_mod" >
+			<D value="1.129" unit="g/cm3"/>
+			<composite n="41" ref="Carbon" />
+			<composite n="49" ref="Hydrogen" />
+			<composite n="7" ref="Oxygen" />
+			<composite n="3" ref="Nitrogen" />
+		</material>
+		<material name="Ssteel" >
+			<D value="7.9" unit="g/cm3" />
+			<fraction n="0.01" ref="Silicon" />
+			<fraction n="0.2" ref="Chromium" />
+			<fraction n="0.02" ref="Manganese" />
+			<fraction n="0.67" ref="Iron" />
+			<fraction n="0.10" ref="Nickel" />
+		</material>
+		<material name="SiliconDioxide" >
+			<D value="2.32" unit="g/cm3" />
+			<composite n="1" ref="Silicon" />
+			<composite n="2" ref="Oxygen" />
+		</material>
+	</materials>
+
+	<solids>
+		<tube name="source" rmax="source_radius" z="source_z" startphi="0" deltaphi="TWOPI" aunit="rad" />
+		<tube name="source_capsule" rmax="source_capsule_radius" z="source_capsule_z" startphi="0" deltaphi="TWOPI" aunit="rad" />
+		<tube name="source_epoxy" rmax="source_epoxy_radius" z="source_epoxy_z" startphi="0" deltaphi="TWOPI" aunit="rad" />
+		<polycone name="CuSource_holder_cavity" startphi="0" deltaphi="TWOPI" aunit="rad">
+			<zplane rmin="0" rmax="CuSource_holder_cavity_radius" z="0" />
+			<zplane rmin="0" rmax="CuSource_holder_cavity_radius" z="CuSource_holder_all_z" />
+		</polycone>
+		<polycone name="CuSource_holder" startphi="0" deltaphi="TWOPI" aunit="rad">
+			<zplane rmin="0" rmax="CuSource_holder_radius" z="0" />
+			<zplane rmin="0" rmax="CuSource_holder_radius" z="CuSource_holder_z" />
+			<zplane rmin="0" rmax="CuSource_holder_bottom_radius" z="CuSource_holder_z" />
+			<zplane rmin="0" rmax="CuSource_holder_bottom_radius" z="CuSource_holder_all_z" />
+		</polycone>
+	</solids>
+
+	<structure>
+		<volume name="Source">
+			<materialref ref="SiliconDioxide"/>
+			<solidref ref="source"/>
+		</volume>
+		<volume name="Source_Epoxy">
+			<materialref ref="epoxy_mod"/>
+			<solidref ref="source_epoxy"/>
+		</volume>
+		<volume name="Source_Encapsulated">
+			<materialref ref="Ssteel"/>
+			<solidref ref="source_capsule"/>
+			<physvol>
+				<volumeref ref="Source"/>
+				<positionref ref="pos_source_capsule"/>
+			</physvol>
+			<physvol>
+				<volumeref ref="Source_Epoxy"/>
+				<positionref ref="pos_source_epoxy"/>
+			</physvol>
+		</volume>
+		<volume name="CuSource_Holder_Cavity">
+			<materialref ref="G4_AIR"/>
+			<solidref ref="CuSource_holder_cavity"/>
+			<physvol>
+				<volumeref ref="Source_Encapsulated"/>
+				<positionref ref="pos_source_encapsulated"/>
+			</physvol>
+		</volume>
+		<volume name="CuSource_Holder">
+			<materialref ref="G4_Cu"/>
+			<solidref ref="CuSource_holder"/>
+			<physvol>
+				<volumeref ref="CuSource_Holder_Cavity"/>
+				<positionref ref="pos_CuSource_holder_cavity"/>
+			</physvol>
+		</volume>
+	</structure>
+
+	<setup name="Default" version="1.0">
+		<world ref="CuSource_Holder"/>
+	</setup>
+
+</gdml>

pygeomhades/models/dummy/source_th_plates_dummy.gdml

@@ -0,0 +1,36 @@
+<?xml version="1.0" ?>
+<gdml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://service-spi.web.cern.ch/service-spi/app/releases/GDML/schema/gdml.xsd">
+
+	<define>
+		<constant name="TWOPI" value="2.*pi"/>
+		<quantity name="source_plates_z" type="length" value="source_plates_height" unit="mm"/>
+		<quantity name="source_plates_radius" type="length" value="source_plates_width/2" unit="mm"/>
+		<quantity name="source_plates_cavity_radius" type="length" value="source_plates_cavity_width/2" unit="mm"/>
+	</define>
+
+	<materials>
+		<element Z="82" formula="Pb" name="Lead" >
+			<atom value="207.2" />
+		</element>
+		<material name="Pb" formula="Pb" >
+			<D value="2.84" unit="g/cm3" />
+			<fraction n="1" ref="Lead"/>
+		</material>
+	</materials>
+
+	<solids>
+		<tube name="source_plates" rmin="source_plates_cavity_radius" rmax="source_plates_radius" z="source_plates_z" startphi="0" deltaphi="TWOPI" aunit="rad" />
+	</solids>
+
+	<structure>
+		<volume name="Source_Plates">
+			<materialref ref="G4_Pb"/>
+			<solidref ref="source_plates"/>
+		</volume>
+	</structure>
+
+ 	<setup name="Default" version="1.0">
+ 	    <world ref="Source_Plates"/>
+ 	</setup>
+
+</gdml>

pygeomhades/models/dummy/wrap_dummy.gdml

@@ -0,0 +1,50 @@
+<?xml version="1.0" ?>
+<gdml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://service-spi.web.cern.ch/service-spi/app/releases/GDML/schema/gdml.xsd">
+
+
+    <define>
+        <constant name="TWOPI" value="2.*pi"/>
+
+        <quantity name="wrap_z" type="length" value="wrap_outer_height_in_mm" unit="mm"/>
+        <quantity name="wrap_radius" type="length" value="wrap_outer_radius_in_mm" unit="mm"/>
+
+        <quantity name="wrap_cavity_radius" type="length" value="wrap_inner_radius_in_mm" unit="mm"/>
+        <quantity name="wrap_top_thickness" type="length" value="wrap_top_thickness_in_mm" unit="mm" />
+    </define>
+
+
+	<materials>
+		<element Z="1" formula="H" name="Hydrogen" >
+			<atom value="1" />
+		</element>
+		<element Z="6" formula="C" name="Carbon" >
+				<atom value="12.01" />
+		</element>
+		<material name="HD1000" >
+			<D value="0.93" unit="g/cm3" />
+			<composite n="4" ref="Hydrogen" />
+			<composite n="2" ref="Carbon" />
+		</material>
+	</materials>
+
+	<solids>
+		<polycone name="wrap" startphi="0" deltaphi="TWOPI" aunit="rad">
+			<zplane rmin="0" rmax="wrap_radius" z="0" />
+				<zplane rmin="0" rmax="wrap_radius" z="wrap_top_thickness" />
+				<zplane rmin="wrap_cavity_radius" rmax="wrap_radius" z="wrap_top_thickness" />
+				<zplane rmin="wrap_cavity_radius" rmax="wrap_radius" z="wrap_z" />
+			</polycone>
+	</solids>
+
+	<structure>
+		<volume name="Wrap">
+			<materialref ref="HD1000"/>
+			<solidref ref="wrap"/>
+		</volume>
+	</structure>
+
+	<setup name="Default" version="1.0">
+		<world ref="Wrap"/>
+	</setup>
+
+</gdml>

pygeomhades/utils.py

@@ -0,0 +1,101 @@
+from __future__ import annotations
+
+import logging
+import tempfile
+from collections.abc import Mapping
+from pathlib import Path
+
+from dbetto import AttrsDict
+from pyg4ometry import gdml, geant4
+
+log = logging.getLogger(__name__)
+
+
+def parse_measurement(measurement: str) -> AttrsDict:
+    """Parse a measurement string into its components.
+
+    The measurement string is expected to be in the format
+    `{source}_{HSX}_{position}_{ID}` eg. "am_HS1_top_dlt".
+
+    For more details see [link](https://legend-exp.atlassian.net/wiki/spaces/LEGEND/pages/1826750480/Analysis+of+characterization+data+WIP).
+
+
+    .. warning::
+
+        In the case of the "source" being "am", for compatibility
+        with the rest of the codebase if the source is colimated (HS1) the source name is
+        "am_collimated".
+
+    Parameters
+    ----------
+    measurement
+        The measurement string, e.g., "am_HS1_top_dlt".
+
+    """
+
+    split = measurement.split("_")
+
+    if len(split) != 4:
+        msg = f"Measurement string '{measurement}' is not in the expected format '{{source}}_{{HSX}}_{{position}}_{{ID}}'."
+        raise ValueError(msg)
+
+    out = AttrsDict({"source": split[0], "holder": split[1], "position": split[2], "id": split[3]})
+
+    if out.source == "am" and out.holder == "HS1":
+        out.source = "am_collimated"
+
+    return out
+
+
+def merge_configs(diode_meta: AttrsDict, extra_meta: Mapping, *, extra_name: str = "hades") -> AttrsDict:
+    """Merge the configs from `diode_meta` to the extra information
+    provided in `extra_meta`.
+
+    This also adds the needed `enrichment` value if this is not present.
+
+    Parameters
+    ----------
+    diode_meta
+        The standard metadata for the diode.
+    extra_meta
+        Extra metadata to add.
+    extra_name
+        name of the subdictionary to add the extra metadata to.
+    """
+    # make sure there is an enrichment value
+    if diode_meta["production"]["enrichment"]["val"] is None:
+        diode_meta["production"]["enrichment"]["val"] = 0.9  # reasonable value
+
+    diode_meta[extra_name] = extra_meta
+
+    return diode_meta
+
+
+def read_gdml_with_replacements(
+    dummy_gdml_path: Path, replacements: Mapping, vol_name: str | None = None
+) -> geant4.LogicalVolume | dict[str, geant4.LogicalVolume]:
+    """Read a GDML file including replacements.
+
+    Parameters
+    ----------
+    dummy_gdml_path
+        path to the GDML template.
+    replacements
+        Constants in the GDML file to replace.
+    """
+
+    gdml_text = dummy_gdml_path.read_text()
+
+    for key, val in replacements.items():
+        gdml_text = gdml_text.replace(key, f"{val:.1f}")
+
+    with tempfile.NamedTemporaryFile("w+", suffix=".gdml") as f:
+        f.write(gdml_text)
+        f.flush()
+        reader = gdml.Reader(f.name)
+
+        reg_tmp = reader.getRegistry()
+
+    if len(reg_tmp.logicalVolumeList) == 1:
+        return next(iter(reg_tmp.logicalVolumeDict.values()))
+    return reg_tmp.logicalVolumeDict[vol_name]