A Python library for Atom Probe Tomography analysis
Project description
APAV: Python for Atom Probe Tomography
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:
- Multiple-event analysis (i.e. correlation histograms, multiple event histograms, multiple event mass quantifications).
- Manual control over mass spectrum analysis (background models, fit regions, binning, etc).
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file APAV-1.4.0.tar.gz
.
File metadata
- Download URL: APAV-1.4.0.tar.gz
- Upload date:
- Size: 57.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae26caf1908da04ab88cfa6f16532ad8cb09548c2c11de40d95703afbc4f45d6 |
|
MD5 | 770c7cc9804a98aac568107e0238dc73 |
|
BLAKE2b-256 | 56e8f8d2e6b34a82cfe746fbe41c87d52442632151bcae8ebb3c0027f65bf73b |
File details
Details for the file APAV-1.4.0-cp311-cp311-win_amd64.whl
.
File metadata
- Download URL: APAV-1.4.0-cp311-cp311-win_amd64.whl
- Upload date:
- Size: 57.8 MB
- Tags: CPython 3.11, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd2c80bc84f3bd1fcefc77d2ea646fbb5ad869f02c6b70d31216e7e2cf10baa9 |
|
MD5 | 01b48621edc7ddbc6196ec066f0cad1c |
|
BLAKE2b-256 | 56c3940059cd34174e226fe4507c5ef9c20aee84b9677e2743321666e9e347db |
File details
Details for the file APAV-1.4.0-cp310-cp310-win_amd64.whl
.
File metadata
- Download URL: APAV-1.4.0-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/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 951d8369afe864a9b926ccbd6cd9cbe4488d006b1ef9bc65117d93c416d8f40f |
|
MD5 | b633d2678d89aa83e41c33f02ab589e5 |
|
BLAKE2b-256 | f5bc2e49807d747eca5d9dd4e242aaae7631478fc529b70ad3678ca117f8c30d |
File details
Details for the file APAV-1.4.0-cp39-cp39-win_amd64.whl
.
File metadata
- Download URL: APAV-1.4.0-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/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3becb261ea2a641ed5817dcfaf7c5ba50823abb41da830da0f73eddfcf8c660f |
|
MD5 | 0c6c70f3feb2a318215ed1e7bc8e1bbd |
|
BLAKE2b-256 | 5fc37947fccd7d837bd0695b43b2e9be3bb695ce957030e91286e0e54ea75c29 |
File details
Details for the file APAV-1.4.0-cp38-cp38-win_amd64.whl
.
File metadata
- Download URL: APAV-1.4.0-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/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f70e76d0325c4589f2b7b030a0ff1f7a378bd6380e6f2b49e4310003d7fe476 |
|
MD5 | 032991cfcc6cdbb0e373a6d5f3635937 |
|
BLAKE2b-256 | 499e1273e4606389c5b871f4168a4b2e78e383e83ed2fa93934f74e9b27e34f6 |
File details
Details for the file APAV-1.4.0-cp37-cp37m-win_amd64.whl
.
File metadata
- Download URL: APAV-1.4.0-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/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fefeeab069d95dda5e0eeb3843287a6cd02bdc23e9f55fe0f4a052f8a0fe79a |
|
MD5 | 2d3b325ae933cd946cbf690f51adeb80 |
|
BLAKE2b-256 | b5933a535f3ecbbd5534f98f70e0f30d98042b887d80f83a3f31e5a7356e8dd7 |