Commit 0d195a0d authored by Thomas Vincent's avatar Thomas Vincent

Update description of fit results

parent e1bdf86e
......@@ -70,21 +70,10 @@ Three options are available for background subtraction:
* **Snip**: Statistics-sensitive Non-linear Iterative Peak-clipping background estimation algorithm.
See `snip1d implementation documentation <http://www.silx.org/doc/silx/latest/modules/math/fit/filters.html?highlight=snip1d#silx.math.fit.snip1d>`_ for details and references.
Fit parameters
Fit/COM method
..............
Two options are available:
Two methods are available:
* **Gaussian**: Fits a single gaussian function on the Q space projected on each axes.
Results returned are:
* Area
* Center position
* Width
* **Centroid**: Computes the center of mass and maximum. Results are:
* Center of mass
* Integrated intensity
* Maximum position
* Maximum intensity
* **Centroid**: Computes the center of mass and maximum.
.. _fit_view:
Fit/COM Results View
====================
.. figure:: img/fit_results_view.png
:width: 100%
:align: center
Fit/COM results view
This view displays the results generated by the **fit/COM** process.
The left panel shows a preview of the results.
Each of those "preview" thumbnails can be dragged and dropped to one of the scatter plots in the center of the window (in the **Maps** panel).
After selecting a map to display, points can be selected by clicking on the scatter plot.
The results along each Q space axis will then be displayed on the three plots on the right (in the **Fit** panel).
Right panel plots legends:
Gaussian fit results
--------------------
.. figure:: img/fit_results_view.png
:width: 100%
:align: center
Gaussian fit results view
Available results are:
* **Area**
* **Center** position
* **Sigma**: Standard deviation
The corresponding legends of the right panel plots are:
* **Blue dashed curve**: Integrated intensity on the whole Q space
* **Blue solid curve**: Integrated intensity in the Q space ROI (only when a ROI is set)
* **Dark dashed curve**: Background (only if background is used)
* **Red solid curve**: Fitted gaussian (+ background)
Centroid/Max results
--------------------
.. figure:: img/com_results_view.png
:width: 100%
:align: center
Center-of-mass/Max results view
Available results are:
* **COM**: Center of mass
* **I_max**: Maximum intensity
* **I_sum**: Integrated intensity
* **Pos_max**: Position of maximum
The corresponding legends of the right panel plots are:
* **Blue dashed curve**: Integrated intensity on the whole Q space
* **Blue solid curve**: Integrated intensity in the Q space ROI (only when a ROI is set)
* **Dark dashed curve**: Background (only if background is used)
* **Red solid curve**: Fitted gaussian (only for gaussian fit results)
* **Vertical black line**: centroid position (only for centroid results)
* **Vertical gray line**: maximum position (only for centroid results)
* **Vertical black line**: centroid position
* **Vertical gray line**: maximum position
\ No newline at end of file
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