dddm.detectors package

Submodules

dddm.detectors.examples module

class dddm.detectors.examples.ArgonSimple(n_energy_bins=10, e_min_kev=0, e_max_kev=100)

Bases: Experiment

background_function(energies_in_kev)

Assume background free detector

cut_efficiency: Union[int, float] = 0.8

detection_efficiency: Union[int, float] = 0.8

detector_name: str = 'Ar_simple'

energy_threshold_kev: Union[int, float] = 30

exposure_tonne_year: Union[int, float] = 10

interaction_type: str = 'SI'

location: str = 'XENON'

resolution(energies_in_kev)

Simple square root dependency of the energy resolution

target_material: str = 'Ar'

class dddm.detectors.examples.GermaniumSimple(n_energy_bins=10, e_min_kev=0, e_max_kev=100)

Bases: Experiment

background_function(energies_in_kev)

Assume background free detector

cut_efficiency: Union[int, float] = 0.8

detection_efficiency: Union[int, float] = 0.9

detector_name: str = 'Ge_simple'

energy_threshold_kev: Union[int, float] = 10

exposure_tonne_year: Union[int, float] = 3

interaction_type: str = 'SI'

location: str = 'SUF'

resolution(energies_in_kev)

Simple resolution model

target_material: str = 'Ge'

class dddm.detectors.examples.XenonSimple(n_energy_bins=10, e_min_kev=0, e_max_kev=100)

Bases: Experiment

background_function(energies_in_kev)

Assume background free detector

cut_efficiency: Union[int, float] = 0.8

detection_efficiency: Union[int, float] = 0.5

detector_name: str = 'Xe_simple'

energy_threshold_kev: Union[int, float] = 10

exposure_tonne_year: Union[int, float] = 5

interaction_type: str = 'SI'

location: str = 'XENON'

resolution(energies_in_kev)

Simple square root dependency of the energy resolution

target_material: str = 'Xe'

dddm.detectors.experiment module

class dddm.detectors.experiment.Experiment(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: object

Base class of experiments. To use, subclass and set the required attributes

background_function(energies_in_kev: ndarray) → ndarray

Return background at <energies [keV>

property config

cut_efficiency: Union[int, float] = None

detection_efficiency: Union[int, float] = None

property detector_hash

detector_name: str = None

e_max_kev: Union[int, float] = None

e_min_kev: Union[int, float] = None

property effective_exposure

energy_threshold_kev: Union[int, float] = None

exposure_tonne_year: Union[int, float] = None

interaction_type: str = 'SI'

location: str = None

n_energy_bins: int = 50

resolution(energies_in_kev: ndarray) → ndarray

Return resolution at <energies [keV]>

target_material: str = None

dddm.detectors.super_cdms module

class dddm.detectors.super_cdms.SuperCdmsHvGeMigdal(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.85

detection_efficiency: Union[int, float] = 0.5

detector_name: str = 'SuperCDMS_HV_Ge_Migdal'

property energy_threshold_kev

exposure_tonne_year: Union[int, float] = 0.044

interaction_type: str = 'migdal_SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Ge'

class dddm.detectors.super_cdms.SuperCdmsHvGeNr(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.85

detection_efficiency: Union[int, float] = 0.85

detector_name: str = 'SuperCDMS_HV_Ge_NR'

energy_threshold_kev: Union[int, float] = 0.04

exposure_tonne_year: Union[int, float] = 0.044

interaction_type: str = 'SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Ge'

class dddm.detectors.super_cdms.SuperCdmsHvSiMigdal(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.85

detection_efficiency: Union[int, float] = 0.675

detector_name: str = 'SuperCDMS_HV_Si_Migdal'

property energy_threshold_kev

exposure_tonne_year: Union[int, float] = 0.0096

interaction_type: str = 'migdal_SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Si'

class dddm.detectors.super_cdms.SuperCdmsHvSiNr(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.85

detection_efficiency: Union[int, float] = 0.85

detector_name: str = 'SuperCDMS_HV_Si_NR'

energy_threshold_kev: Union[int, float] = 0.078

exposure_tonne_year: Union[int, float] = 0.0096

interaction_type: str = 'SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Si'

class dddm.detectors.super_cdms.SuperCdmsIzipGeMigdal(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.75

detection_efficiency: Union[int, float] = 0.5

detector_name: str = 'SuperCDMS_iZIP_Ge_Migdal'

property energy_threshold_kev

exposure_tonne_year: Union[int, float] = 0.056

interaction_type: str = 'migdal_SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Ge'

class dddm.detectors.super_cdms.SuperCdmsIzipGeNr(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.75

detection_efficiency: Union[int, float] = 0.85

detector_name: str = 'SuperCDMS_iZIP_Ge_NR'

energy_threshold_kev: Union[int, float] = 0.272

exposure_tonne_year: Union[int, float] = 0.056

interaction_type: str = 'SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Ge'

class dddm.detectors.super_cdms.SuperCdmsIzipSiMigdal(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.75

detection_efficiency: Union[int, float] = 0.675

detector_name: str = 'SuperCDMS_iZIP_Si_Migdal'

property energy_threshold_kev

exposure_tonne_year: Union[int, float] = 0.0048

interaction_type: str = 'migdal_SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Si'

class dddm.detectors.super_cdms.SuperCdmsIzipSiNr(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseSuperCdms

background_function(energies_in_kev)

Flat bg rate

cut_efficiency: Union[int, float] = 0.75

detection_efficiency: Union[int, float] = 0.85

detector_name: str = 'SuperCDMS_iZIP_Si_NR'

energy_threshold_kev: Union[int, float] = 0.166

exposure_tonne_year: Union[int, float] = 0.0048

interaction_type: str = 'SI'

resolution(energies_in_kev)

Flat resolution

target_material: str = 'Si'

dddm.detectors.xenon_nt module

class dddm.detectors.xenon_nt.XenonNtMigdal(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseXenonNt

background_function(energies_in_kev)

Returns:

ER background for Xe detector in events/keV/t/yr

cut_efficiency: Union[int, float] = 0.82

detection_efficiency: Union[int, float] = 1

detector_name: str = 'XENONnT_Migdal'

energy_threshold_kev: Union[int, float] = 1

interaction_type: str = 'migdal_SI'

resolution(energies_in_kev)

Assume the same as the 1T resolution

class dddm.detectors.xenon_nt.XenonNtNr(n_energy_bins=50, e_min_kev=0, e_max_kev=5)

Bases: _BaseXenonNt

background_function(energies_in_kev)

Returns:

NR background for Xe detector in events/keV/t/yr

cut_efficiency: Union[int, float] = 0.83

detection_efficiency: Union[int, float] = 1

detector_name: str = 'XENONnT_NR'

energy_threshold_kev: Union[int, float] = 1.6

interaction_type: str = 'SI'

resolution(energies_in_kev)

Use _get_nr_resolution to calculate the energy resolution.

Parameters:

energies_in_kev – NR energies to evaluate the resolution function at

Returns:

Module contents