Skip to main content

A Python library for Atom Probe Tomography analysis

Project description

APAV: Atom Probe Tomography for Python

Documentation Status coverage report pipeline status License: GPL v2 PyPI version Conda

APAV (Atom Probe Analysis and Visualization) is a Python package for analysis and visualization of atom probe tomography datasets, some features:

  • File read support for traditional (*.pos, *.epos, *.ato, *.rng, *.rrng) or new (*.apt) formats
  • File write support for *.pos and *.epos
  • Mass spectrum quantification with configurable background correction
  • Calculation and configuration of correlation histograms
  • Roi primitive shapes for localized analysis
  • Most analyses can be parameterized by multiple-detection events
  • Fast generation of the compositional grid using conventional 1st/2nd pass delocalization
  • Calculation of arbitrary molecular isotopic distributions

Basic usage

Essential APT analysis typically involves loading some data and doing some calculation(s). Import the core functions and classes:

>>> import apav as ap

Load an apt file from AP Suite or some other source, along with a suitable range file (or build one programtically):

>>> roi = ap.load_apt("data/NiTiHf.apt")
>>> rng = ap.load_rrng("data/NiTiHf_FWHM.rrng")

Now import the analysis components and compute the total (uncorrected) decomposed composition:

>>> import apav.analysis as anl
>>> mass = anl.RangedMassSpectrum(roi, rng, decompose=True)
>>> mass.print()
Ion      Composition    Counts
-----  -------------  --------
Ti        0.307084     2381757
Ni        0.595634     4619772
Hf        0.0907196     703626
O         0.00656261     50900

Estimate the (uncorrected) composition of a grain in the upper part of the ROI using a sphere:

>>> precip_roi = ap.RoiSphere(roi, center=(-8.5, 2.1, -20), radius=20)
>>> precip_mass = anl.RangedMassSpectrum(precip_roi, rng, decompose=True)
>>> precip_mass.print()
Ion      Composition    Counts
-----  -------------  --------
Ti        0.397016      261053
Ni        0.532445      350102
Hf        0.0665544      43762
O         0.00398457      2620

Check the documentation for more analyses and background corrections.

Documentation

Documentation is found at: https://apav.readthedocs.io/

Support

Post discussion to the GitLab issue tracker

FAQ

Why use this over IVAS/AP Suite or program X?

APAV is not intended to be an IVAS substitute or replacement. While much of the functionality may overlap, APAV fills feature gaps in IVAS/AP Suite that are lacking or otherwise non-existent. Specifically:

  1. Multiple-event analysis (i.e. correlation histograms, multiple event histograms, multiple event mass quantifications).
  2. Manual control over mass spectrum analysis (background models, fit regions, binning, etc).
  3. An API to easily interface into APT data for custom data analysis.

Why is there no GUI for APAV?

APAV is intended to be used as a python library. Perhaps a GUI will one day exist along side APAV (but not in replacement). For now, APAV includes some custom interactive plotting tools for certain computations.

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

APAV-1.3.1.tar.gz (57.3 MB view details)

Uploaded Source

Built Distributions

APAV-1.3.1-cp310-cp310-win_amd64.whl (57.8 MB view details)

Uploaded CPython 3.10 Windows x86-64

APAV-1.3.1-cp39-cp39-win_amd64.whl (57.8 MB view details)

Uploaded CPython 3.9 Windows x86-64

APAV-1.3.1-cp38-cp38-win_amd64.whl (57.8 MB view details)

Uploaded CPython 3.8 Windows x86-64

APAV-1.3.1-cp37-cp37m-win_amd64.whl (57.8 MB view details)

Uploaded CPython 3.7m Windows x86-64

File details

Details for the file APAV-1.3.1.tar.gz.

File metadata

  • Download URL: APAV-1.3.1.tar.gz
  • Upload date:
  • Size: 57.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for APAV-1.3.1.tar.gz
Algorithm Hash digest
SHA256 d23c6f4c4d5cd688604a44777a03fb8b8b67bc8a9f3af6259d41d1d86f2300b5
MD5 3d7c25b2c3d1c42c33a187f67ec40560
BLAKE2b-256 79364d38fcc04a003bc36c3c16d158520a33c66b14cea6d3ba8cae1c02f25f5e

See more details on using hashes here.

File details

Details for the file APAV-1.3.1-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: APAV-1.3.1-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 57.8 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for APAV-1.3.1-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 4e6f0f6675edf15f5c6ed76c06ce939ee48f2232c64b572676d14234acf616ed
MD5 866b7de74c061fa69c92d88b2320a89f
BLAKE2b-256 7490e41ba68967cb17c5708aee4263ab0ed2f1ab9bd6ecd578058f55cdd3369a

See more details on using hashes here.

File details

Details for the file APAV-1.3.1-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: APAV-1.3.1-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 57.8 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for APAV-1.3.1-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 c459205bd329ac97ad1c9c95426fcd57d11b591dcdd24911858287e754aab29e
MD5 379f646859f765499135596ff362ff9b
BLAKE2b-256 bb9f36e24e988b064f8db6fbae75a5272d6b77ad95bea5f06059c653f46d8bf2

See more details on using hashes here.

File details

Details for the file APAV-1.3.1-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: APAV-1.3.1-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 57.8 MB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for APAV-1.3.1-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 a8569907d6cfed91a08fc5033b10b610b9f9604250da530b3c23f96f0a518af9
MD5 e02940f2b558bbc86c0b6fce117f98a9
BLAKE2b-256 711d90e567b2945b5dc551324890008f48106092c10c774a16456193d7c67263

See more details on using hashes here.

File details

Details for the file APAV-1.3.1-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: APAV-1.3.1-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 57.8 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for APAV-1.3.1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 2b45eae96452e1039a136b4768c889808beda6f5d042b5ba7bae343c7e83db29
MD5 e5ab11a86821217514cc1fc2d335e63a
BLAKE2b-256 8289a8d95290cfd0850aaa0073eba68bba96407dade057438594f7835b1049f6

See more details on using hashes here.

Supported by

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