py4d-browser

A 4D-STEM GUI data browser for py4DSTEM

https://github.com/py4dstem/py4d-browser

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A 4D-STEM GUI data browser for py4DSTEM

Basic Info
  • Host: GitHub
  • Owner: py4dstem
  • License: gpl-3.0
  • Language: Python
  • Default Branch: dev
  • Size: 7.36 MB
Statistics
  • Stars: 16
  • Watchers: 1
  • Forks: 7
  • Open Issues: 3
  • Releases: 0
Created about 3 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

The py4DSTEM GUI

This repository hosts the pyqt based graphical 4D--STEM data browser that was originally part of py4DSTEM until version 0.13.11.

Installation

The GUI is available on PyPI and conda-forge:

pip install py4D-browser

conda install -c conda-forge py4d-browser

Usage

Run py4DGUI in your terminal to open the GUI. Then just drag and drop a 4D-STEM dataset into the window!

Controls

  • Move the virtual detector and the real-space selector using the mouse or using the keyboard shortcuts: WASD moves the detector and IJKL moves the selector, and holding down shift moves 5 pixels at a time.
  • Auto scaling of both views is on by default. Press the "Autoscale" buttons in the bottom right to disable. Press either button to apply automatic scaling once, or Shift + click to lock autoscaling back on.
  • Different shapes of virtual detector are available in the "Detector Shape" menu, and different detector responses are available in the "Detector Response" menu.
  • The information in the bottom bar contains the details of the virtual detector used to generate the images, and can be entered into py4DSTEM to generate the same image.
  • The FFT pane can be switched between displaying the FFT of the virtual image and displaying the exit wave power cepstrum.
  • Virtual images can be exported either as the scaled and clipped displays shown in the GUI or as raw data. The exact datatype stored in the raw TIFF image depends on both the datatype of the dataset and the type of virtual image being displayed (in particular, integer datatypes are converted internally to floating point to prevent overflows when generating any synthesized virtual images).

Demonstration

The keyboard map in the Help menu was made using this tool and the map file is in the top level of this repo.

Plugins

As of version 1.3.0, we now support a simple means for loading plugins that extend the functionality of the browser. Details on creating a plugin can be found in this document.

The EMPAD-G2 Raw Reader, which was previously implemented in the browser code itself, is now implemented as a plugin, which can serve as an example.

About

py4DSTEM logo

py4DSTEM is an open source set of python tools for processing and analysis of four-dimensional scanning transmission electron microscopy (4D-STEM) data. Additional information:

License

GNU GPLv3

py4DSTEM is open source software distributed under a GPLv3 license. It is free to use, alter, or build on, provided that any work derived from py4DSTEM is also kept free and open.

Owner

  • Name: py4dstem
  • Login: py4dstem
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite the accompanying paper."
abstract: "Scanning transmission electron microscopy (STEM) allows for imaging, diffraction, and spectroscopy of materials on length scales ranging from microns to atoms. By using a high-speed, direct electron detector, it is now possible to record a full two-dimensional (2D) image of the diffracted electron beam at each probe position, typically a 2D grid of probe positions. These 4D-STEM datasets are rich in information, including signatures of the local structure, orientation, deformation, electromagnetic fields, and other sample-dependent properties. However, extracting this information requires complex analysis pipelines that include data wrangling, calibration, analysis, and visualization, all while maintaining robustness against imaging distortions and artifacts. In this paper, we present py4DSTEM, an analysis toolkit for measuring material properties from 4D-STEM datasets, written in the Python language and released with an open-source license. We describe the algorithmic steps for dataset calibration and various 4D-STEM property measurements in detail and present results from several experimental datasets. We also implement a simple and universal file format appropriate for electron microscopy data in py4DSTEM, which uses the open-source HDF5 standard. We hope this tool will benefit the research community and help improve the standards for data and computational methods in electron microscopy, and we invite the community to contribute to this ongoing project."
authors:
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Savitzky
    given-names: "Benjamin H."
  -
    affiliation: "Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Zeltmann
    given-names: "Steven E. "
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Hughes
    given-names: "Lauren A."
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Brown
    given-names: "Hamish G."
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA and Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Zhao
    given-names: Shiteng
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA and Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Pelz
    given-names: "Philipp M."
  -
    affiliation: "Institut für Physik, Humboldt-Universität zu Berlin, Newtonstraße 15, 12489 Berlin, Germany"
    family-names: Pekin
    given-names: "Thomas C."
  -
    affiliation: "Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Barnard
    given-names: "Edward S."
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Donohue
    given-names: Jennifer
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: "Rangel DaCosta"
    given-names: Luis
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Kennedy
    given-names: Ellis
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Xie
    given-names: Yujun
  -
    affiliation: "Los Alamos National Laboratory, Los Alamos, NM 87545, USA"
    family-names: Janish
    given-names: "Matthew T."
  -
    affiliation: "Los Alamos National Laboratory, Los Alamos, NM 87545, USA"
    family-names: Schneider
    given-names: "Matthew M."
  -
    affiliation: "Toyota Research Institute, Los Altos, CA 94022, USA"
    family-names: Herring
    given-names: Patrick
  -
    affiliation: "Toyota Research Institute, Los Altos, CA 94022, USA"
    family-names: Gopal
    given-names: Chirranjeevi
  -
    affiliation: "Toyota Research Institute, Los Altos, CA 94022, USA"
    family-names: Anapolsky
    given-names: Abraham
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Dhall
    given-names: Rohan
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Bustillo
    given-names: "Karen C."
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Ercius
    given-names: Peter
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Scott
    given-names: "Mary C."
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Ciston
    given-names: Jim
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA Department of Materials Science and Engineering, University of California, Berkeley, CA 94720, USA"
    family-names: Minor
    given-names: "Andrew M."
  -
    affiliation: "National Center for Electron Microscopy, Molecular Foundry, Lawrence Berkeley National Laboratory, 1 Cyclotron Road, Berkeley, CA 94720, USA"
    family-names: Ophus
    given-names: Colin
title: "py4DSTEM: A Software Package for Four-Dimensional Scanning Transmission Electron Microscopy Data Analysis"
version: 0.12.6
doi: 10.1017/S1431927621000477
date-released: 2021-05-21

GitHub Events

Total
  • Issues event: 1
  • Watch event: 2
  • Issue comment event: 19
  • Push event: 4
  • Pull request event: 13
  • Fork event: 1
Last Year
  • Issues event: 1
  • Watch event: 2
  • Issue comment event: 19
  • Push event: 4
  • Pull request event: 13
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Yudai256 (1)
  • sezelt (1)
Pull Request Authors
  • sezelt (18)
  • GeriTopore (1)
  • edwinsupple (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 173 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 15
  • Total maintainers: 1
pypi.org: py4d-browser

A 4D-STEM data browser built on py4DSTEM.

  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 173 Last month
Rankings
Dependent packages count: 7.2%
Average: 22.1%
Dependent repos count: 37.0%
Maintainers (1)
Last synced: 7 months ago

Dependencies

.github/workflows/black.yml actions
  • actions/checkout v3 composite
  • psf/black stable composite
pyproject.toml pypi
  • PyQt5 >= 5.10
  • emdfile >= 0.0.11
  • h5py *
  • matplotlib >= 3.2.2
  • numpy >= 1.19
  • py4dstem >= 0.14.3
  • pyqtgraph >= 0.11