Skip to main content

SingleOrigin

A Python module for analysis of multiple S/TEM modalities: atomic resolution images, 4D STEM and EELS.

Features incorporated into all modules:

- Numpy / Pandas-based data strctures. Easy results extraction for:

  • Subsequent custom analysis
  • Custom plotting/figure building

- Streamlined. Class for each processing pipline / data type:

  • Stores data and results (as class attributes)
  • Built-in processing methods (as class methods)
  • Reduced user inputs/programming because methods already know where to find most required information

- Fast:

  • Efficient coding
  • Parallel CPU processing for major iterative tasks (e.g. fitting 1000s of atom columns)

Module descriptions:

Atomic resolution image analysis module intended for structural analysis of high resolution scanning transmission electron microscope images of crystalline lattices. The module uses 2D Gaussian fitting and automatically accounts for intensity overlap between closely spaced columns based on image morphology. Atom columns are initially found by registering a projected reference lattice to the image based on a CIF of the imaged structure (or a similar one).

Incorporates a number of different methods to visualize the atom column positions:

  • Directly plotting the fitted positions.
  • Plotting displacement vectors from the reference to fitted positions.
  • Calculating vector pair correlation functions (vPCFs) for various sublattices to see the distributions of projected bond vectors in real space. Analogous to a pair distribution function, as obtained from X-ray or neutron "total scattering" experiments, but retaining the orientation information available in the image. See the original vPCF paper in APL Materials: https://aip.scitation.org/doi/10.1063/5.0058928
  • Plot inter-atom column distances (or distance deviations from the reference lattice) corresponding to a vector (or vectors) in a vPCF.

Diffraction / 4D STEM analysis module. Currently operational methods are:

  • Basic virtual detectors and other utility functions.
  • Strain mapping is implemented in the ReciprocalLattice class (direct or cepstrum).
  • Imaginary exit-wave cepstrum for polarization measurement from diffraction data.
  • Reciprocal lattice measurements from single diffraction patterns, 4D STEM datasets or HRSTEM FFTs can be made using the ReciprocalLattice class. Superlattice may also be measured.

EELS module. Manipulation and quantification of EELS, especially EELS spectrum images. Quantitative elemental analysis using model fitting.

Installation:

It is recommended to install by pip in a clean Python environment (https://docs.python.org/3/library/venv.html). SingleOrigin may be used in Spyder or Jupyter notebooks/lab. To install, activate your environment and run the following in a command line prompt if you downloaded the tarball:

pip install "pathtofile/SingleOrigin-3.0.0.tar.gz"

OR build from Github:

pip install git+https://github.com/sdfunni/SingleOrigin.git

OR from PyPI:

pip install SingleOrigin

See example scripts and Jupyter-lab notebooks at: https://github.com/sdfunni/SingleOrigin

Metadata

Release files for SingleOrigin 3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for SingleOrigin 3.0.1
File Size Uploaded
singleorigin-3.0.1.tar.gz 173.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for SingleOrigin 3.0.1
File Interpreter ABI Platform
singleorigin-3.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 357.0 kB

Release files / singleorigin-3.0.1.tar.gz

Download URL singleorigin-3.0.1.tar.gz
Size 173.6 kB
Tags Source
SHA-256 checksum
How to use checksums
afb9b2a5eedddb0f4d3037ccb20ba0fb45e32f6d7199845f5160c9e285fae02f
BLAKE2b-256 checksum
How to use checksums
e721bec0cd76def3bccfd7c9a7a2943f6f216e138546db2dbb64fd4109085361
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.4

Release files / singleorigin-3.0.1-py3-none-any.whl

Download URL singleorigin-3.0.1-py3-none-any.whl
Size 183.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d624fc04e9b515c38b581791830e63a15ddce661a7f0a945643b8307543b81a3
BLAKE2b-256 checksum
How to use checksums
c9055847db7bdc646653765ea06712c4add8fa5650717088195478cc25ee5427
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

3.0.1 This release

2 release files

3.0.0

2 release files

2.5.7

2 release files

2.5.6

2 release files

2.5.5

2 release files

2.5.4

2 release files

2.5.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page