Issue 129

docs/release_notes.rst

@@ -4,6 +4,34 @@ Release notes
 =============
 
 
+* Package dependencies updated: `joblib` and `iminuit` added.
+* New calibration matrix type `equalization` added in `caldb.py` to store the pixel equalization
+  factors.
+* New `CalibrateEqualization` class to calibrate the pixel equalization factors. This is
+  performed with a likelihood fit using the source spectrum probability density function (PDF)
+  and the observed energy of the events. Corresponding CLI command `calibgen equalization` added
+  to generate equalization calibration files from event files.
+* The `CalibrateGain` class has been refactored. Now it produces a gain calibration matrix from
+  an equalization calibration matrix, by using the ADC to eV conversion and the chip sensor
+  material. The gain matrix is expressed in ADC counts per electron. Corresponding CLI command
+  `calibgen gain` refactored to reflect this change.
+* Some CLI commands refactored to use the equalization calibration file instead of the gain
+  calibration file (`reconstruct`, `display`, `calibgen eta`).
+* New `pdf.py` module containing facilities to calculate the PDF of the source spectrum and store
+  it in a `.npz` file.
+* Added `calibspec` CLI command to create a source spectrum PDF file from a reconstructed event
+  file. The PDF is saved as a `.npz` file.
+* New `adc` method to calculate the total ADC counts of the event added to `ReconEvent`. Now a
+  reconstructed file contains both the ADC counts and the energy in eV of the events (if the 
+  conversion factor from ADC to eV is available in the equalization calibration file).
+* New `energy` method to calculate the total energy of the event added to `Cluster`. The
+  conversion factor from ADC to eV is passed by `ClusteringNN`.
+* Pull requests merged and issues closed:
+
+  - https://github.com/lucabaldini/hexsample/pull/132
+  - https://github.com/lucabaldini/hexsample/issues/129
+
+
 Version 0.16.1 (2026-05-12)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

pyproject.toml

@@ -44,6 +44,8 @@ dependencies = [
     "xraydb",
     "aptapy>=0.18.0",
     "scikit-image",
+    "iminuit",
+    "joblib",
   ]
 
 [project.optional-dependencies]

scripts/populate_caldb.py

@@ -23,11 +23,14 @@
 """
 
 import numpy as np
+from xraydb import ionization_potential
 
 from hexsample.caldb import CalDB, CalibrationType
 from hexsample.tasks import SynthesizeCalibrationDefaults, synthesize_calibration_file
 
+DEFAULT_IONIZATION_POTENTIAL = ionization_potential("Si")
 DEFAULT_GAIN = 1.
+DEFAULT_ADC_TO_EV = DEFAULT_IONIZATION_POTENTIAL / DEFAULT_GAIN
 RMS_VALS = (0, 10)
 ENC_VALS = np.array((20., 30., 40., 50., 75., 100.))
 PEDESTAL_VALS = (0, 1000)
@@ -62,6 +65,7 @@ def populate_caldb() -> None:
     generate_files(CalibrationType.ENC, ENC_VALS, RMS_VALS)
     generate_files(CalibrationType.NOISE, ENC_VALS * DEFAULT_GAIN, RMS_VALS)
     generate_files(CalibrationType.GAIN, [DEFAULT_GAIN], RMS_VALS)
+    generate_files(CalibrationType.EQUALIZATION, [DEFAULT_ADC_TO_EV], [0.]) 
     generate_files(CalibrationType.PEDESTAL, PEDESTAL_VALS, RMS_VALS)
 
 

src/hexsample/caldb.py

@@ -64,3 +64,9 @@ def open_gain(cls, designator: str) -> CalibrationMatrix:
         """Open the gain calibration file for the given designation.
         """
         return cls._open(CalibrationType.GAIN, designator)
+
+    @classmethod
+    def open_equalization(cls, designator: str) -> CalibrationMatrix:
+        """Open the equalization calibration file for the given designation.
+        """
+        return cls._open(CalibrationType.EQUALIZATION, designator)