Commit ee9e347f authored by Henri Payno's avatar Henri Payno
Browse files

[doc] update orange add-on documentation

parent c258a042
......@@ -44,15 +44,33 @@ Orange Widgets
.. the orange widgets section has to be stored here to fit the orange requirement (and accessing the help from orange-canvas)
This is the list of actual widgets/boxes proposed by the workflow tool:
This is the list of generic util Orange widget:
.. toctree::
:maxdepth: 1
widgets/pymca_exafs.rst
widgets/pymca_ft.rst
widgets/pymca_k_weight.rst
widgets/pymca_normalization.rst
widgets/xas_converter.rst
widgets/xas_roi.rst
widgets/xas_input.rst
widgets/xas_output.rst
Here the list of Pymca process available from the Orange add-on:
.. toctree::
:maxdepth: 1
widgets/pymca/exafs.rst
widgets/pymca/ft.rst
widgets/pymca/k_weight.rst
widgets/pymca/normalization.rst
Here the list of Larch process available from the Orange add-on:
.. toctree::
:maxdepth: 1
widgets/larch/autobk.rst
widgets/larch/mback.rst
widgets/larch/mback_norm.rst
widgets/larch/pre_edge.rst
widgets/larch/xftf.rst
......@@ -52,7 +52,7 @@ Original functions goals:
| | | (post_edge background function) | |
+-----------------------------+----------------------+---------------------------------------------------------------+----------------------------------+
| xftf | | Forward XAFS Fourier transforms | YES |
| | | orward Fourier transform converts :math:`\chi(k)` to | |
| | | forward Fourier transform converts :math:`\chi(k)` to | |
| | | :math:`\chi(R)` and is of primary importance for XAFS analysis| |
+-----------------------------+----------------------+---------------------------------------------------------------+----------------------------------+
| xftr | | Reverse XAFS Fourier transforms | NO |
......
autobk
======
Background subtraction, convert mu to :math:`\chi(k)` for quantitative analysis (post_edge background function)
\ No newline at end of file
mback
=====
data are matched to the tabulated values of the imaginary part of the energy-dependent correction to the Thompson scattering factor.
mback norm
==========
TODO
\ No newline at end of file
pre edge
========
Pre-edge subtraction and normalization:
- fit a line of polynomial to the region below the edge
- determine E0
- fit a polynomial to the region above the edge
- extrapolate the two curves to E0 to determine the edge
xftf
====
Forward XAFS Fourier transforms forward Fourier transform converts :math:`\chi(k)` to :math:`\chi(R)` and is of primary importance for XAFS analysis.
\ No newline at end of file
......@@ -3,4 +3,4 @@ PyMca exafs
TODO
.. image:: img/pymca_exafs.png
.. image:: ../img/pymca_exafs.png
PyMca Fourier Transform
=======================
TODO
Fourier transform
.. image:: img/pymca_ft.png
.. image:: ../img/pymca_ft.png
......@@ -3,4 +3,4 @@ PyMca k weight
TODO
.. image:: img/pymca_kweight.png
.. image:: ../img/pymca_kweight.png
PyMca normalization
===================
TODO
Spectra normalization:
.. image:: img/pymca_normalization.png
.. image:: ../img/pymca_normalization.png
converter xas_obj -> Table
==========================
Convert a xas_obj to a Orange.data.Table
It will only convert energy and absorption beam spectra.
Other information (treatment results, process flow...) will be lost.
......@@ -22,7 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to the larch mback process"""
"""wrapper to the larch autobk process"""
from xas.core.types import Spectrum, XASObject
from xas.core.process.process import Process
......
Supports Markdown
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