v0.8.1

Mostly bug fix release

What's Changed

• cope with xtensor include files move by @KrisThielemans in #174
• Python: use calibration factor in get_detection_efficiency by @KrisThielemans in #177
• new naming convention by @casperdcl in #178

Full Changelog: v0.8.0...v0.8.1

v0.8.0

What's Changed ordered by importance/topic (not chronological)

Model (and software) changes

Breaking backwards compatibility

• Update moduleCoincidenceAliveTimeFraction by @KrisThielemans in #155
• Add singles and quadruples and improve naming for other event types by @KrisThielemans in #160

Extra features or updates

• add calibration factor to DetectionEfficiencies by @KrisThielemans in #165

Helper/software changes

Breaking backwards compatibility

• move location of C++ generated files to generated/petsird and better CMake by @KrisThielemans in #161

Extra features or updates

• add extras to analysis helper by @KrisThielemans in #136
• convert energies to float64 before summing them in analysis script by @gschramm in #142
• Use python-m pip in justfile by @KrisThielemans in #144
• fix get_detection_efficiency python helper by @KrisThielemans in #146
• use different variable name in draw_BowShape for PolyCollection by @gschramm in #147
• Renaming the computation of number of module type such that it make sense by @MaxTousss in #150
• Added a method to get detector effeciencies without creating an event by @MaxTousss in #149
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #139
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #158
• generator/analysis helpers adaptations for multiple module types by @KrisThielemans in #168
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #164

PRs ordered chronologically

• add extras to analysis helper by @KrisThielemans in #136
• convert energies to float64 before summing them in analysis script by @gschramm in #142
• Use python-m pip in justfile by @KrisThielemans in #144
• fix get_detection_efficiency python helper by @KrisThielemans in #146
• use different variable name in draw_BowShape for PolyCollection by @gschramm in #147
• Renaming the computation of number of module type such that it make sense by @MaxTousss in #150
• Added a method to get detector effeciencies without creating an event by @MaxTousss in #149
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #139
• Update moduleCoincidenceAliveTimeFraction by @KrisThielemans in #155
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #158
• Add singles and quadruples and improve naming for other event types by @KrisThielemans in #160
• move location of C++ generated files to generated/petsird and better CMake by @KrisThielemans in #161
• generator/analysis helpers adaptations for multiple module types by @KrisThielemans in #168
• add calibration factor to DetectionEfficiencies by @KrisThielemans in #165
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #164

New Contributors

• @gschramm made their first contribution in #142
• @MaxTousss made their first contribution in #150

Full Changelog: v0.7.2...v0.8.0

v0.7.2

What's Changed

• C++ helper fixes by @KrisThielemans in #135
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #134

Full Changelog: v0.7.1...v0.7.2

v0.7.1

What's Changed

• Minor documentation improvements for detector and efficiencies (and set version to 0.7.1) by @KrisThielemans in #133

Full Changelog: v0.7.0...v0.7.1

v0.7.0

This release only changes the helpers. The main changes are introduction of helpers for the geometry calculation (e.g. get_detecting_box) as well as C++ helper initialize_scanner_information_dimensions to avoid having to write complicated code to allocate the data structure for the different types of modules.

Note that C++ code now depends on xtensor-blas (to do the geometric matrix calculations). We therefore recommend creating a new conda environment.

Pull requests

• transform functions in helpers by @KrisThielemans in #130
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #131
• set version to 0.7.0 by @KrisThielemans in #132

Full Changelog: v0.6.0...v0.7.0

v0.6.0

This release breaks backwards compatibility. It is a major change that combines indices over space and energy into one.

What's Changed

• merge detElIdx and EnergyIdx by @KrisThielemans in #124
• update to v0.6.0 by @KrisThielemans in #129

Full Changelog: v0.5.0...v0.6.0

v0.5.0

This release breaks backwards compatibility. It contains 2 major changes:

