X-ray Cross Sections

xrayphysics.xrayPhysics.atomicMass(self, Z)

Returns the atomic mass of the given atomic number

xrayphysics.xrayPhysics.mu(self, Z, gamma, massDensity=None)

Returns the Linear Attenuation Coefficient (LAC) of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the LAC

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The LAC (cm^-1) of the material at the specified energy or energies

xrayphysics.xrayPhysics.muPE(self, Z, gamma, massDensity=None)

Returns the Photoelectric component of the Linear Attenuation Coefficient (LAC) of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the LAC

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The Photoelectric component of the LAC (cm^-1) of the material at the specified energy or energies

xrayphysics.xrayPhysics.muCS(self, Z, gamma, massDensity=None)

Returns the Compton Scatter component of the Linear Attenuation Coefficient (LAC) of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the LAC

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The Compton Scatter component of the LAC (cm^-1) of the material at the specified energy or energies

xrayphysics.xrayPhysics.muRS(self, Z, gamma, massDensity=None)

Returns the Rayleigh Scatter component of the Linear Attenuation Coefficient (LAC) of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the LAC

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The Rayleigh Scatter component of the LAC (cm^-1) of the material at the specified energy or energies

xrayphysics.xrayPhysics.muPP(self, Z, gamma, massDensity=None)

Returns the Pair Production component of the Linear Attenuation Coefficient (LAC) of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the LAC

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The Pair Production component of the LAC (cm^-1) of the material at the specified energy or energies

xrayphysics.xrayPhysics.muTP(self, Z, gamma, massDensity=None)

Returns the Triplet Production component of the Linear Attenuation Coefficient (LAC) of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the LAC

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The Triplet Production component of the LAC (cm^-1) of the material at the specified energy or energies

xrayphysics.xrayPhysics.sigma(self, Z, gamma)

Returns the mass cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The mass cross section (cm^2/g) of the material at the specified energy or energies

xrayphysics.xrayPhysics.sigmaPE(self, Z, gamma)

Returns the Photoelectric component of the mass cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The Photoelectric component of the mass cross section (cm^2/g) of the material at the specified energy or energies

xrayphysics.xrayPhysics.sigmaCS(self, Z, gamma)

Returns the Compton Scatter component of the mass cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The Compton Scatter component of the mass cross section (cm^2/g) of the material at the specified energy or energies

xrayphysics.xrayPhysics.sigmaRS(self, Z, gamma)

Returns the Rayleigh Scatter component of the mass cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The Rayleigh Scatter component of the mass cross section (cm^2/g) of the material at the specified energy or energies

xrayphysics.xrayPhysics.sigmaPP(self, Z, gamma)

Returns the Pair Production component of the mass cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The Pair Production component of the mass cross section (cm^2/g) of the material at the specified energy or energies

xrayphysics.xrayPhysics.sigmaTP(self, Z, gamma)

Returns the Triplet Production component of the mass cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The Triplet Production component of the mass cross section (cm^2/g) of the material at the specified energy or energies

xrayphysics.xrayPhysics.rhoe(self, Z, massDensity)

Returns the electron density of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, or mixture of compounds with mass fractions

  • massDensity (scalar) – the mass density (g/cm^3) of the material

Returns:

The electron density (mol * e / cm^3) of the material

xrayphysics.xrayPhysics.rho(self, Z, electronDensity)

Returns the mass density of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, or mixture of compounds with mass fractions

  • electronDensity (scalar) – the electron density (mol * e / cm^3) of the material

Returns:

The mass density (g / cm^3) of the material

xrayphysics.xrayPhysics.sigma_e(self, Z, gamma)

Returns the electron cross section of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar or numpy array) – the energy or energies (keV) for which to calculate the mass cross section

Returns:

The electron cross section (cm^2/(mol * e)) of the material at the specified energy or energies

xrayphysics.xrayPhysics.ComptonScatterDistribution(self, Z, gamma, theta, doNormalize=False)

Returns the Compton Scatter distribution of the given material

Alias for incoherentScatterDistribution

xrayphysics.xrayPhysics.incoherentScatterDistribution(self, Z, gamma, theta, doNormalize=False)

Returns the Incoherent Scatter distribution of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar) – the energy (keV) for which to calculate the Scatter distribution

  • theta (scalar or numpy array) – the angle(s) (degrees) for which to calculate the Scatter distribution

  • doNormalize (bool) – if True, normalizes the values so that they can express as a probability density function

Returns:

The Incoherent Scatter distribution of the material at the specified energy and angles

xrayphysics.xrayPhysics.RayleighScatterDistribution(self, Z, gamma, theta, doNormalize=False)

Returns the Rayleigh Scatter distribution of the given material

Alias for coherentScatterDistribution

xrayphysics.xrayPhysics.coherentScatterDistribution(self, Z, gamma, theta, doNormalize=False)

Returns the Coherent Scatter distribution of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar) – the energy (keV) for which to calculate the Scatter distribution

  • theta (scalar or numpy array) – the angle(s) (degrees) for which to calculate the Scatter distribution

  • doNormalize (bool) – if True, normalizes the values so that they can express as a probability density function

Returns:

The Coherent Scatter distribution of the material at the specified energy and angles

xrayphysics.xrayPhysics.ComptonScatterDistribution_normalizationFactor(self, Z, gamma)

Returns the Compton Scatter distribution normalization factor of the given material

Alias for incoherentScatterDistribution_normalizationFactor

xrayphysics.xrayPhysics.incoherentScatterDistribution_normalizationFactor(self, Z, gamma)

Returns the Incoherent Scatter distribution normalization factor of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar) – the energy (keV) for which to calculate the normalization factor

Returns:

The Incoherent Scatter distribution normalization factor of the material at the specified energy

xrayphysics.xrayPhysics.RayleighScatterDistribution_normalizationFactor(self, Z, gamma)

Returns the Rayleigh Scatter distribution normalization factor of the given material

Alias for coherentScatterDistribution_normalizationFactor

xrayphysics.xrayPhysics.coherentScatterDistribution_normalizationFactor(self, Z, gamma)

Returns the Coherent Scatter distribution normalization factor of the given material

Parameters:

  • Z (scalar or string) – atomic number, chemical formula, mixture of compounds with mass fractions, or member of the material library

  • gamma (scalar) – the energy (keV) for which to calculate the normalization factor

Returns:

The Coherent Scatter distribution normalization factor of the material at the specified energy