Skip to content

Latest commit

 

History

History
139 lines (103 loc) · 10.6 KB

GSAImage_SPD_v1.2.0.md

File metadata and controls

139 lines (103 loc) · 10.6 KB

nanoMFG Software Planning Document

Graphene SEM Image Analysis: GSAImage

Target Release: 1.2.0 : July 31, 2019

Development Team

Name Role github user nanohub user email status
Elif Ertekin PI elifleaf Elif Ertekin ertekin@illinois.edu active
Sameh Tawfick PI tawfick --- tawfick@illinois.edu active
Joshua Schiller developer jaschil2 Joshua A Schiller jaschil2@illinois.edu active
Kevin Liu developer kevindl2 --- kevindl2@illinois.edu inactive
Darren Adams developer dadamsncsa Darren K Adams dadams@illinois.edu active
Bomsaerah Seong developer bsrseong --- bseong2@illinois.edu active
Kevin Cruse developer kevcruse96 Kevin James Cruse kevcruse96@gmail.com active

nanoMFG Github Team(s): @GSA-dev

nanoHUB Group(s): Gr-ResQ

1. Introduction

GSAImage allows users to extract relevant data from SEM images using various analysis techniques. The current iteration of the tool will include improvements in processing speed, cosmetics, and documentation on available analysis techniques. This image analysis tool will be released as a standalone tool as well as a feature of the Gr-ResQ (Graphene Recipes for the Synthesis of High Quality Materials) database suite.

1.1 Purpose and Vision Statement

SEM images are one of the primary resources for graphene synthesis analysis. GSAImage will permit users to extract information from these SEM images like graphene coverage, domain density, and domain alignment. These features will inform users and augment machine learning on the data by providing it with objective metrics to optimize. This tool will be released as a standalone research tool and as a feature of the "gresq" graphene synthesis database dashboard.

1.2 References

GSAImage README page

2 Overview and Major Planned Features

Version 1.2.0 of GSAImage will include features related to user experience as well as improved scientific analysis of SEM images. In addition, a user manual with intuitive screenshots will be included for user instruction.

2.1 Product Background and Strategic Fit

Gr-ResQ Tool Flow (SEM Image Tool Highlighted)

This release of GSAImage represents the next version of an already published nanoHUB tool. This version of GSAImage will also be included as an analysis feature with the Gr-ResQ database tool suite. Flow for the component tools in the Gr-ResQ tool suite is shown above. The SEM image analysis tool is included as an analysis feature to study SEM images associated with various graphene recipes.

2.2 Scope and Limitations for Current Release

Release Notes v1.2.0

Planned Features
Feature Description
Saving/Uploading Work done during analysis can be saved and loaded within the tool environment
Domain edge detection Canny edge detection and pattern filtering techniques are available for users to detect boundaries on graphene domains.
Domain coverage Tool will calculate area of graphene domain using reasonable scale. Functions DrawScale and DomainCenters provided to aide in area calculation
Domain center determination See Domain coverage (DomainCenters used to maker graphene domain centers)
Exportation of domain coverage features Provide "Export State" option for users to access useful data after using GSAImage
Create user manual User manual will be available for tutorials and as extensive resource
Display original image during analysis Original image will be continually displayed for comparison while analysis manipulations and adjustments are made by user
Provide example images Example images will be provided by Gr-ResQ team for novice users to test tool
Improve "Erase" tool Erase tool will include clearly visible marker and size indicator
Improve figure shapes in "Filter Pattern" tool Graphene is filtered from substrate in images using template matching. Previous release of GSAImage showed difficulty in fully covering graphene domains with template matching filter (shown in image below, parts of graphene domain are not covered by filter); Current release will include improved template matching functionality
Change color in "Find Contour" line Resultant shapes in "Find Contour" tool will be more clearly indicated to user using contrasting color and boldness
Not Done

2.3 Scope and Limitations for Subsequent Releases

Feature Description
Improve template matching Further work needs to be done to speed up custom masks for the template matching tool
Improve alignment tool The alignment tool needs to be fleshed out a little more.

2.3 Operating Environment

Program uses pyqt in the python environment

2.4 Design and Implementation Constraints

  • skimage
  • opencv
  • scipy
  • numpy
  • pyqtgraph

3 User Interaction and Design

3.1 Classes of Users

Type Access Level Features Used Experience Level Type of Interaction
Community User All All Novice Used for own research
nanoMFG User All All Experienced Used for generating data for Gr-ResQ database

3.2 User Requirements

3.3 Proposed User Interface

Opening user interface for current release of GSAImage GSAImage with SEM file opened Example of analysis done on image (Filter Pattern)

4. Data And Quality Attributes

4.1 Data Dictionary

4.2 Usability and Performance

4.3 Testing, Verification and Validation

4.4 Uncertainty Quantification