.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXtomophase.nxdl.xml -- DO NOT EDIT .. index:: ! NXtomophase (application definition) ! tomophase (application definition) see: tomophase (application definition); NXtomophase .. _NXtomophase: =========== NXtomophase =========== .. 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 with ... This is the application definition for x-ray or neutron tomography raw data with phase contrast variation at each point. In tomography first some dark field images are measured, some bright field images and, of course the sample. In order to properly sort the order of the images taken, a sequence number is stored with each image. **Symbols**: These symbols will be used below to coordinate datasets with the same shape. **nBrightFrames**: Number of bright frames **nDarkFrames**: Number of dark frames **nSampleFrames**: Number of image (sample) frames **nPhase**: Number of phase settings **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**: .. _/NXtomophase/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXtomophase/entry/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtomophase/entry/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXtomophase/entry/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXtomophase/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: ``NXtomophase`` .. _/NXtomophase/entry/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/SOURCE-group: **SOURCE**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` | ``electron`` .. _/NXtomophase/entry/instrument/bright_field-group: **bright_field**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/bright_field/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 3, Dimensions: [nBrightFrames, xSize, ySize]) .. _/NXtomophase/entry/instrument/bright_field/sequence_number-field: .. index:: sequence_number (field) **sequence_number**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nBrightFrames]) :ref:`⤆ ` .. _/NXtomophase/entry/instrument/dark_field-group: **dark_field**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/dark_field/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 3, Dimensions: [nDarkFrames, xSize, ySize]) .. _/NXtomophase/entry/instrument/dark_field/sequence_number-field: .. index:: sequence_number (field) **sequence_number**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nDarkFrames]) :ref:`⤆ ` .. _/NXtomophase/entry/instrument/sample-group: **sample**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXtomophase/entry/instrument/sample/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 4, Dimensions: [nSampleFrames, nPhase, xSize, ySize]) .. _/NXtomophase/entry/instrument/sample/sequence_number-field: .. index:: sequence_number (field) **sequence_number**: (required) :ref:`NX_INT ` (Rank: 2, Dimensions: [nSampleFrames, nPhase]) :ref:`⤆ ` .. _/NXtomophase/entry/instrument/sample/x_pixel_size-field: .. index:: x_pixel_size (field) **x_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtomophase/entry/instrument/sample/y_pixel_size-field: .. index:: y_pixel_size (field) **y_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtomophase/entry/instrument/sample/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Distance between detector and sample .. _/NXtomophase/entry/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXtomophase/entry/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXtomophase/entry/sample/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nSampleFrames]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXtomophase/entry/sample/x_translation-field: .. index:: x_translation (field) **x_translation**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nSampleFrames]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtomophase/entry/sample/y_translation-field: .. index:: y_translation (field) **y_translation**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nSampleFrames]) {units=\ :ref:`NX_LENGTH `} .. _/NXtomophase/entry/sample/z_translation-field: .. index:: z_translation (field) **z_translation**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nSampleFrames]) {units=\ :ref:`NX_LENGTH `} .. _/NXtomophase/entry/control-group: **control**: (required) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXtomophase/entry/control/integral-field: .. index:: integral (field) **integral**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDarkFrames + nBrightFrames + nSampleFrame]) {units=\ :ref:`NX_ANY `} .. collapse:: Total integral monitor counts for each measured frame. Allows a correction ... Total integral monitor counts for each measured frame. Allows a correction for fluctuations in the beam between frames. .. _/NXtomophase/entry/data-group: **data**: (required) :ref:`NXdata` :ref:`⤆ ` .. _/NXtomophase/entry/data/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/sample:NXdetector/data``) .. _/NXtomophase/entry/data/rotation_angle-link: **rotation_angle**: :ref:`link` (suggested target: ``/NXentry/NXsample/rotation_angle``) Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXtomophase/entry-group ` * :ref:`/NXtomophase/entry/control-group ` * :ref:`/NXtomophase/entry/control/integral-field ` * :ref:`/NXtomophase/entry/data-group ` * :ref:`/NXtomophase/entry/data/data-link ` * :ref:`/NXtomophase/entry/data/rotation_angle-link ` * :ref:`/NXtomophase/entry/definition-field ` * :ref:`/NXtomophase/entry/end_time-field ` * :ref:`/NXtomophase/entry/instrument-group ` * :ref:`/NXtomophase/entry/instrument/bright_field-group ` * :ref:`/NXtomophase/entry/instrument/bright_field/data-field ` * :ref:`/NXtomophase/entry/instrument/bright_field/sequence_number-field ` * :ref:`/NXtomophase/entry/instrument/dark_field-group ` * :ref:`/NXtomophase/entry/instrument/dark_field/data-field ` * :ref:`/NXtomophase/entry/instrument/dark_field/sequence_number-field ` * :ref:`/NXtomophase/entry/instrument/sample-group ` * :ref:`/NXtomophase/entry/instrument/sample/data-field ` * :ref:`/NXtomophase/entry/instrument/sample/distance-field ` * :ref:`/NXtomophase/entry/instrument/sample/sequence_number-field ` * :ref:`/NXtomophase/entry/instrument/sample/x_pixel_size-field ` * :ref:`/NXtomophase/entry/instrument/sample/y_pixel_size-field ` * :ref:`/NXtomophase/entry/instrument/SOURCE-group ` * :ref:`/NXtomophase/entry/instrument/SOURCE/name-field ` * :ref:`/NXtomophase/entry/instrument/SOURCE/probe-field ` * :ref:`/NXtomophase/entry/instrument/SOURCE/type-field ` * :ref:`/NXtomophase/entry/sample-group ` * :ref:`/NXtomophase/entry/sample/name-field ` * :ref:`/NXtomophase/entry/sample/rotation_angle-field ` * :ref:`/NXtomophase/entry/sample/x_translation-field ` * :ref:`/NXtomophase/entry/sample/y_translation-field ` * :ref:`/NXtomophase/entry/sample/z_translation-field ` * :ref:`/NXtomophase/entry/start_time-field ` * :ref:`/NXtomophase/entry/title-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXtomophase.nxdl.xml