roentgen.nuclides.nuclides#

A module to provide access to x-ray and gamma-ray radiation from radionuclides

Functions

get_nuclide_mass_numbers(element)

Return all available nuclide mass numbers for a given element.

get_lara_file(element, mass_number[, metastable])

Return path to the specified lara data file.

read_lara_tables(file_path)

Return a table of all emissions from all origins.

read_lara_header(file_path)

Return a table of all emissions from all origins.

Classes

Nuclide(element, mass_number[, metastable])

An object to support radionuclides that emit x-ray radiation.
class roentgen.nuclides.nuclides.Nuclide(element: str, mass_number: int, metastable: bool = False)[source]#

An object to support radionuclides that emit x-ray radiation.

Parameters:

  • material_str (str) – A string representation of the material which includes an element symbol (e.g. Si), an element name (e.g. Silicon). For all supported radionuclides see lara.

  • mass_number (int) – The mass number of the radionuclide (e.g. 55 for Fe-55)

symbols#

A list of material symbol

Type:

list

material_names#

A list of material names

Type:

list

name#

A name for the material

Type:

str

get_lines(energy_range)[source]#

X-ray lines in the energy range.

Examples

>>> from roentgen.nuclides import Nuclide
>>> import astropy.units as u
>>> fe55 = Nuclide('fe', 55)
>>> fe55.get_lines(1 * u.keV, 10 * u.keV)
<QTable length=3>
energy intensity origin parent
 keV
float64  float64   str7   str7
------- --------- ------ ------
5.88772       8.4    Mn   Fe-55
5.89881     16.48    Mn   Fe-55
6.513        3.38    Mn   Fe-55
_text_summary()[source]#
get_lines(energy_low: Annotated[Quantity, Unit('keV')], energy_high: Annotated[Quantity, Unit('keV')], min_intensity: float = 0.0) → QTable[source]#

Returns a list of all emission lines in the energy range.

roentgen.nuclides.nuclides.get_lara_file(element: str, mass_number: int, metastable: bool = False) → Path[source]#

Return path to the specified lara data file.

Parameters:

  • element (str) – The element or symbol name for the nuclide

  • mass_number (int) – The mass number of the nuclide

  • metastable (bool) – Whether the nuclide is metastable

Returns:

file_path

Return type:

Path

roentgen.nuclides.nuclides.get_nuclide_mass_numbers(element: str) → list[source]#

Return all available nuclide mass numbers for a given element.

roentgen.nuclides.nuclides.read_lara_header(file_path: str | Path) → dict[source]#

Return a table of all emissions from all origins.

Returns:

result

Return type:

list

roentgen.nuclides.nuclides.read_lara_tables(file_path: str | Path) → list[source]#

Return a table of all emissions from all origins.

Returns:

result

Return type:

list