index.rst 1.67 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.. pycroscopy documentation master file, created by
   sphinx-quickstart on Wed Sep 21 20:37:32 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pycroscopy's documentation!
======================================

0. Description
--------------
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).

1. Package Structure
--------------------
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.*`.

Contents:

.. toctree::

nlaanait's avatar
nlaanait committed
29
30
31
32
33
    pycroscopy.analysis
    pycroscopy.io
    pycroscopy.processing
    pycroscopy.tests
    pycroscopy.viz
34
35


nlaanait's avatar
nlaanait committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
pycroscopy.versioner module
---------------------------

.. automodule:: pycroscopy.versioner
    :members:
    :undoc-members:
    :show-inheritance:


Module contents
---------------

.. automodule:: pycroscopy
    :members:
    :undoc-members:
    :show-inheritance:
52
53