.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXtomo.nxdl.xml -- DO NOT EDIT .. index:: ! NXtomo (application definition) ! tomo (application definition) see: tomo (application definition); NXtomo .. _NXtomo: ====== NXtomo ====== .. Contributors List .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Russ Berg|RussBerg|https://avatars.githubusercontent.com/u/4698891?v=4|2020-11-05 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: This is the application definition for x-ray or neutron tomography raw data. ... This is the application definition for x-ray or neutron tomography raw data. In tomography a number of dark field images are measured, some bright field images and, of course the sample. In order to distinguish between them images carry a image_key. **Symbols**: These symbols will be used below to coordinate datasets with the same shape. **nFrames**: Number of frames **xSize**: Number of pixels in X direction **ySize**: Number of pixels in Y direction **Groups cited**: :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXsample`, :ref:`NXsource` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXdetector (base class); used in application definition, NXsample (base class); used in application definition, NXmonitor (base class); used in application definition, NXdata (base class); used in application definition **Structure**: .. _/NXtomo/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXtomo/entry/title-field: .. index:: title (field) **title**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtomo/entry/start_time-field: .. index:: start_time (field) **start_time**: (optional) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXtomo/entry/end_time-field: .. index:: end_time (field) **end_time**: (optional) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXtomo/entry/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Official NeXus NXDL schema to which this file conforms ... Official NeXus NXDL schema to which this file conforms Obligatory value: ``NXtomo`` .. _/NXtomo/entry/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXtomo/entry/instrument/SOURCE-group: **SOURCE**: (optional) :ref:`NXsource` :ref:`⤆ ` .. _/NXtomo/entry/instrument/SOURCE/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtomo/entry/instrument/SOURCE/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtomo/entry/instrument/SOURCE/probe-field: .. index:: probe (field) **probe**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` | ``electron`` .. _/NXtomo/entry/instrument/detector-group: **detector**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXtomo/entry/instrument/detector/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 3, Dimensions: [nFrames, xSize, ySize]) .. _/NXtomo/entry/instrument/detector/image_key-field: .. index:: image_key (field) **image_key**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nFrames]) :ref:`⤆ ` .. collapse:: In order ... In order to distinguish between sample projections, dark and flat images, a magic number is recorded per frame. The key is as follows: * projection = 0 * flat field = 1 * dark field = 2 * invalid = 3 .. _/NXtomo/entry/instrument/detector/x_pixel_size-field: .. index:: x_pixel_size (field) **x_pixel_size**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtomo/entry/instrument/detector/y_pixel_size-field: .. index:: y_pixel_size (field) **y_pixel_size**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtomo/entry/instrument/detector/distance-field: .. index:: distance (field) **distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Distance between detector and sample .. _/NXtomo/entry/instrument/detector/x_rotation_axis_pixel_position-field: .. index:: x_rotation_axis_pixel_position (field) **x_rotation_axis_pixel_position**: (optional) :ref:`NX_FLOAT ` .. _/NXtomo/entry/instrument/detector/y_rotation_axis_pixel_position-field: .. index:: y_rotation_axis_pixel_position (field) **y_rotation_axis_pixel_position**: (optional) :ref:`NX_FLOAT ` .. _/NXtomo/entry/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXtomo/entry/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXtomo/entry/sample/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nFrames]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: In practice this axis is always aligned along one pixel direction on the d ... In practice this axis is always aligned along one pixel direction on the detector and usually vertical. There are experiments with horizontal rotation axes, so this would need to be indicated somehow. For now the best way for that is an open question. .. _/NXtomo/entry/sample/x_translation-field: .. index:: x_translation (field) **x_translation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nFrames]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtomo/entry/sample/y_translation-field: .. index:: y_translation (field) **y_translation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nFrames]) {units=\ :ref:`NX_LENGTH `} .. _/NXtomo/entry/sample/z_translation-field: .. index:: z_translation (field) **z_translation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nFrames]) {units=\ :ref:`NX_LENGTH `} .. _/NXtomo/entry/control-group: **control**: (optional) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXtomo/entry/control/data-field: .. index:: data (field) **data**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nFrames]) {units=\ :ref:`NX_ANY `} .. collapse:: Total integral monitor counts for each measured frame. Allows a to correct ... Total integral monitor counts for each measured frame. Allows a to correction for fluctuations in the beam between frames. .. _/NXtomo/entry/data-group: **data**: (required) :ref:`NXdata` :ref:`⤆ ` .. _/NXtomo/entry/data/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/detector:NXdetector/data``) .. _/NXtomo/entry/data/rotation_angle-link: **rotation_angle**: :ref:`link` (suggested target: ``/NXentry/NXsample/rotation_angle``) .. _/NXtomo/entry/data/image_key-link: **image_key**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/detector:NXdetector/image_key``) Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXtomo/entry-group ` * :ref:`/NXtomo/entry/control-group ` * :ref:`/NXtomo/entry/control/data-field ` * :ref:`/NXtomo/entry/data-group ` * :ref:`/NXtomo/entry/data/data-link ` * :ref:`/NXtomo/entry/data/image_key-link ` * :ref:`/NXtomo/entry/data/rotation_angle-link ` * :ref:`/NXtomo/entry/definition-field ` * :ref:`/NXtomo/entry/end_time-field ` * :ref:`/NXtomo/entry/instrument-group ` * :ref:`/NXtomo/entry/instrument/detector-group ` * :ref:`/NXtomo/entry/instrument/detector/data-field ` * :ref:`/NXtomo/entry/instrument/detector/distance-field ` * :ref:`/NXtomo/entry/instrument/detector/image_key-field ` * :ref:`/NXtomo/entry/instrument/detector/x_pixel_size-field ` * :ref:`/NXtomo/entry/instrument/detector/x_rotation_axis_pixel_position-field ` * :ref:`/NXtomo/entry/instrument/detector/y_pixel_size-field ` * :ref:`/NXtomo/entry/instrument/detector/y_rotation_axis_pixel_position-field ` * :ref:`/NXtomo/entry/instrument/SOURCE-group ` * :ref:`/NXtomo/entry/instrument/SOURCE/name-field ` * :ref:`/NXtomo/entry/instrument/SOURCE/probe-field ` * :ref:`/NXtomo/entry/instrument/SOURCE/type-field ` * :ref:`/NXtomo/entry/sample-group ` * :ref:`/NXtomo/entry/sample/name-field ` * :ref:`/NXtomo/entry/sample/rotation_angle-field ` * :ref:`/NXtomo/entry/sample/x_translation-field ` * :ref:`/NXtomo/entry/sample/y_translation-field ` * :ref:`/NXtomo/entry/sample/z_translation-field ` * :ref:`/NXtomo/entry/start_time-field ` * :ref:`/NXtomo/entry/title-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXtomo.nxdl.xml