Package ltempy

ltempy is a set of tools for the analysis, simulation, and presentation of Lorentz TEM data.

Features:

  • Single Image Transport of Intensity Equation (SITIE) phase reconstruction
  • simulations of phase, magnetic field, magnetic vector potential, and Lorentz images
  • basic image processing
  • a matplotlib.pyplot wrapper tailored to presenting induction maps and Lorentz data
  • an implementation of the CIELAB perceptually-uniform colorspace
  • module-wide unit scaling (i.e., working in nm rather than m)
Expand source code
# ltempy is a set of LTEM analysis and simulation tools developed by WSP as a member of the McMorran Lab
# Copyright (C) 2021  William S. Parker
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

"""
`ltempy` is a set of tools for the analysis, simulation, and presentation of Lorentz TEM data.

Features:

* Single Image Transport of Intensity Equation (SITIE) phase reconstruction
* simulations of phase, magnetic field, magnetic vector potential, and Lorentz images
* basic image processing
* a `matplotlib.pyplot` wrapper tailored to presenting induction maps and Lorentz data
* an implementation of the CIELAB perceptually-uniform colorspace
* module-wide unit scaling (i.e., working in nm rather than m)
"""

import numpy as np
import os
from pathlib import Path

from .colors import *
from .constants import set_units
from .process import *
from .simulate import *
from .sitie import *
from .plot import *

Sub-modules

ltempy.colors

Generate rgba data from scalar values and implement the CIELAB colorspace …

ltempy.constants

Allows unit scaling across ltempy

ltempy.plot

Contains wrappers for matplotlib.pyplot, tailored to the presentation of LTEM data …

ltempy.process

Basic image processing tools.

ltempy.simulate

Simulate Aharonov-Bohm phase, magnetic vector potential, magnetic field, and LTEM images …

ltempy.sitie

Contains utilities for reconstructing phase and magnetization from Lorentz images …