.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXazint2d.nxdl.xml -- DO NOT EDIT .. index:: ! NXazint2d (application definition) ! azint2d (application definition) see: azint2d (application definition); NXazint2d .. _NXazint2d: ========= NXazint2d ========= **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: Application definition for data from two-dimensional area detectors that has bee ... Application definition for data from two-dimensional area detectors that has been integrated azimuthally, with a certain radial binning in units of q or 2theta and with a binning around the azimuthal angle eta. An example application that creates these files is documented here: https://maxiv-science.github.io/azint_writer/ **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nImg**: Number of integrated images **nRad**: Number of radial bins **nRadEdge**: Number of radial bin edges (nRad+1) **nEta**: Number of azimuthal bins **nEtaEdge**: Number of azimuthal bin edges (nEta+1) **Groups cited**: :ref:`NXdata`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXmonochromator`, :ref:`NXparameters`, :ref:`NXprocess`, :ref:`NXsource` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXmonochromator (base class); used in application definition, NXsource (base class); used in application definition, NXprocess (base class); used in application definition, NXparameters (base class); used in application definition, NXmonitor (base class); used in application definition, NXdata (base class); used in application definition **Structure**: .. _/NXazint2d/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` .. collapse:: The ``NXsubentry`` or Multi-Method Data convention described here: ... .. index:: NXazint2d (applications) The ``NXsubentry`` or Multi-Method Data convention described here: https://manual.nexusformat.org/rules.html#table-nxsubentry should be used when different method (e.g. ``NXcanSAS`` or ``NXmonopd``), ``NXazint1d`` or other ``NXazint2d`` data, integrated with different options, should be stored under the same ``NXentry``. In case of a single ``NXazint2d`` data processing the standard convention with the application definition directly under ``NXentry`` should be used. .. _/NXazint2d/ENTRY@default-attribute: .. index:: default (group attribute) **@default**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Declares which :ref:`NXdata` group ... .. index:: plotting Declares which :ref:`NXdata` group contains the data to be shown by default. It is needed to resolve ambiguity when more than one :ref:`NXdata` group exists. The value is the name of the default :ref:`NXdata` group. .. _/NXazint2d/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: ``NXazint2d`` .. _/NXazint2d/ENTRY/solid_angle_applied-field: .. index:: solid_angle_applied (field) **solid_angle_applied**: (required) :ref:`NX_BOOLEAN ` is solid angle correction applied or not. .. _/NXazint2d/ENTRY/polarization_applied-field: .. index:: polarization_applied (field) **polarization_applied**: (required) :ref:`NX_BOOLEAN ` is polarization correction applied or not. .. _/NXazint2d/ENTRY/normalization_applied-field: .. index:: normalization_applied (field) **normalization_applied**: (required) :ref:`NX_BOOLEAN ` .. collapse:: is a normalization correction applied or not. ... is a normalization correction applied or not. It indicates that integrated intensities and their errors were already divided by the appropriate normalization factors accounting for the effective number or weighted contribution of detector pixels to each integration bin. .. _/NXazint2d/ENTRY/monitor_applied-field: .. index:: monitor_applied (field) **monitor_applied**: (optional) :ref:`NX_BOOLEAN ` .. collapse:: is a monitor correction applied or not. ... is a monitor correction applied or not. The monitor correction accounts for external factors that are independent of the azimuthal integration process. Most commonly, this involves normalizing for fluctuations in the incident beam intensity or, where applicable, variations in exposure time. .. _/NXazint2d/ENTRY/INSTRUMENT-group: :bolditalic:`INSTRUMENT`: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXazint2d/ENTRY/INSTRUMENT/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Name of instrument (beamline) where data was collected. .. _/NXazint2d/ENTRY/INSTRUMENT/MONOCHROMATOR-group: :bolditalic:`MONOCHROMATOR`: (required) :ref:`NXmonochromator` :ref:`⤆ ` .. _/NXazint2d/ENTRY/INSTRUMENT/MONOCHROMATOR/wavelength-field: .. index:: wavelength (field) **wavelength**: (required) :ref:`NX_FLOAT ` {units=angstrom} :ref:`⤆ ` Wavelength in angstrom. .. _/NXazint2d/ENTRY/INSTRUMENT/MONOCHROMATOR/energy-field: .. index:: energy (field) **energy**: (required) :ref:`NX_FLOAT ` {units=keV} :ref:`⤆ ` Energy in keV. .. _/NXazint2d/ENTRY/INSTRUMENT/SOURCE-group: :bolditalic:`SOURCE`: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXazint2d/ENTRY/INSTRUMENT/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Name of laboratory where data was collected. .. _/NXazint2d/ENTRY/INSTRUMENT/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Type of laboratory where data was collected. .. _/NXazint2d/ENTRY/INSTRUMENT/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Type of probe. .. _/NXazint2d/ENTRY/reduction-group: **reduction**: (required) :ref:`NXprocess` :ref:`⤆ ` .. _/NXazint2d/ENTRY/reduction/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Name of the program that made this file. .. _/NXazint2d/ENTRY/reduction/version-field: .. index:: version (field) **version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Version of the program that made this file. .. _/NXazint2d/ENTRY/reduction/date-field: .. index:: date (field) **date**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` Date the file was created. .. _/NXazint2d/ENTRY/reduction/reference-field: .. index:: reference (field) **reference**: (required) :ref:`NX_CHAR ` Citation or other references for the algorithm used in the processing. .. _/NXazint2d/ENTRY/reduction/note-field: .. index:: note (field) **note**: (optional) :ref:`NX_CHAR ` Notes required to help interpret the data, e.g. on coordinate systems. .. _/NXazint2d/ENTRY/reduction/input-group: **input**: (required) :ref:`NXparameters` :ref:`⤆ ` .. collapse:: Parameters should exactly match those required by the algorithm used in th ... Parameters should exactly match those required by the algorithm used in the processing. For example, `azint` requires `error_model`, `mask`, `n_splitting`, `poni`, etc. .. _/NXazint2d/ENTRY/MONITOR-group: :bolditalic:`MONITOR`: (optional) :ref:`NXmonitor` :ref:`⤆ ` Monitor data for example `I_zero`. .. _/NXazint2d/ENTRY/MONITOR/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nImg]) :ref:`⤆ ` .. _/NXazint2d/ENTRY/DATA-group: :bolditalic:`DATA`: (required) :ref:`NXdata` :ref:`⤆ ` Azimuthally integrated data with radial binning in q or 2theta and with azimuthal binning. .. _/NXazint2d/ENTRY/DATA@axes-attribute: .. index:: axes (group attribute) **@axes**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``['.', 'azimuthal_axis', 'radial_axis']`` .. _/NXazint2d/ENTRY/DATA@interpretation-attribute: .. index:: interpretation (group attribute) **@interpretation**: (required) :ref:`NX_CHAR ` Obligatory value: ``image`` .. _/NXazint2d/ENTRY/DATA@signal-attribute: .. index:: signal (group attribute) **@signal**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``I`` .. _/NXazint2d/ENTRY/DATA/I-field: .. index:: I (field) **I**: (required) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [nImg, nEta, nRad]) .. _/NXazint2d/ENTRY/DATA/I@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Obligatory value: ``intensity`` .. _/NXazint2d/ENTRY/DATA/I@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Obligatory value: ``arbitrary units`` .. _/NXazint2d/ENTRY/DATA/I_errors-field: .. index:: I_errors (field) **I_errors**: (optional) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [nImg, nEta, nRad]) :ref:`⤆ ` .. _/NXazint2d/ENTRY/DATA/I_errors@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Obligatory value: ``estimated intensity error`` .. _/NXazint2d/ENTRY/DATA/I_errors@units-attribute: .. index:: units (field attribute) **@units**: (optional) :ref:`NX_CHAR ` Obligatory value: ``arbitrary units`` .. _/NXazint2d/ENTRY/DATA/radial_axis-field: .. index:: radial_axis (field) **radial_axis**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nRad]) :ref:`⤆ ` .. _/NXazint2d/ENTRY/DATA/radial_axis@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``q`` | ``2theta`` .. _/NXazint2d/ENTRY/DATA/radial_axis@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Any of these values: ``NX_PER_LENGHT`` | ``NX_WAVENUMBER`` | ``NX_ANGLE`` .. _/NXazint2d/ENTRY/DATA/radial_axis_edges-field: .. index:: radial_axis_edges (field) **radial_axis_edges**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nRadEdge]) :ref:`⤆ ` .. _/NXazint2d/ENTRY/DATA/radial_axis_edges@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``q bin edges`` | ``2theta bin edges`` .. _/NXazint2d/ENTRY/DATA/radial_axis_edges@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Any of these values: ``NX_PER_LENGTH`` | ``NX_WAVENUMBER`` | ``NX_ANGLE`` .. _/NXazint2d/ENTRY/DATA/norm-field: .. index:: norm (field) **norm**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [nEta, nRad]) .. collapse:: Values of the normalization correction. ... Values of the normalization correction. The normalization correction accounts for the effective number or weighted contribution of detector pixels to each integration bin. Note: An important aspect of the normalization strategy is how polarization and solid angle corrections are incorporated, which can vary depending on the specific application, software, and its configuration options (see, for example, PyFAI documentation). Additionally, the normalization strategy may include a relative or absolute calibration factor. Two common normalization approaches are: "Relative normalization" to the PONI (Point Of Normal Incidence) pixel, and "Absolute calibration", which yields the number of photons scattered by the sample in a given direction per unit solid angle. The type of the normalization strategy is not indicated on this level. It must be concluded from the software used or its parameters. The monitor correction is not included in the normalization correction and it is specified separately. .. _/NXazint2d/ENTRY/DATA/norm@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Obligatory value: * ``effective number of pixels contributing to the corresponding bin`` .. _/NXazint2d/ENTRY/DATA/norm@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Obligatory value: ``arbitrary units`` .. _/NXazint2d/ENTRY/DATA/azimuthal_axis-field: .. index:: azimuthal_axis (field) **azimuthal_axis**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nEta]) .. _/NXazint2d/ENTRY/DATA/azimuthal_axis@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Obligatory value: ``azimuthal bin center`` .. _/NXazint2d/ENTRY/DATA/azimuthal_axis@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Obligatory value: ``NX_ANGLE`` .. _/NXazint2d/ENTRY/DATA/azimuthal_axis_edges-field: .. index:: azimuthal_axis_edges (field) **azimuthal_axis_edges**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nEtaEdge]) .. _/NXazint2d/ENTRY/DATA/azimuthal_axis_edges@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Obligatory value: ``azimuthal bin edges`` .. _/NXazint2d/ENTRY/DATA/azimuthal_axis_edges@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Obligatory value: ``NX_ANGLE`` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXazint2d/ENTRY-group ` * :ref:`/NXazint2d/ENTRY/DATA-group ` * :ref:`/NXazint2d/ENTRY/DATA/azimuthal_axis-field ` * :ref:`/NXazint2d/ENTRY/DATA/azimuthal_axis@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/azimuthal_axis@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/azimuthal_axis_edges-field ` * :ref:`/NXazint2d/ENTRY/DATA/azimuthal_axis_edges@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/azimuthal_axis_edges@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/I-field ` * :ref:`/NXazint2d/ENTRY/DATA/I@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/I@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/I_errors-field ` * :ref:`/NXazint2d/ENTRY/DATA/I_errors@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/I_errors@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/norm-field ` * :ref:`/NXazint2d/ENTRY/DATA/norm@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/norm@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/radial_axis-field ` * :ref:`/NXazint2d/ENTRY/DATA/radial_axis@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/radial_axis@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/radial_axis_edges-field ` * :ref:`/NXazint2d/ENTRY/DATA/radial_axis_edges@long_name-attribute ` * :ref:`/NXazint2d/ENTRY/DATA/radial_axis_edges@units-attribute ` * :ref:`/NXazint2d/ENTRY/DATA@axes-attribute ` * :ref:`/NXazint2d/ENTRY/DATA@interpretation-attribute ` * :ref:`/NXazint2d/ENTRY/DATA@signal-attribute ` * :ref:`/NXazint2d/ENTRY/definition-field ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT-group ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/MONOCHROMATOR-group ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/MONOCHROMATOR/energy-field ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/MONOCHROMATOR/wavelength-field ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/name-field ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/SOURCE-group ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/SOURCE/name-field ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/SOURCE/probe-field ` * :ref:`/NXazint2d/ENTRY/INSTRUMENT/SOURCE/type-field ` * :ref:`/NXazint2d/ENTRY/MONITOR-group ` * :ref:`/NXazint2d/ENTRY/MONITOR/data-field ` * :ref:`/NXazint2d/ENTRY/monitor_applied-field ` * :ref:`/NXazint2d/ENTRY/normalization_applied-field ` * :ref:`/NXazint2d/ENTRY/polarization_applied-field ` * :ref:`/NXazint2d/ENTRY/reduction-group ` * :ref:`/NXazint2d/ENTRY/reduction/date-field ` * :ref:`/NXazint2d/ENTRY/reduction/input-group ` * :ref:`/NXazint2d/ENTRY/reduction/note-field ` * :ref:`/NXazint2d/ENTRY/reduction/program-field ` * :ref:`/NXazint2d/ENTRY/reduction/reference-field ` * :ref:`/NXazint2d/ENTRY/reduction/version-field ` * :ref:`/NXazint2d/ENTRY/solid_angle_applied-field ` * :ref:`/NXazint2d/ENTRY@default-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/applications/NXazint2d.nxdl.xml