• modules now have to consist of "elementary detector elements" that all have the same properties, removing one level in the hierarchy
• cope with different number of "elementary detector elements", energy windows and/or properties such as CTR for different types of modules, by making all data structures "nested lists" per module-type.

More detail on what's Changed

• [GHA] add tmate action for debugging by @KrisThielemans in #115
• Limit xtensor < 0.26 by @KrisThielemans in #117
• remove one level in the DetectorModule by @KrisThielemans in #114
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #113
• make all information list for different module types by @KrisThielemans in #102
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #120
• set version to 0.5.0 by @KrisThielemans in #123

Full Changelog: v0.4.0...v0.5.0

v0.4.0

This release breaks backwards compatibility. It is mostly a stepping stone to reduce dependencies on how detector elements/energy windows are numbered.

What's Changed

• introduce DetectionBin type and use it by @KrisThielemans in #105
• remove unique identifiers by @KrisThielemans in #109
• update version number to 0.4.0 by @KrisThielemans in #111
• python sdist licen[cs]e by @casperdcl in #112
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #80

Full Changelog: v0.3.0...v0.4.0

v0.3.0

This release breaks backwards compatibility, see below.

Summary

• yardl 0.6.3 is now required, such that a MATLAB interface can now be built
• Model description of PETSIRD:
  • added DeadTimeTimeBlock and SinglesHistogramTimeBlock
  • all time blocks now have a timeInterval field, as opposed to start, allowing time blocks of different durations that overlap, which is useful for dead-time, signals and external singles
  • added externalSignals field to ExamInformation fixing a problem with external signals
  • added mrPulseStart as type of external signal
  • ScannerInformation:
    • more complete CoincidencePolicy
    • split energyBinEdges into eventEnergyBinEdges and singlesHistogramEnergyBinEdges
    • added bools delayedCoincidencesAreStored and tripleEventsAreStored
• Example software:
  • Python (and MATLAB) now have plot_scanner/generator/analysis modules installed in the helpers, making them accessible as

    pip install petsird
    python -m petsird.helpers.generator
    

• Introduce just for easier generation/building/testing

More details

• some reformattting for flake8 etc by @KrisThielemans in #66
• add CI and pre-commit badges to the README by @KrisThielemans in #65
• fix description by @casperdcl in #67
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #68
• Bug fix in petsird_helpers.h by @sstute1 in #73
• extra features for petsird_analysis by @KrisThielemans in #74
• introduce DetectorId type by @KrisThielemans in #76
• Add dead-time time-block by @KrisThielemans in #77
• add SinglesHistogramTimeBlock by @KrisThielemans in #81
• work-around current twine problem by @KrisThielemans in #91
• move python helpers by @casperdcl in #71
• Implement MATLAB generator and analysis tools by @naegelejd in #79
• remove ScannerInformation.eventTimeBlockDuration by @KrisThielemans in #93
• git ignore yardl-generated files for matlab by @KrisThielemans in #94
• fix external signals by @KrisThielemans in #96
• fix justfile, and use it in CI by @KrisThielemans in #104
• Introduce an SGID type-alias for better documentation by @KrisThielemans in #103
• Add comment in EventTimeBlock on event timing by @KrisThielemans in #95
• Expand coincidence policy and add flags by @KrisThielemans in #99
• Resolve some TODOs in model comments by @KrisThielemans in #97
• small updates to set version to v0.3.0 by @KrisThielemans in #106

New Contributors

• @sstute1 made their first contribution in #73

Full Changelog: v0.2.1...v0.3.0

v0.2.1

Minor bug fix release

What's Changed

• Add justfile to streamline build/test loop by @naegelejd in #57
• Minor fixes to C++ and Python tools by @naegelejd in #58
• include LICENSE in deployment by @KrisThielemans in #59
• Helper/generator fixes by @KrisThielemans in #56
• CI: fix pip version by @casperdcl in #64
• add pre-commit config by @KrisThielemans in #63

New Contributors

• @naegelejd made their first contribution in #57

Full Changelog: v0.2.0...v0.2.1