Skip to main content

m2py: Materials Morphology Python Package

Contributors

  • Wesley Tatum, PhD Student at University of Washington MSE Department
  • Diego Torrejon, Staff Machine Learning Engineer at BlackSky
  • Patrick O’Neil, Director of Machine Learning and Artificial Intelligence at BlackSky

Requirements

You need Python 3.6 or later to work with m2py.

Installation

Through github:

Clone or download this repository

pip install -r requirements.txt

Through pip:

pip install m2py

Usage

At the moment, we are offering two introductory tutorials found under the tutorials directory. There is a basic tutorial showing the main processing capabilities of m2py. There's also an advanced tutorial showing how users can use current m2py capabilities to make them suitable for their own applications.

Background

SPM techniques have been pivotal in understanding surfaces, morphologies, and intermolecular interactions of matter from the atomic to millimeter scales. Probes interacting with the material surface produce 2-dimensional images of the topography with intensity scales representing any number of material properties (e.g. modulus, conductivity, or capacitance). In many experiments, multiple properties can be imaged simultaneously, producing a 3-dimensional stack of these images.

By utilizing different combinations of computer vision and machine learning techniques, m2py leverages differences in imaged material properties to recognize different material phases, as well as different domains and topographical features. First, outlier pixels or signals can be removed. Next, signals are compressed to only the most informative features via PCA. These signals can be deconvoluted via GMM, or some other semantic segmenter for phase labeling. Finally, an instance segmenter, such as Persistence Watershed Segmentation, clusters the phase-labeled pixels into domains, which receive another label.

Once labeled by m2py segmenters, quantitative descriptions of each domain and the total morphology are extracted and can be used to train supervised models to predict material properties or performance. Such supervised training has not been accessible to most SPM researchers, due to the labor-intensive nature of manual-labeling.

Release files for m2py 0.0.4

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

Source distribution (sdist)

Source distribution for m2py 0.0.4
File Size Uploaded
m2py-0.0.4.tar.gz 2.4 kB Details

Built distribution (wheel)

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

Total release size: 26.1 kB

Release files / m2py-0.0.4.tar.gz

Download URL m2py-0.0.4.tar.gz
Size 2.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8f12869d1d395ac6ce84d729187742b8a8c2ec14fed47960d055b0e404575616
BLAKE2b-256 checksum
How to use checksums
f175cdff8aebe54db7e2551392c656433e6c4669d281df84e5f3cb632bcf7358
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.4

Release files / m2py-0.0.4-py3-none-any.whl

Download URL m2py-0.0.4-py3-none-any.whl
Size 23.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a0e71b3f2eeffdabb68d70bef62f4494e10192118e99a12b8d53bd4b4bb8d58f
BLAKE2b-256 checksum
How to use checksums
0e7d85577d84aa21453200e93557950d693bac7fd92e3a8cd19a5a549451761f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.4

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

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