Skip to content
Snippets Groups Projects
Normal view Permalink
README.rst 1.07 KiB
Newer Older
nlaanait's avatar
Minor changes. See TODO list for potential python import issues.  
nlaanait committed
1 
pycroscopy
nlaanait's avatar
first upload
nlaanait committed
2 3 
==========
nlaanait's avatar
Update README.md  
nlaanait committed
4 
See <https://pycroscopy.github.io/pycroscopy/> for more info.
nlaanait's avatar
Update README.md  
nlaanait committed
5
nlaanait's avatar
Update README.md  
nlaanait committed
6 
0. Description
nlaanait's avatar
Minor changes. See TODO list for potential python import issues.  
nlaanait committed
7 
--------------
nlaanait's avatar
first upload
nlaanait committed
8 9 10 11 
A python package for image processing and scientific analysis of imaging modalities such as multi-frequency scanning probe microscopy,
scanning tunneling spectroscopy, x-ray diffraction microscopy, and transmission electron microscopy.
Classes implemented here are ported to a high performance computing platform at Oak Ridge National Laboratory (ORNL).
nlaanait's avatar
Update README.md  
nlaanait committed
12 
1. Package Structure
nlaanait's avatar
Minor changes. See TODO list for potential python import issues.  
nlaanait committed
13 
--------------------
nlaanait's avatar
Update README.md  
nlaanait committed
14 15 16 17 18 19 20 
The package structure is simple, with 4 main modules:
   1. `io`: Input/Output from custom & proprietary microscope formats to HDF5.
   2. `processing`: Multivariate Statistics, Machine Learning, and Filtering.
   3. `analysis`: Model-dependent analysis of image information.
   4. `viz`: Visualization and interactive slicing of high-dimensional data by lightweight Qt viewers.

Once a user converts their microscope's data format into an HDF5 format, by simply extending some of the classes in `io`, the user gains access to the rest of the utilities present in `pycroscopy.*`.