Commit e09b5c0c authored by Thomas Vincent's avatar Thomas Vincent

Add doc of helper API

parent de2e1590
......@@ -14,6 +14,7 @@ films, surfaces or even embedded structures.
install.rst
using.rst
tutorials.rst
modules.rst
troubleshooting.rst
:doc:`install`
......@@ -25,6 +26,9 @@ films, surfaces or even embedded structures.
:doc:`tutorials`
Video tutorials
:doc:`modules`
Documentation of the script API
:doc:`troubleshooting`
When things do not work as expected
......
===============
API Reference
===============
X-SOCS data processing is implemented in the :mod:`xsocs.process` package.
It provides:
- Merge SPEC+EDF to HDF5: :mod:`xsocs.process.merge`
- Q Space Conversion: :mod:`xsocs.process.qspace`
- Fit/COM: :mod:`xsocs.process.fit`
:mod:`xsocs.process.merge`: SPEC+EDF to HDF5
============================================
.. automodule:: xsocs.process.merge
:members: merge_scan_data
:mod:`xsocs.process.qspace`: QSpace conversion
==============================================
.. automodule:: xsocs.process.qspace
:members: kmap_2_qspace
:mod:`xsocs.process.fit`: Fit/COM
=================================
.. automodule:: xsocs.process.fit
:members: PeakFitter, FitTypes, BackgroundTypes
......@@ -22,9 +22,14 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""Fit/Center-of-Mass QSpace reduction processing
"""This module provides Gaussian fit/Center-of-Mass QSpace reduction processing
The class :class:`PeakFit` implements it with multiprocessing
It provides the :class:`PeakFitter` class to run QSpace histogram projection
on the axes and either a gaussian fit or Center-of-mass with optional
background subtraction.
- :class:`FitTypes`: QSpace reduction modes
- :class:`BackgroundTypes`: Background subtraction modes
"""
__authors__ = ["D. Naudet"]
......
......@@ -22,6 +22,10 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""This module provides the API to convert SPEC+EDF to HDF5 files.
It provides a helper function :func:`merge_scan_data` to perform the merge.
"""
from __future__ import absolute_import
......
......@@ -86,10 +86,9 @@ def merge_scan_data(output_dir,
folder pointed to by output_dir.
:type master_f: *optional* str
:param img_dir: directory path. If provided the image files will be
:param str img_dir: directory path. If provided the image files will be
looked for into that folder instead of the one found in the scan
headers.
:type img_dir: *optional* str
:param Union[int,None] n_proc:
Number of threads to use when merging files.
......
......@@ -22,7 +22,10 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""This modules provides the API to convert image stacks to QSpace histogram
It provides a helper function :func:`kmap_2_qspace` to run the conversion
"""
from __future__ import absolute_import
__authors__ = ["D. Naudet"]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment