pygammaspec.nuclear module

pygammaspec.nuclear.decay_products(father, branching_ratio_threshold=None)

Returns a list of nuclides generated by the radioactive decay chain of the user-specified father nuclide.

Parameters:

  • father (str) – The string indicating the name of the isotope using the format element-antomic number (e.g. Ra-226)

  • branching_ratio_threshold (Optional[float]) – If set to a value different from None, will limit the decay products based on the branching ratio.

Returns:

The list of nuclides produced by the decay chain

Return type:

List[str]

pygammaspec.nuclear.decay_products_spectrum(father, branching_ratio_threshold=None, limit_intensity=False, intensity_threshold=None)

Given a father nuclide computes all the decay products and search the associated gamma lines.

Parameters:

  • father (str) – The father isotope from which the decay chain starts.

  • branching_ratio_threshold (Optional[float]) – If set to a value different from None, will limit the decay products based on the branching ratio.

  • limit_intensity (bool) – If set to true will return only the highest intensity transitions. The function will discard all the transition with relative intensity lower than 10% of the highest one.

  • intensity_threshold (Optional[float]) – If set to a value different from None will discard all the energy lines of relative intensity lower than the threshold. If limit_intensity is set to True this keyword will be ignored.

Returns:

  • List[str] – The list of nuclides acting as gamma emitters.

  • List[float] – The energy of each gamma line in keV.

Return type:

Tuple[List[str], List[float]]

pygammaspec.nuclear.element_x_ray_lines(element)

Returns the X-ray lines associated to a given element.

Parameters:

element (str) – The element symbol.

Returns:

  • List[float] – The list of X-ray energies (in keV) associated to the element

  • List[str] – The type of shell transition associated to the characteristic X-ray emission

Return type:

Tuple[List[float], List[str]]

pygammaspec.nuclear.nuclide_gamma_lines(nuclide, limit_intensity=False, intensity_threshold=None)

Returns the gamma lines associated to a given nuclide.

Parameters:

  • nuclide (str) – The nuclide name

  • limit_intensity (bool) – If set to true will return only the highest intensity transitions. The function will discard all the transition with relative intensity lower than 10% of the highest one.

  • intensity_threshold (Optional[float]) – If set to a value different from None will discard all the energy lines of relative intensity lower than the threshold. If limit_intensity is set to True this keyword will be ignored.

Returns:

  • List[float] – The list of gamma energies (in keV) associated to the gamma linea

  • List[float] – The list of relative intensities (in %)

Return type:

Tuple[List[float]]

pygammaspec.nuclear.search_gamma_line(energy, delta=2.0, halflife_threshold=None, intensity_threshold=None)

Search gamma transitions located near the specified gamma energy.

Parameters:

  • energy (float) – The energy (in keV) of the transition of interest.

  • delta (float) – The energy range (in keV) within which the gamma line should be searched.

  • halflife_threshold (Optional[float]) – If set to a value different from None will include only gamma emitters with halflife greater than the set threshold (in seconds).

  • intensity_threshold (Optional[float]) – If set to a value different from None will include only gamma transitions with relative intensities greater than the set threshold (as % values).

Returns:

A list of lists containing in order the energy, relative intensity, decay mode, isotope and notes about the gamma line responding to the search parameters

Return type:

List[List[Union[float, float, str, float, str, str]]]

pygammaspec.nuclear.search_x_ray_line(energy, delta=2.0)

Search X-ray transitions located near the specified energy.

Parameters:

  • energy (float) – The energy (in keV) of the transition of interest.

  • delta (float) – The energy range (in keV) within which the X-ray line should be searched.

Returns:

A list of lists containing in order the energy, element and shell of the X-ray responding to the search parameters

Return type:

List[List[Union[float, str, str]]]