exspy.data#

EDS_SEM_TM002()

Load an EDS-SEM spectrum of a EDS-TM002 standard supplied by the Bundesanstalt für Materialforschung und -prüfung (BAM).

EDS_TEM_FePt_nanoparticles()

Load an EDS-TEM spectrum of FePt bimetallic nanoparticles.

EELS_low_loss([add_noise, random_state, ...])

Get an artificial low loss electron energy loss spectrum.

EELS_MnFe([add_powerlaw, add_noise, ...])

Get an artificial core loss electron energy loss spectrum.

eelsdb([spectrum_type, title, author, ...])

Download spectra from the EELS database.

This module contains functions to load example or datasets from EELSDB.

exspy.data.EDS_SEM_TM002()#

Load an EDS-SEM spectrum of a EDS-TM002 standard supplied by the Bundesanstalt für Materialforschung und -prüfung (BAM). The sample consists of an approximately 6 µm thick layer containing the elements C, Al, Mn, Cu and Zr on a silicon substrate.

Notes

  • Sample: EDS-TM002 provided by BAM (www.webshop.bam.de)

  • SEM Microscope: Nvision40 Carl Zeiss

  • EDS Detector: X-max 80 from Oxford Instrument

exspy.data.EDS_TEM_FePt_nanoparticles()#

Load an EDS-TEM spectrum of FePt bimetallic nanoparticles.

Notes

  • TEM Microscope: Tecnai Osiris 200 kV D658 AnalyticalTwin

  • EDS Detector: Super-X 4 detectors Brucker

exspy.data.EELS_MnFe(add_powerlaw=True, add_noise=True, random_state=None, navigation_shape=(10,))#

Get an artificial core loss electron energy loss spectrum.

Similar to a Mn-L32 edge from a perovskite oxide.

Some random noise is also added to the spectrum, to simulate experimental noise.

Parameters:
  • add_powerlaw (bool) – If True, adds a powerlaw background to the spectrum. Default is False.

  • add_noise (bool) – If True, add noise to the signal. See note to seed the noise to generate reproducible noise.

  • random_state (None or int or RandomState instance, default None) – Random seed used to generate the data.

  • navigation_shape (tuple) – The shape of the navigation space. Must be of length 1.

Return type:

EELSSpectrum

Example

>>> import exspy
>>> s = exspy.data.EELS_Mn()
>>> s.plot()

With the powerlaw background

>>> s = exspy.data.EELS_Mn(add_powerlaw=True)
>>> s.plot()

See also

EELS_low_loss

exspy.data.EELS_low_loss(add_noise=True, random_state=None, navigation_shape=(10,))#

Get an artificial low loss electron energy loss spectrum.

The zero loss peak is offset by 4.1 eV.

Parameters:
  • add_noise (bool) – If True, add noise to the signal. See note to seed the noise to generate reproducible noise.

  • random_state (None or int or RandomState instance, default None) – Random seed used to generate the data.

  • navigation_shape (tuple) – The shape of the navigation space.

Return type:

EELSSpectrum

Example

>>> s = exspy.data.low_loss(navigation_shape=(10, 10))
>>> s.plot()

See also

EELS_MnFe

exspy.data.eelsdb(spectrum_type=None, title=None, author=None, element=None, formula=None, edge=None, min_energy=None, max_energy=None, resolution=None, min_energy_compare='gt', max_energy_compare='lt', resolution_compare='lt', max_n=-1, monochromated=None, order=None, order_direction='ASC', verify_certificate=True, show_progressbar=None)#

Download spectra from the EELS database.

Parameters:
  • spectrum_type ({'coreloss', 'lowloss', 'zeroloss', 'xrayabs'}, optional)

  • title (string) – Search spectra titles for a text string.

  • author (string, optional) – Search authors for a text string.

  • element (string or list of strings, optional) – Filter for the presence of one or more element. Each string must correspond with a valid element symbol.

  • formula (string) – Chemical formula of the sample.

  • edge ({'K', 'L1', 'L2,3', 'M2,3', 'M4,5', 'N2,3', 'N4,5' 'O2,3', 'O4,5'}, optional) – Filter for spectra with a specific class of edge.

  • min_energy (float, optional) – Minimum and maximum energy in eV.

  • max_energy (float, optional) – Minimum and maximum energy in eV.

  • resolution (float, optional) – Energy resolution in eV.

  • resolution_compare ({"lt", "eq", "gt"}, optional, default "lt") – “lt” to search for all spectra with resolution less than resolution. “eq” for equal, “gt” for greater than.

  • min_energy_compare ({"lt", "eq", "gt"}, optional) – “lt” to search for all spectra with min/max energy less than min_energy`max_energy`. “eq” for equal, “gt” for greater than. Deafault values are “gt”/”lt” for min_energy`max_energy` respectively.

  • max_energy_compare ({"lt", "eq", "gt"}, optional) – “lt” to search for all spectra with min/max energy less than min_energy`max_energy`. “eq” for equal, “gt” for greater than. Deafault values are “gt”/”lt” for min_energy`max_energy` respectively.

  • monochromated (bool or None (default))

  • max_n (int, default -1) – Maximum number of spectra to return. -1 to return all.

  • order (string) –

    Key to sort results by. Valid keys are:

    • ”spectrumType”,

    • ”spectrumMin”,

    • ”spectrumMax”,

    • ”stepSize”,

    • ”spectrumFormula”,

    • ”spectrumElement”,

    • ”spectrumUpload”,

    • ”source_purity”,

    • ”spectrumEdges”,

    • ”microscope”,

    • ”guntype”,

    • ”beamenergy”,

    • ”resolution”,

    • ”monochromated”,

    • ”acquisition_mode”,

    • ”convergence”,

    • ”collection”,

    • ”probesize”,

    • ”beamcurrent”,

    • ”integratetime”,

    • ”readouts”,

    • ”detector”,

    • ”darkcurrent”,

    • ”gainvariation”,

    • ”calibration”,

    • ”zeroloss_deconv”,

    • ”thickness”,

    • ”deconv_fourier_log”,

    • ”deconv_fourier_ratio”,

    • ”deconv_stephens_deconvolution”,

    • ”deconv_richardson_lucy”,

    • ”deconv_maximum_entropy”,

    • ”deconv_other”,

    • ”assoc_spectra”,

    • ”ref_freetext”,

    • ”ref_doi”,

    • ”ref_url”,

    • ”ref_authors”,

    • ”ref_journal”,

    • ”ref_volume”,

    • ”ref_issue”,

    • ”ref_page”,

    • ”ref_year”,

    • ”ref_title”,

    • ”otherURLs”

  • order_direction ({"ASC", "DESC"}) – Sorting order direction.

  • verify_certificate (bool) – If True, verify the eelsdb website certificate and raise an error if it is invalid. If False, continue querying the database if the certificate is invalid. (This is a potential security risk.)

  • show_progressbar (None or bool) – If True, display a progress bar. If None, the default from the preferences settings is used.

Returns:

spectra – A list containing all the spectra matching the given criteria if any.

Return type:

list