Skip to main content

Crystallographic analysis for STEM data

Reason this release was yanked:

Broken build file

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

singleorigin-3.0.0.tar.gz (45.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

singleorigin-3.0.0-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file singleorigin-3.0.0.tar.gz.

File metadata

  • Download URL: singleorigin-3.0.0.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for singleorigin-3.0.0.tar.gz
Algorithm Hash digest
SHA256 e74417c43e8f924e0fc0f0c58afc006bf65ca6fb6c4f053bceb396bf203812ae
MD5 ebdf5f01333941e3331bb971ebb13967
BLAKE2b-256 4e94ebbd503c6527cc54973ed7bede6d9f1e1d5393de33938c134ea72deb04d3

See more details on using hashes here.

File details

Details for the file singleorigin-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: singleorigin-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for singleorigin-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03493a904915b33ea1b38630546b5e0419802e2502729bda12a3b0f37856fd5d
MD5 fcc4bedf4935487c1132096623ca03c4
BLAKE2b-256 5df8b9076900aaea24463555651306512da24dc79dd8b8a01a85f45b5f43c99e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page