Commit 2508141a authored by Thomas Vincent's avatar Thomas Vincent

update project tree doc

parent d852114d
.. _project_tree:
Project tree view
-----------------
Once loaded, the main window will display the contents of the project.
Once a project is loaded, the main window displays its content as a tree with different groups.
.. |project_tree| image:: img/project_tree.png
.. |intensity_plot_button| image:: img/intensity_plot_button.png
.. |qspace_view_button| image:: img/qspace_view_button.png
.. |fit_results_button| image:: img/fit_results_button.png
.. |export_fit_button| image:: img/export_fit_button.png
+-------------------+
| Project tree view |
+===================+
| |project_tree| |
+-------------------+
.. figure:: img/project_tree.png
:align: center
:width: 50%
Project tree view
Acquisition group
.................
......@@ -28,62 +26,54 @@ Intensity group
The ``Intensity`` item represents the cumulated acquired intensity.
You can open the :ref:`intensity view <intensity_view>` by clicking on the
plot button |intensity_plot_button| next to it.
You can open the :ref:`intensity view <intensity_view>` by clicking on the |intensity_plot_button| button on the same row.
QSpace group
............
The ``QSpace`` group contains all the Q space items. After a new Q space has
been created from the :ref:`intensity view <intensity_view>` it will be added
to this QSpace group.
The ``QSpace`` group contains the results of all Q space conversions.
.. _qspace_item:
Once a Q space has been created from the :ref:`intensity view <intensity_view>` it is accessible from here.
.. _qspace_item:
QSpace item
***********
The ``QSpace`` item represents a single QSpace. It contains:
The ``QSpace`` item represents a single Q space.
It contains:
* An ``Infos`` node, which gives you the parameters that were used when converting images to Q space.
* an ``Infos`` node, which gives you the parameters that were used when converting from sample space to Q space.
* A :ref:`fits group <fit_group>` that contains all the fit results for this Q space.
* a :ref:`fit group <fit_group>` that contains all the fit results for that qspace.
You can open the :ref:`qspace view <qspace_view>` by clicking on the |qspace_view_button| button on the same row.
You can open the :ref:`qspace view <qspace_view>` by clicking on the
button |qspace_view_button| next to it.
Q space items can be deleted by selecting them and pressing the delete key.
They can be renamed by double clicking on them (the actual file is not renamed).
To reset the name just set its name to an empty string.
Qspace items can be individualy deleted by either selecting them and pressing
the delete key. They can be renamed (the actual file is not renamed) by double
clicking on them. To reset the name just set its name to an empty string.
There is also a context menu from which you can delete and rename the item,
open the folder containing the file, or copy the file path to clipboard.
Q space items also provides a context menu.
.. _fit_group:
Fits group
..........
Fit group
.........
The ``fits`` group contains results for all fits or center of mass run on a given Q space.
The ``fits`` group contains all the fits run on a given Q space. After a new
fit has been performed from the
:ref:`qspace view <qspace_view>` it will be added to this group.
Once a fit has been performed from the :ref:`qspace view <qspace_view>` it is accessible from this group.
.. _fit_item:
Fit Item
********
The ``Fit`` item represents fit results.
The ``Fit`` item represents fit or center-of-mass results.
You can open the :ref:`fit results <fit_view>` view by clicking on the
view button |fit_results_button| next to it.
You can open the :ref:`fit results <fit_view>` view by clicking on the |fit_results_button| button on the same row.
You can also export the results to a CSV file by clicking on the export button
|export_fit_button|.
You can also export the results to a CSV file by clicking on the |export_fit_button| button on the same row.
As for :ref:`Q space items <qspace_item>`, Fit items can be deleted by selecting them and pressing the delete key.
They can be renamed by double clicking on them (the actual file is not renamed).
To reset the name just set its name to an empty string.
Just like :ref:`Q space items <qspace_item>`, Fit items can be individualy
deleted by either selecting them and pressing the delete key. They can be
renamed (the actual file is not renamed) by double clicking on them.
To reset the name just set its name to an empty string. There is also a context
menu from which you can delete and rename the item, open the folder
containing the file, or copy the file path to clipboard.
Fit items also provides a context menu.
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