HDF5 data selection
===================

.. image:: icons/upload_hdf5.svg

Description
-----------

Builds a Darfix dataset from raw data contained in a Bliss HDF5 file. 

This is done by selecting

- the HDF5 filename
- the URL where images are located in the HDF5 file
- the URL where motors are located in the HDF5 file

Optionally, dark data can be selected as well.

.. tip::

   If your data is stored in EDF files, you can convert them to HDF5 <../tutorials/edf_conversion.html>`_ before using this widget.


Signals
-------

**Outputs**:

- Dataset: output dataset


Tutorial
--------

1. Drag the widget on the canvas (if not already there) and double-click on it

.. image:: img/hdf5_data_selection/add_widget.png
   :width: 500 px

2. Select a file by typing its path in the **File selection** path in the **Raw data** or by clicking **Browse** button

.. image:: img/hdf5_data_selection/empty_widget.png
   :height: 380 px

3. The widget will fill automatically the **Scan number**, **Detector** and **Positioners** fields. You can select another scan by changing the **Scan number**, **Detector** and **Positioners** will update as well.

.. image:: img/hdf5_data_selection/filled_widget.png
   :height: 380 px

4. Once the correct scan number is selected, you can also choose different values for **Detector** and **Positioners** if the paths are not standard. This can be done either by changing the text fields or by clicking on the corresponding **Browse** buttons.

5. *Optional:* To select a file to be used as dark data, you can check the **Dark data** checkbox and select a file, scan number and detector as previously (no positioners are needed in this case).

.. image:: img/hdf5_data_selection/dark_data_enabled.png
   :height: 380 px

6. *Optional:* Supply a folder where data will be saved in further steps by changing the **Working directory** field

7. *Optional:* Give a **Workflow title**. This has no incidence on the processing.