exspy#

This reference manual describes the public functions, modules, and objects in eXSpy.

exspy.__version__#

The version of the eXSpy package.

Type:

str

exspy.preferences#

The global preferences for eXSpy, where the default settings are stored.

Submodules

components

The components module contains components used in model fitting.

data

The data module contains example datasets.

material

The material module contains objects and functions related to materials properties and functionalities, such as density calculations, absorption coefficients, etc.

models

The models module contains the model classes used for EDS and EELS model fitting.

signals

The signals module contains the signal classes, such as EDS and EELS.

utils

The utils module contains EDS and EELS utility functions, such as those for getting X-ray lines, EELS edges information, calculating cross-section, inelastic mean free paths, etc.

Examples

To set a preference value, for example setting the EDS detector elevation angle to 15 degrees:

>>> exspy.preferences.EDS.eds_detector_elevation = 15.0

To open the preferences dialog. Requires GUI widgets, to enable them see the hyperspy documentation for configuring HyperSpy.

>>> exspy.preferences.gui()
../_images/EDS_preferences_gui.png

EDS preferences window#

eXSpy preferences#

The exspy preferences has two configuration tabs for EDS and EELS:

class exspy._defaults_parser.EDSConfig#

Bases: HasTraits

Configuration options for EDS.

eds_mn_ka#

Energy resolution at Mn Ka in eV.

Type:

float

eds_tilt_stage#

Stage tilt in degree.

Type:

float

eds_detector_azimuth#

Azimuth angle in degree.

Type:

float

eds_detector_elevation#

Elevation angle in degree.

Type:

float

class exspy._defaults_parser.EELSConfig#

Bases: HasTraits

Configuration options for EELS.

eels_gos_files_path#

Path to the directory containing the Hartree-Slater GOS files as provided by Gatan DigitalMicrograph Suite v1.x and v2.x, more recent versions are not supported.

Type:

str