Skip to content

Commit

Permalink
Rename Data Manipulation interface to Inelastic Data Processor
Browse files Browse the repository at this point in the history
  • Loading branch information
robertapplin committed Jun 4, 2024
1 parent 371fa98 commit 389e6a1
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 25 deletions.
10 changes: 5 additions & 5 deletions docs/source/interfaces/indirect/Indirect Settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ Glossary of Allowed Suffixes
+--------------+------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| _Corrections | EnergyTransfer (:math:`meV`) | Spectrum Number | :ref:`Data Corrections <interface-inelastic-corrections>` in CalculatePaalmanPings or CalculateMonteCarloAbsorption |
+--------------+------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| _eq | Q (:math:`A^-1`) | Sample Environment variable (e.g. Temperature) | :ref:`Data Manipulation <interface-inelastic-data-manipulation>` in Elwin |
| _eq | Q (:math:`A^-1`) | Sample Environment variable (e.g. Temperature) | :ref:`Data Processor <interface-inelastic-data-manipulation>` in Elwin |
+--------------+------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| _elf | Intensity | Q (:math:`A^-1`) | :ref:`Data Manipulation <interface-inelastic-data-manipulation>` in Elwin |
| _elf | Intensity | Q (:math:`A^-1`) | :ref:`Data Processor <interface-inelastic-data-manipulation>` in Elwin |
+--------------+------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| _iqt | Time (:math:`ns`) | Spectrum Number or Q (:math:`A^-1`) | :ref:`Data Manipulation <interface-inelastic-data-manipulation>` in I(Q,t) |
| _iqt | Time (:math:`ns`) | Spectrum Number or Q (:math:`A^-1`) | :ref:`Data Processor <interface-inelastic-data-manipulation>` in I(Q,t) |
+--------------+------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| _Result | Q (:math:`A^-1`) | Fit Parameter Name | :ref:`QENS Fitting <interface-inelastic-qens-fitting>` in MSDFit, IqtFit, ConvFit or F(Q)Fit |
+--------------+------------------------------+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -228,8 +228,8 @@ Transmission
############
No restrictions.

Data Manipulation Suffixes
~~~~~~~~~~~~~~~~~~~~~~~~~~
Data Processor Suffixes
~~~~~~~~~~~~~~~~~~~~~~~
Symmetrise
##########

Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
.. _interface-inelastic-data-manipulation:

Inelastic Data Manipulation
===========================
Inelastic Data Processor
========================

.. contents:: Table of Contents
:local:

Overview
--------

The Inelastic Data Manipulation interface provides Processes for manipulating
The Inelastic Data Processor interface provides processes for transforming
reduced data from, for example, :ref:`Indirect Data Reduction <interface-indirect-data-reduction>`
and Direct Reduction routines or S(Q, w). The output data can then be used for analysis by
processes in, for example, the :ref:`Inelastic QENS Fitting <interface-inelastic-qens-fitting>` and
:ref:`Inelastic Bayes Fitting <interface-inelastic-bayes-fitting>` interfaces.

.. interface:: Data Manipulation
.. interface:: Data Processor
:align: right
:width: 750

Expand Down Expand Up @@ -62,7 +62,7 @@ while in the negative side :math:`E_{low}` will be farther from the centre. The
is reflected about the Y axis and replaces the corresponding values in the positive side of the spectra.
The curve which ranges between :math:`\pm|E_{high}|` is not modified.

.. interface:: Data Manipulation
.. interface:: Data Processor
:widget: tabSymmetrise

Symmetrise Options
Expand Down Expand Up @@ -153,7 +153,7 @@ S(Q, w)
Provides an interface for running the :ref:`SofQW <algm-SofQW>` algorithm
:ref:`SofQWNormalisedPolygon <algm-SofQWNormalisedPolygon>`.

.. interface:: Data Manipulation
.. interface:: Data Processor
:widget: tabSQw

S(Q, w) Options
Expand Down Expand Up @@ -230,7 +230,7 @@ This interface uses the :ref:`SofQWMoments <algm-SofQWMoments>` algorithm to
calculate the :math:`n^{th}` moment of an :math:`S(Q, \omega)` workspace created
by the SofQW tab.

.. interface:: Data Manipulation
.. interface:: Data Processor
:widget: tabMoments

Moments Options
Expand Down Expand Up @@ -287,7 +287,7 @@ Mantid data search paths that contains the sample environment information the
ELF workspace can also be normalised to the lowest temperature run in the range
of input files.

.. interface:: Data Manipulation
.. interface:: Data Processor
:widget: tabElwin

Elwin Options
Expand Down Expand Up @@ -401,7 +401,7 @@ I(Q, t)
Given sample and resolution inputs, carries out a fit as per the theory detailed
in the :ref:`TransformToIqt <algm-TransformToIqt>` algorithm.

.. interface:: Data Manipulation
.. interface:: Data Processor
:widget: tabIqt

