Skip to content

application definitions on raw vs. processed data #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
woutdenolf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

application definitions on raw vs. processed data #1281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions dev_tools/docs/nxdl_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ProcessedData>`. 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": """
Expand Down