Commit e9c27d30 authored by Thomas Vincent's avatar Thomas Vincent

update QSpace conversion dialog doc

parent c9a9d48a
.. _conversion_window:
Qspace conversion window
========================
.. |conversion_dialog| image:: img/conversion_dialog.png
+--------------------+
| Intensity view |
+====================+
| |conversion_dialog||
+--------------------+
This window lets you configure some parameters and options for the
conversion from real space to qspace.
.. |xray_init_area| replace:: experiment.HXRD.Ang2Q
.. _xray_init_area: https://xrayutilities.sourceforge.io/xrayutilities.html#xrayutilities.experiment.HXRD.Ang2Q
+--------------------+--------------------------------------------------------+
| Parameter / option |
+====================+========================================================+
| ``Median filter`` | If checked and set to anything else than [1, 1] then a |
| | median filter will be applied to all images before |
| | conversion. |
| | |
| | .. warning:: if non empty pixels in your images are |
| | few and far between, you might loose to much |
| | information if a median filter is applied. |
+--------------------+--------------------------------------------------------+
| ``Grid dimensions``| dimensions of your qspace cube. |
+--------------------+--------------------------------------------------------+
When all is set, click on ``Convert`` to start the conversion. When the conversion
is done, the result file (hdf5) can be found at the location written in the
``output`` field.
\ No newline at end of file
Q space conversion dialog
=========================
.. figure:: img/conversion_dialog.png
:width: 100%
:align: center
Q space conversion dialog
This window lets you configure some parameters for the conversion from images to Q space:
- `Acq. Parameters`_
- `Image Processing Parameters`_
- `Q space Parameters`_
The right panel allows to review the selected region of interest on the sample and the selected scan entries.
Click on **Convert** to start the conversion.
Once the conversion is done, a :ref:`Q space item <qspace_item>` is added to the :ref:`project tree <project_tree>`.
And the result is displayed in the :ref:`Q sspace view <qspace_view>`.
Acq. Parameters
...............
.. list-table::
:widths: 1 4
:header-rows: 1
* - Parameter
- Description
* - ``Beam energy``
- Energy of the beam, in eV
* - ``Direct beam``
- Position in pixels of the direct beam on the detector
* - ``Ch. per deg.``
- Channels per degree
Image Processing Parameters
...........................
All image processing steps are optional, check the corresponding check box to enable them.
.. list-table::
:widths: 1 4
:header-rows: 1
* - Parameter
- Description
* - ``Maxipix correction``
- Apply Maxipix detector module edges correction
* - ``Mask``
- Select a mask image to apply on input images.
The image MUST have the same size as input detector images.
Non zero value in the mask image discard the corresponding pixels.
* - ``Normalization``
- Select the measurement to use for normalization.
* - ``Median filter``
- Set the size (**w**\ idth and **h**\ eight) of the median filter window.
Q space Parameters
..................
.. list-table::
:widths: 1 4
:header-rows: 1
* - Parameter
- Description
* - ``Grid dimensions``
- Number of bins for each dimension of the Q space histogram.
* - ``Coordinates``
- Select the coordinate system of the QSpace histogram.
Either **Cartesian** or **Spherical**.
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