I(Q, t) Options
Expand Down
2 changes: 1 addition & 1 deletion docs/source/release/v6.10.0/Inelastic/Bugfixes/37321.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
- Fix a crash in the :ref:`Elwin Tab <elwin>` of the Data Manipulation Interface ocurring when all items of the table were selected with the keyboard and the clicked on `Remove Selected` button.
- Fix a crash in the :ref:`Elwin Tab <elwin>` of the Data Processor Interface ocurring when all items of the table were selected with the keyboard and the clicked on `Remove Selected` button.
- Add `Select All` push button on :ref:`Elwin Tab <elwin>` to select all rows when clicked.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- Added new workspace dialog widget with the capacity to select and open multiple compatible workspaces at once. For use in :ref:`Elwin Tab <elwin>` of :ref:`Data Manipulation Interface <interface-inelastic-data-manipulation>`
- Added new workspace dialog widget with the capacity to select and open multiple compatible workspaces at once. For use in :ref:`Elwin Tab <elwin>` of :ref:`Data Processor Interface <interface-inelastic-data-manipulation>`
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- The files tab of the :ref:`Elwin Tab <elwin>` of :ref:`Data Manipulation Interface <interface-inelastic-data-manipulation>` has been removed. Workspaces can still be added from files in the multifile dialog of the workspaces tab.
- The files tab of the :ref:`Elwin Tab <elwin>` of :ref:`Data Processor Interface <interface-inelastic-data-manipulation>` has been removed. Workspaces can still be added from files in the multifile dialog of the workspaces tab.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- On :ref:`Elwin Tab <elwin>` of :ref:`Data Manipulation Interface <interface-inelastic-data-manipulation>`, it is now possible to display in the workspace table either one row per spectra, or just one row per workspace.
- On :ref:`Elwin Tab <elwin>` of :ref:`Data Processor Interface <interface-inelastic-data-manipulation>`, it is now possible to display in the workspace table either one row per spectra, or just one row per workspace.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- The files tab of the :ref:`Elwin Tab <elwin>` of :ref:`Data Manipulation Interface <interface-inelastic-data-manipulation>` has been removed. Workspaces can still be added from files in the multifile dialog of the workspaces tab.
- The files tab of the :ref:`Elwin Tab <elwin>` of :ref:`Data Processor Interface <interface-inelastic-data-manipulation>` has been removed. Workspaces can still be added from files in the multifile dialog of the workspaces tab.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- A checkbox option is added in Data Manipulation with title "EnfoceNormalization". This option is set to True by default (no change to the current algorithms/workflow occurs). When it is set to False, the LHSWorkspace from the output from ExtractFFTSpectrum is used in both branches to perform the final workspace division and the two intermediate workspace divisions are skipped.
- A checkbox option is added in :ref:`Data Processor Interface <interface-inelastic-data-manipulation>` with title "EnforceNormalization". This option is set to True by default (no change to the current algorithms/workflow occurs). When it is set to False, the LHSWorkspace from the output from ExtractFFTSpectrum is used in both branches to perform the final workspace division and the two intermediate workspace divisions are skipped.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- The :ref:`ElasticWindowMultiple <algm-ElasticWindowMultiple>` algorithm will add the integration range to the output workspaces sample logs, calling it either from script or from the :ref:`Elwin Tab <elwin>` of :ref:`Data Manipulation Interface <interface-inelastic-data-manipulation>`.
- The :ref:`ElasticWindowMultiple <algm-ElasticWindowMultiple>` algorithm will add the integration range to the output workspaces sample logs, calling it either from script or from the :ref:`Elwin Tab <elwin>` of :ref:`Data Processor Interface <interface-inelastic-data-manipulation>`.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- The `Inelastic Data Manipulation` interface has been renamed to the :ref:`Inelastic Data Processor <interface-inelastic-data-manipulation>` interface. The new name provides a better description of what it does.
2 changes: 1 addition & 1 deletion docs/source/techniques/ApplyingCorrections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ algorithm in the :ref:`Inelastic Corrections <interface-inelastic-corrections>`
For sample and container chemical formula, we type `H2-O` and `Al`, respectively. Leaving all other parameters as default.
Running the algorithm we generate a corrections group workspace. This workspace can be used in the `Apply Absorption Corrections` tab of the interface
to generate a corrected reduced workspace.
The corrected reduced workspace can then be used to generate the :math:`S(Q, \omega)` profile from the `S(Q,w)` tab of the :ref:`Data Manipulation Interface <interface-inelastic-data-manipulation>`.
The corrected reduced workspace can then be used to generate the :math:`S(Q, \omega)` profile from the `S(Q,w)` tab of the :ref:`Data Processor Interface <interface-inelastic-data-manipulation>`.
A 3D plot of the generated workspace is shown below:

.. figure:: ../images/water_sqw_corrected_for_absorption.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ DataManipulationInterface::DataManipulationInterface(QWidget *parent) : Inelasti

DataManipulationInterface::~DataManipulationInterface() = default;

std::string DataManipulationInterface::documentationPage() const { return "Inelastic Data Manipulation"; }
std::string DataManipulationInterface::documentationPage() const { return "Inelastic Data Processor"; }

/**
* Called when the user clicks the Python export button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class DataManipulationInterface : public InelasticInterface {
/// Destructor
~DataManipulationInterface() override;
/// Interface name
static std::string name() { return "Data Manipulation"; }
static std::string name() { return "Data Processor"; }
// This interface's categories.
static QString categoryInfo() { return "Inelastic"; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
</rect>
</property>
<property name="windowTitle">
<string>Inelastic Data Manipulation</string>
<string>Inelastic Data Processor</string>
</property>
<widget class="QWidget" name="centralwidget">
<layout class="QVBoxLayout" name="verticalLayout_20">
Expand Down

0 comments on commit 389e6a1

Please sign in to comment.