Material¶

class roentgen.absorption.Material(material_str, thickness: Unit('m'), density=None)[source]¶

Bases: object

An object which enables the calculation of the x-ray transmission and absorption of a material (e.g. an element or a compound/mixture).

Parameters:

material_str (str) – A string representation of the material which includes an element symbol (e.g. Si), an element name (e.g. Silicon), or the name of a compound (e.g. cdte, mylar). For all supported elements see elements.csv and for compounds see compounds_mixtures.csv.
thickness (astropy.units.Quantity) – The thickness of the material
density (astropy.units.Quantity) – The density of the material. If not provided uses default values which can be found in elements.csv for elements or in compounds_mixtures.csv for compounds.

symbol¶

The material symbol

Type:: str

name¶

The material name

Type:: str

mass_attenuation_coefficient¶

The mass attenuation coefficient for the material.

Type:: MassAttenuationCoefficient

Examples

>>> from roentgen.absorption.material import Material
>>> import astropy.units as u
>>> detector = Material('cdte', 500 * u.um)
>>> thermal_blankets = Material('mylar', 0.5 * u.mm)

Methods Summary

`absorption`(energy)	Provides the absorption fraction (0 to 1).
`transmission`(energy)	Provide the transmission fraction (0 to 1).

Methods Documentation

absorption(energy)[source]¶

Provides the absorption fraction (0 to 1).

Parameters:: energy (astropy.units.Quantity) – An array of energies in keV.

transmission(energy)[source]¶

Provide the transmission fraction (0 to 1).

Parameters:: energy (astropy.units.Quantity) – An array of energies in keV