Skip to content

Commit 0808b4c

Browse files
committed
Recategorise some application definitions for #1602
Move tomography definitions to a new imaging category and move scattering definitions to diffraction
1 parent 72448f0 commit 0808b4c

File tree

4 files changed

+47
-54
lines changed

4 files changed

+47
-54
lines changed

dev_tools/docs/nxdl_index.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
}
1616

1717
SOURCE_TO_GROUPING = {
18-
"applications": ["apm", "diff", "em", "mpes", "optical-spectroscopy", "sas", "tof"],
18+
"applications": ["apm", "diff", "em", "imaging", "mpes", "optical-spectroscopy", "tof"],
1919
"base_classes": [
2020
"core",
2121
"tech",
@@ -262,16 +262,16 @@ def get_nxclass_description(nxdl_file: Path, namespaces) -> str:
262262
263263
:ref:`Atom Probe Microscopy <AppDef-Apm-Structure>`
264264
265-
:ref:`Diffraction Techniques <AppDef-Diff-Structure>`
265+
:ref:`Diffraction & Scattering Techniques <AppDef-Diff-Structure>`
266266
267267
:ref:`Electron Microscopy <AppDef-Em-Structure>`
268268
269+
:ref:`Imaging Techniques <AppDef-Imaging-Structure>`
270+
269271
:ref:`Multi-Dimensional Photoemission Spectroscopy <AppDef-Mpes-Structure>`
270272
271273
:ref:`Optical Spectroscopy <AppDef-Opt-Spec-Structure>`
272274
273-
:ref:`Scattering Techniques <AppDef-Sas-Structure>`
274-
275275
:ref:`Time-of-Flight Techniques <AppDef-Tof-Structure>`
276276
""",
277277
# - - - - - - - - - - - - - - - - - - - - - - - - - - - -

manual/source/classes/applications/diff-structure.rst

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _AppDef-Diff-Structure:
22

3-
==================================
4-
Diffraction Techniques
5-
==================================
3+
===================================
4+
Diffraction & Scattering Techniques
5+
===================================
66

77
.. index::
88
AppDef-Diff-Introduction
@@ -13,7 +13,7 @@ Diffraction Techniques
1313
Introduction
1414
############
1515

16-
Application definitions for different diffraction techniques
16+
Application definitions for different diffraction and (small-angle) scattering techniques
1717

1818
.. _AppDef-Diff-Definitions:
1919

@@ -29,17 +29,6 @@ Application Definitions
2929
:ref:`NXmonopd`
3030
Monochromatic Neutron and X-Ray Powder diffractometer.
3131

32-
:ref:`NXtomo`
33-
This is the application definition for x-ray or neutron tomography raw data.
34-
35-
:ref:`NXtomophase`
36-
This is the application definition for x-ray or neutron tomography raw data
37-
with phase contrast variation at each point.
38-
39-
:ref:`NXtomoproc`
40-
This is an application definition for the final result of a tomography experiment:
41-
a 3D construction of some volume of physical properties.
42-
4332
:ref:`NXxbase`
4433
This definition covers the common parts of all monochromatic single crystal raw data application definitions.
4534

@@ -61,6 +50,11 @@ Application Definitions
6150
:ref:`NXxrot`
6251
Raw data from a rotation camera, extends :ref:`NXxbase`.
6352

64-
53+
:ref:`NXcanSAS`
54+
Implementation of the canSAS standard to store reduced small-angle scattering data of any dimension.
55+
56+
:ref:`NXsas`
57+
Raw, monochromatic 2-D SAS data with an area detector.
6558

66-
59+
:ref:`NXsastof`
60+
Raw 2-D SAS data with an area detector with a time-of-flight source.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _AppDef-Imaging-Structure:
2+
3+
==================
4+
Imaging Techniques
5+
==================
6+
7+
.. index::
8+
AppDef-Imaging-Introduction
9+
AppDef-Imaging-Definitions
10+
11+
.. _AppDef-Imaging-Introduction:
12+
13+
Introduction
14+
############
15+
16+
Application definitions for imaging techniques
17+
18+
.. _AppDef-Imaging-Definitions:
19+
20+
Application Definitions
21+
#######################
22+
23+
:ref:`NXtomo`
24+
This is the application definition for x-ray or neutron tomography raw data.
25+
26+
:ref:`NXtomophase`
27+
This is the application definition for x-ray or neutron tomography raw data
28+
with phase contrast variation at each point.
29+
30+
:ref:`NXtomoproc`
31+
This is an application definition for the final result of a tomography experiment:
32+
a 3D construction of some volume of physical properties.

manual/source/classes/applications/sas-structure.rst

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)