mbs package

Submodules

mbs.spectra module

class mbs.spectra.AbstractSpectrum(data, axes, metadata=None)

Bases: NDArrayOperatorsMixin

mbs.spectra.AcqMode

alias of AcquisitionMode

class mbs.spectra.AngleMap(spectra, **kwargs)

Bases: SpectrumMap

plot_k(ax, fl, width=10, lens_angle_c=1.0, other_angle_c=1.0, new_origin=None, **kwargs)

class mbs.spectra.DeflectionMap(spectra, **kwargs)

Bases: AngleMap

class mbs.spectra.EnergyMap(spectra, **kwargs)

Bases: SpectrumMap

property fls

fls_fit(fls=None, order=2)

classmethod get_coord_transformer(V_0=0, photon_angle=30, WF=4.0, BE=0.0)

Returns a function that transforms coordinate pairs (phi, hv) to (kx, kz) V_0 (eV): inner potential relative to E_vac

V_0 (rel. to E_F) = V_0 (rel. to E_vac) - WF

photon_angle (deg): angle away from grazing incidence (assuming normal emission),

i.e. (90 - photon_angle) == angle from normal incidence

WF (eV): sample work function - usually unknown! BE (eV): binding energy, >0

If you assume that WF_sample == WF_detector, then hv-WF-BE is essentially the kinetic energy you see on the detector.

# 0.5124 == … # 5.067*10**-4 == …

plot(*args, **kwargs)

plot_k(ax, fmap=None, lens_angle_c=1.0, angle_zero=0, tf_kwargs={}, lens_scale=None, new_origin=None, **kwargs)

class mbs.spectra.Spectrum(data, metadata)

Bases: AbstractSpectrum

property acq_mode

property acqtime

Nominal and effective (signal) acquisition time based on measurement parameters

property data

dead_pixel_correction()

property duration

Wall-time clock duration of measurement, completely wrong for multi-region scans

e_to_i(e, view=True)

Return array index i for given energy e

property edc

property energy_extent

property energy_scale

classmethod from_filename(fname, zip_fname=None, **kwargs)

classmethod from_krx(fname, zip_fname=None, page=0)

classmethod from_txt(fname, zip_fname=None)

get_focus()

get_metadata(item=None)

index_slice(slicetuple)

Slice in terms of indices

property info

l_to_i(l, view=True)

Return array index for given lens coordinate l

property lens_extent

property lens_scale

property masked_data

property metadata

property name

plot(ax, angle_correction=1.0, **kwargs)

plot_edc(ax, e_f=None, norm=None, **kwargs)

plot_k(ax, angle_correction=1.0, k_origin=None, Ef=None, V0=0, **kwargs)

symmetrize(lens_coordinate, method='cut')

Symmetrize spectrum with respect to some lens coordinate

property xarray

class mbs.spectra.SpectrumMap(spectra, **kwargs)

Bases: object

property data

classmethod from_filenames(fnames, zip_fname=None, **kwargs)

classmethod from_krx(fname, zip_fname=None, **kwargs)

generate_fermimap(fl, width, dither_repair=False)

plot(ax, lens_angle_c=1.0, other_angle_c=1.0, **kwargs)

property xarray

class mbs.spectra.SpectrumSum(data, metadata)

Bases: Spectrum

classmethod from_filenames(*fnames, zip_fname=None)

classmethod from_spectra(*spectra)

get_metadata(item=None, combine=True)

property md_keys

property metadata

property name

mbs.spectra.scale

alias of Scale

mbs.widgets module

mbs.io module

class mbs.io.LimitedSizeDict(*args, **kwds)

Bases: OrderedDict

Measurement cache

class mbs.io.MBSFilePathGenerator(prefix, directory=None, zip_fname=None)

Bases: object

mbs.io.info_timestamp(s)

mbs.io.is_mbs_filename(path)

mbs.io.load(fname, zip_fname=None, mode='rt')

Decorator that opens regular files, gzipped files and files contained within zip folders (e.g. archived measurements)

mbs.io.mbs_boolean(s)

mbs.io.mbs_timestamp(s)

mbs.io.mbs_timestamp2(s)

mbs.io.parse_data(fname, metadata_only=False, zip_fname=None)

mbs.io.parse_info(fname, zip_fname=None)

mbs.io.parse_lines(lines, metadata_only=False)

mbs.krx module

class mbs.krx.KRXFile(fname, zip_fname=None)

Bases: object

export_page_txt(out_fname, n=0)

property num_pages

page(n=0)

page_metadata(n=0)

Module contents