Skip to content
Snippets Groups Projects
Commit c18c06bc authored by Owen Arnold's avatar Owen Arnold
Browse files

refs #24078. Update documentation.

parent 496c4612
No related branches found
No related tags found
No related merge requests found
...@@ -620,7 +620,7 @@ void LoadEventNexus::loadEntryMetadata(const std::string &nexusfilename, T WS, ...@@ -620,7 +620,7 @@ void LoadEventNexus::loadEntryMetadata(const std::string &nexusfilename, T WS,
} }
file.closeData(); file.closeData();
} catch (::NeXus::Exception &) { } catch (::NeXus::Exception &) {
// let it drop on floor // Nexus format does not require a run_number to be present
} }
if (!run.empty()) { if (!run.empty()) {
......
...@@ -25,10 +25,18 @@ also loaded using :ref:`LoadNexusLogs <algm-LoadNexusLogs>`. ...@@ -25,10 +25,18 @@ also loaded using :ref:`LoadNexusLogs <algm-LoadNexusLogs>`.
**Monitors** are loaded using :ref:`LoadNexusMonitors **Monitors** are loaded using :ref:`LoadNexusMonitors
<algm-LoadNexusMonitors>`. <algm-LoadNexusMonitors>`.
**Instrument geometry** is loaded using :ref:`LoadIDFFromNexus **Instrument geometry**
<algm-LoadIDFFromNexus>`. If the instrument geometry is not in the
file :ref:`LoadInstrument <algm-LoadInstrument>` is used.
There are a series of approaches for extracting the instrument geometry.
These follow the escalation path as follows:
- Tries to load embedded instrument_xml from the NXinstrument if present
using :ref:`LoadIDFFromNexus <algm-LoadIDFFromNexus>`.
- Else tries to load embedded nexus geometry from the NXinstrument if present
- Else tries to load the instrument using the name extracted from NXinstrument
The latter two possibilities are achieved via
:ref:`LoadInstrument <algm-LoadInstrument>`
Optional properties Optional properties
################### ###################
......
...@@ -27,7 +27,10 @@ Logging ...@@ -27,7 +27,10 @@ Logging
Nexus Geometry Loading Nexus Geometry Loading
---------------------- ----------------------
:ref:`LoadEmptyInstrument <algm-LoadEmptyInstrument>` will now load instrument geometry from hdf5 `NeXus <https://www.nexusformat.org/>`_ format files. Files consistent with the standard following the introduction of `NXoff_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXoff_geometry.html>`_ and `NXcylindrical_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXcylindrical_geometry.html>`_ will be used to build the entire in-memory instrument geometry within Mantid. This IDF-free route is primarily envisioned for the ESS. This marks the completion of the first phase in the feasibility and rollout of support for the new format. Over coming releases we will be expanding our support for the NeXus geometry both across Loading and Saving algorithms. While dependent on the instrument, we are overall seeing significant improvements in instrument load times over loading from equivalent IDF based implementations. :ref:`LoadEmptyInstrument <algm-LoadEmptyInstrument>` will now load instrument geometry from hdf5 `NeXus <https://www.nexusformat.org/>`_ format files. Files consistent with the standard following the introduction of `NXoff_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXoff_geometry.html>`_ and `NXcylindrical_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXcylindrical_geometry.html>`_ will be used to build the entire in-memory instrument geometry within Mantid. This IDF-free route is primarily envisioned for the ESS. While dependent on the instrument, we are overall seeing significant improvements in instrument load times over loading from equivalent IDF based implementations. :ref:`LoadInstrument <algm-LoadInstrument>` also supports the nexus geometry format in the same was as LoadEmptyInstrument.
The changes above have also been encorporated directly into :ref:`LoadEventNexus <algm-LoadEventNexus>`, so it is possible to store data and geometry together for the first time in a NeXus compliant format for Mantid. These changes have made it possible to load experimental ESS event data files directly into Mantid.
Archive Searching / ONCat Archive Searching / ONCat
------------------------- -------------------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment