Commit 7f73d2bc authored by Thomas Vincent's avatar Thomas Vincent

add sample code

parent e09b5c0c
......@@ -13,16 +13,48 @@ It provides:
============================================
.. automodule:: xsocs.process.merge
:members: merge_scan_data
:func:`~xsocs.process.merge.merge_scan_data`
--------------------------------------------
.. autofunction:: merge_scan_data
Sample Code
-----------
.. literalinclude:: ../../xsocs/examples/id01_merge.py
:lines: 31-
:mod:`xsocs.process.qspace`: QSpace conversion
==============================================
.. automodule:: xsocs.process.qspace
:members: kmap_2_qspace
:func:`~xsocs.process.qspace.kmap_2_qspace`
-------------------------------------------
.. autofunction:: kmap_2_qspace
Sample Code
-----------
.. literalinclude:: ../../xsocs/examples/id01_qspace.py
:mod:`xsocs.process.fit`: Fit/COM
=================================
.. automodule:: xsocs.process.fit
:members: PeakFitter, FitTypes, BackgroundTypes
:class:`~xsocs.process.fit.PeakFitter`
--------------------------------------
.. autoclass:: PeakFitter
.. autoclass:: FitTypes
.. autoclass:: BackgroundTypes
Sample Code
-----------
.. literalinclude:: ../../xsocs/examples/id01_peak.py
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