From faae1364c58437da1ea53e060338892ef25ca40a Mon Sep 17 00:00:00 2001 From: woutdenolf Date: Fri, 16 Jun 2023 18:46:43 +0200 Subject: [PATCH] application definitions on raw vs. processed data --- dev_tools/docs/nxdl_index.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/dev_tools/docs/nxdl_index.py b/dev_tools/docs/nxdl_index.py index 98f90b95bc..6395bae1c3 100644 --- a/dev_tools/docs/nxdl_index.py +++ b/dev_tools/docs/nxdl_index.py @@ -121,6 +121,14 @@ def get_nxclass_description(nxdl_file: Path, namespaces) -> str: In application definitions involving raw data, write the raw data in the :ref:`NXinstrument` tree and then link to it from the location(s) defined in the relevant application definition. + +Application definitions provide a data processing interface to raw data +as well as :ref:`processed data`. For example the :ref:`NXtomoproc` +application definition is typically (but not necessarily) an interface +to the result of processing :ref:`NXtomo`. The :ref:`NXreflections` application +definition is typically (but not necessarily) an interface to the result of +processing :ref:`NXmx`. The application definitions :ref:`NXtomo` and :ref:`NXmx` +in turn are typically (but not necessarily) interfaces to raw data. """, # - - - - - - - - - - - - - - - - - - - - - - - - - - - - "contributed_definitions": """