erlab.io.exampledata

Generates simple simulated ARPES data for testing purposes.

Functions

add_fd_norm(image, eV[, temp, efermi, count])

band(kvec, t, a)

fermi_dirac(E, T)

func(kvec, a)

generate_data([shape, krange, Erange, temp, ...])

Generate simulated data for a given shape in momentum space.

generate_data_angles([shape, angrange, ...])

Generate simulated data for a given shape in angle space.

generate_gold_edge([a, b, c, temp, Eres, ...])

Generate a curved Fermi edge with a linear density of states.

spectral_function(w, bareband, Sreal, Simag)

erlab.io.exampledata.generate_data(shape=(250, 250, 300), krange=0.89, Erange=(-0.45, 0.09), temp=20.0, a=6.97, t=0.43, bandshift=0.0, Sreal=0.0, Simag=0.03, kres=0.01, Eres=2.0e-3, noise=True, seed=None, count=100000000, ccd_sigma=0.6)[source]

Generate simulated data for a given shape in momentum space.

Parameters:

  • shape (tuple[int, int, int]) – The shape of the generated data, by default (250, 250, 300)

  • krange (float | tuple[float, float] | dict[str, tuple[float, float]]) – Momentum range in inverse angstroms. Can be a single float, a tuple of floats representing the range, or a dictionary with kx and ky keys mapping to tuples representing the range for each dimension, by default 0.89

  • Erange (tuple[float, float]) – Binding energy range in electronvolts, by default (-0.45, 0.09)

  • temp (float) – The temperature in Kelvins for the Fermi-Dirac cutoff. If 0, no cutoff is applied, by default 20.0

  • a (float) – Tight binding parameter \(a\), by default 6.97

  • t (float) – Tight binding parameter \(t\), by default 0.43

  • bandshift (float) – The rigid energy shift in eV, by default 0.0

  • Sreal (float) – The real part of the self energy, by default 0.0

  • Simag (float) – The imaginary part of the self energy, by default 0.03

  • kres (float) – Broadening in momentum in inverse angstroms, by default 0.01

  • Eres (float) – Broadening in energy in electronvolts, by default 2.0e-3

  • noise (bool) – Whether to add noise to the generated data, by default True

  • seed (int | None) – Seed for the random number generator for the noise. Default is None.

  • count (int) – Determines the signal-to-noise ratio when noise is True, by default 1e+8

  • ccd_sigma (float) – The sigma value for CCD noise generation when noise is True, by default 0.6

Returns:

The generated data with coordinates for kx, ky, and eV.

Return type:

xarray.DataArray

erlab.io.exampledata.generate_data_angles(shape=(500, 60, 500), angrange=15.0, Erange=(-0.45, 0.12), hv=50.0, configuration=erlab.analysis.kspace.AxesConfiguration.Type1, temp=20.0, a=6.97, t=0.43, bandshift=0.0, Sreal=0.0, Simag=0.03, angres=0.1, Eres=10.0e-3, noise=True, seed=None, count=100000000, ccd_sigma=0.6, assign_attributes=False)[source]

Generate simulated data for a given shape in angle space.

Parameters:

  • shape (tuple[int, int, int]) – The shape of the generated data, by default (250, 250, 300)

  • angrange (float | tuple[float, float] | dict[str, tuple[float, float]]) – Angle range in degrees. Can be a single float, a tuple of floats representing the range, or a dictionary with alpha and beta keys mapping to tuples representing the range for each dimension, by default 15.0

  • Erange (tuple[float, float]) – Binding energy range in electronvolts, by default (-0.45, 0.12)

  • hv (float) – The photon energy in eV. Note that the sample work function is assumed to be 4.5 eV, by default 30.0

  • configuration (AxesConfiguration | int) – The experimental configuration, by default Type1DA

  • temp (float) – The temperature in Kelvins for the Fermi-Dirac cutoff. If 0, no cutoff is applied, by default 20.0

  • a (float) – Tight binding parameter \(a\), by default 6.97

  • t (float) – Tight binding parameter \(t\), by default 0.43

  • bandshift (float) – The rigid energy shift in eV, by default 0.0

  • Sreal (float) – The real part of the self energy, by default 0.0

  • Simag (float) – The imaginary part of the self energy, by default 0.03

  • angres (float) – Broadening in angle in degrees, by default 0.01

  • Eres (float) – Broadening in energy in electronvolts, by default 2.0e-3

  • noise (bool) – Whether to add noise to the generated data, by default True

  • seed (int | None) – Seed for the random number generator for the noise. Default is None.

  • count (int) – Determines the signal-to-noise ratio when noise is True, by default 1e+8

  • ccd_sigma (float) – The sigma value for CCD noise generation when noise is True, by default 0.6

  • assign_attributes (bool) – Whether to assign attributes to the generated data, by default False

Returns:

The generated data with coordinates for alpha, beta, and eV.

Return type:

xarray.DataArray