.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXxas_pfy.nxdl.xml -- DO NOT EDIT .. index:: ! NXxas_pfy (application definition) ! xas_pfy (application definition) see: xas_pfy (application definition); NXxas_pfy .. _NXxas_pfy: ========= NXxas_pfy ========= **Status**: *application definition* (contribution), extends :ref:`NXxas` **Description**: .. collapse:: In partial fluorescence yield (PFY), only a selected portion of the ... In partial fluorescence yield (PFY), only a selected portion of the fluorescence emission is detected, typically around a specific fluorescence line of the absorbing element (e.g. :math:`K\alpha`). Experimentally, this energy selectivity can be achieved in several ways: * **Energy-dispersive detector** (e.g. silicon-drift diode, high-purity Ge detector, superconducting tunnel junction, etc.): the detector bins photons by emission energy into channels; the fluorescence line is isolated by selecting a channel range. * **Grating spectrometer**: a diffraction grating disperses the emitted photons by energy onto a 2D detector, providing higher energy resolution. The top-level :ref:`intensity ` field stores the ratio :math:`I_f/I_0`, where :math:`I_f` is the selected fluorescence intensity and :math:`I_0` is the incident beam intensity. This ratio is proportional to the absorption coefficient: .. math:: \mu(E) \propto I_f/I_0 PFY may be affected by detector dead-time and self-absorption effects. When the raw detector data and processing steps are available, they can be stored in the optional ``NXinstrument``, ``NXcollection``, and ``NXprocess`` groups, enabling full reproducibility of the data reduction. **Symbols**: .. collapse:: The symbol(s) listed here will be used below to coordinate datasets ... The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nEnergy**: Number of energy data points **nChannels**: Number of selected detector channels within the emission energy window **nY**: Number of pixel rows in the region of interest (ROI) on the grating-based spectrometer **nX**: Number of pixel columns in the region of interest (ROI) on the grating-based spectrometer **Groups cited**: :ref:`NXbeam`, :ref:`NXcollection`, :ref:`NXcoordinate_system`, :ref:`NXdetector`, :ref:`NXemission_line`, :ref:`NXentry`, :ref:`NXgrating`, :ref:`NXinstrument`, :ref:`NXprocess`, :ref:`NXsample`, :ref:`NXtransformations` .. index:: NXentry (base class); used in application definition, NXemission_line (base class); used in application definition, NXcoordinate_system (base class); used in application definition, NXtransformations (base class); used in application definition, NXsample (base class); used in application definition, NXinstrument (base class); used in application definition, NXbeam (base class); used in application definition, NXdetector (base class); used in application definition, NXgrating (base class); used in application definition, NXcollection (base class); used in application definition, NXprocess (base class); used in application definition **Structure**: .. _/NXxas_pfy/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXxas_pfy/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: ``NXxas_pfy`` .. _/NXxas_pfy/ENTRY/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nEnergy]) {units=\ :ref:`NX_ANY `} :ref:`⤆ ` .. collapse:: The ratio :math:`I_f/I_0`, where :math:`I_f` is the selected ... The ratio :math:`I_f/I_0`, where :math:`I_f` is the selected fluorescence intensity and :math:`I_0` is the incident beam intensity. .. _/NXxas_pfy/ENTRY/LINE_emission_line-group: :bolditalic:`LINE`\ **_emission_line**: (required) :ref:`NXemission_line` .. collapse:: The emission line(s) selected for the partial fluorescence ... The emission line(s) selected for the partial fluorescence yield measurement, whether via a channel range or a grating-based spectrometer. For multiple lines use one group per line (e.g. ``ka1_emission_line``, ``kb1_emission_line``). .. _/NXxas_pfy/ENTRY/LINE_emission_line/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXxas_pfy/ENTRY/emission_energy_window-field: .. index:: emission_energy_window (field) **emission_energy_window**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_ENERGY `} .. collapse:: The lower and upper bounds :math:`[e_{min}, e_{max}]` of the ... The lower and upper bounds :math:`[e_{min}, e_{max}]` of the detected emission energy window. This is the energy range over which fluorescence photons are accepted, whether defined by a detector channel range or a spectrometer region of interest. .. _/NXxas_pfy/ENTRY/beamline_coordinate_system-group: **beamline_coordinate_system**: (optional) :ref:`NXcoordinate_system` .. collapse:: Beamline coordinate system with the sample at the origin: ... Beamline coordinate system with the sample at the origin: x along the beam, y horizontal, z opposite to gravity. .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/origin-field: .. index:: origin (field) **origin**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``sample`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/x_direction-field: .. index:: x_direction (field) **x_direction**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``along incident beam`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/y_direction-field: .. index:: y_direction (field) **y_direction**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``horizontal perpendicular to beam`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/z_direction-field: .. index:: z_direction (field) **z_direction**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``opposite to gravity`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/x-field: .. index:: x (field) **x**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/y-field: .. index:: y (field) **y**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Obligatory value: ``[0, 1, 0]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/z-field: .. index:: z (field) **z**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Obligatory value: ``[0, 0, 1]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/depends_on-field: .. index:: depends_on (field) **depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``transformations/beam``. .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations-group: **transformations**: (required) :ref:`NXtransformations` :ref:`⤆ ` .. collapse:: Two rotations relating the beamline frame to ... Two rotations relating the beamline frame to the NeXus laboratory frame, plus direction vectors labeling beam and gravity. .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/beam-field: .. index:: beam (field) **beam**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` .. collapse:: Direction of the incident beam in the beamline ... Direction of the incident beam in the beamline coordinate system. .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/beam@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/beam@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``gravity`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/gravity-field: .. index:: gravity (field) **gravity**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` .. collapse:: Direction of gravity in the beamline coordinate ... Direction of gravity in the beamline coordinate system. .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/gravity@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 0, -1]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/gravity@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotate_gravity_to_minus_y`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y-field: .. index:: rotate_gravity_to_minus_y (field) **rotate_gravity_to_minus_y**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Active rotation moving gravity from the ... Active rotation moving gravity from the beamline direction (-z) to the NeXus direction (-y). .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotate_beam_to_plus_z`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z-field: .. index:: rotate_beam_to_plus_z (field) **rotate_beam_to_plus_z**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Active rotation moving the beam from the ... Active rotation moving the beam from the beamline direction (+x) to the NeXus direction (+z). .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 1, 0]`` .. _/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ``.`` (the NeXus laboratory ... Should point to ``.`` (the NeXus laboratory frame). .. _/NXxas_pfy/ENTRY/SAMPLE-group: :bolditalic:`SAMPLE`: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXxas_pfy/ENTRY/SAMPLE/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: The sample is at the origin of the beamline ... The sample is at the origin of the beamline coordinate system, rotated about the vertical axis. Should point to ``transformations/sample_rotation``. .. _/NXxas_pfy/ENTRY/SAMPLE/transformations-group: **transformations**: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. collapse:: Orientation of the sample in the beamline ... Orientation of the sample in the beamline coordinate system. .. _/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation-field: .. index:: sample_rotation (field) **sample_rotation**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Rotation of the sample about the vertical axis, ... Rotation of the sample about the vertical axis, orienting the sample surface between the incident beam and the fluorescence detector. .. _/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 0, 1]`` .. _/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``/entry/beamline_coordinate_system``. .. _/NXxas_pfy/ENTRY/INSTRUMENT-group: :bolditalic:`INSTRUMENT`: (optional) :ref:`NXinstrument` :ref:`⤆ ` .. collapse:: The ``data`` field of each detector below holds the intensity ... The ``data`` field of each detector below holds the intensity used in the analysis and may already include corrections (for example dead-time, self-absorption, or detector-channel or ROI integration). If the uncorrected values are kept, they are archived in the ``NXcollection`` group and the corrections are described in ``NXprocess``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/beam-group: **beam**: (optional) :ref:`NXbeam` :ref:`⤆ ` The incident X-ray beam. .. _/NXxas_pfy/ENTRY/INSTRUMENT/beam/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``transformations/beam_direction``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations-group: **transformations**: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. _/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations/beam_direction-field: .. index:: beam_direction (field) **beam_direction**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` .. collapse:: Beam direction in the beamline coordinate ... Beam direction in the beamline coordinate system. The beam travels along +x. .. _/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations/beam_direction@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations/beam_direction@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``/entry/beamline_coordinate_system``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0-group: **i0**: (recommended) :ref:`NXdetector` :ref:`⤆ ` Detector measuring the incident beam intensity :math:`I_0`. .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nEnergy]) :ref:`⤆ ` .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``transformations/i0_distance``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations-group: **transformations**: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance-field: .. index:: i0_distance (field) **i0_distance**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. collapse:: Distance from the sample to the I0 detector, ... Distance from the sample to the I0 detector, measured upstream along the beam (negative x direction in the beamline frame). .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``translation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[-1, 0, 0]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``/entry/beamline_coordinate_system``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating-group: **grating**: (optional) :ref:`NXgrating` .. collapse:: Diffraction grating used to select the emission energy ... Diffraction grating used to select the emission energy in a grating-based spectrometer. Present only when a grating spectrometer is used instead of an energy-dispersive detector. The grating lies on the line connecting the sample and the fluorescence detector (``if``): the azimuthal and polar angles must therefore match those of ``if/transformations``, and only the distance differs. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to the last transformation in the ... Should point to the last transformation in the chain, i.e. ``transformations/grating_distance``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations-group: **transformations**: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. collapse:: Transformation chain placing the grating relative ... Transformation chain placing the grating relative to the sample. The azimuthal and polar angles must be equal to those of the fluorescence detector (``if``) to ensure colinearity. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance-field: .. index:: grating_distance (field) **grating_distance**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. collapse:: Distance from the sample to the grating along ... Distance from the sample to the grating along the sample-to-detector direction. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``translation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``grating_polar_angle`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle-field: .. index:: grating_polar_angle (field) **grating_polar_angle**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Polar (elevation) angle of the grating above ... Polar (elevation) angle of the grating above the horizontal beam plane. Must equal ``if/transformations/if_polar_angle``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, -1, 0]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``grating_azimuthal_angle`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle-field: .. index:: grating_azimuthal_angle (field) **grating_azimuthal_angle**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Azimuthal (horizontal) angle of the grating ... Azimuthal (horizontal) angle of the grating from the incident beam direction. Must equal ``if/transformations/if_azimuthal_angle``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 0, 1]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``/entry/beamline_coordinate_system``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor-group: **ifluor**: (recommended) :ref:`NXdetector` :ref:`⤆ ` .. collapse:: Fluorescence detector measuring :math:`I_f`. When using an ... Fluorescence detector measuring :math:`I_f`. When using an energy-dispersive detector, ``data`` holds the intensity integrated over the selected detector channels. When using a grating-based spectrometer, ``data`` holds the ROI integrated on the spectrometer detector. In both cases the data may be corrected for dead-time and self-absorption. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [nEnergy]) :ref:`⤆ ` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/dead_time-field: .. index:: dead_time (field) **dead_time**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nEnergy]) {units=\ :ref:`NX_TIME `} :ref:`⤆ ` Detector dead time per energy point. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/count_time-field: .. index:: count_time (field) **count_time**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nEnergy]) {units=\ :ref:`NX_TIME `} Detector live time per energy point. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to the last transformation in the ... Should point to the last transformation in the chain, i.e. ``transformations/if_distance``. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations-group: **transformations**: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. collapse:: Transformation chain placing the fluorescence ... Transformation chain placing the fluorescence detector relative to the sample: azimuthal angle, polar angle, then distance. These angles are required to compute self-absorption corrections. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance-field: .. index:: if_distance (field) **if_distance**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. collapse:: Distance from the sample to the fluorescence ... Distance from the sample to the fluorescence detector (or spectrometer entrance). .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``translation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``if_polar_angle`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle-field: .. index:: if_polar_angle (field) **if_polar_angle**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Polar (elevation) angle of the detector above ... Polar (elevation) angle of the detector above the horizontal beam plane. A value of 0 means the detector is in the horizontal plane; 90 degrees means it is directly above the sample. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, -1, 0]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``if_azimuthal_angle`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle-field: .. index:: if_azimuthal_angle (field) **if_azimuthal_angle**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Azimuthal (horizontal) angle of the detector ... Azimuthal (horizontal) angle of the detector from the incident beam direction. Rotation around the vertical z-axis. Typically around 90 degrees to minimize elastic scattering background. .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 0, 1]`` .. _/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Should point to ... Should point to ``/entry/beamline_coordinate_system``. .. _/NXxas_pfy/ENTRY/COLLECTION-group: :bolditalic:`COLLECTION`: (optional) :ref:`NXcollection` :ref:`⤆ ` .. collapse:: Raw data as written by the acquisition software, ... Raw data as written by the acquisition software, preserved without modification to allow independent reprocessing. Either ``detector_channels`` or ``detector_roi`` will be present depending on the detector type used; not both simultaneously. .. _/NXxas_pfy/ENTRY/COLLECTION/detector_channels-field: .. index:: detector_channels (field) **detector_channels**: (optional) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [nEnergy, nChannels]) .. collapse:: Raw channel counts per incident energy point for the ... Raw channel counts per incident energy point for the selected channels of an energy-dispersive detector. Only the channels within the emission energy window are stored. Axis 0 is the energy scan axis; axis 1 enumerates the selected channels. Each value is the count in that channel for one energy point. .. _/NXxas_pfy/ENTRY/COLLECTION/detector_roi-field: .. index:: detector_roi (field) **detector_roi**: (optional) :ref:`NX_FLOAT ` (Rank: 3, Dimensions: [nEnergy, nY, nX]) .. collapse:: Raw detector image within the ROI per incident energy point. ... Raw detector image within the ROI per incident energy point. Axis 0 is the energy scan axis; axes 1 and 2 span the 2D pixel grid of the downstream detector (nY rows, nX columns). .. _/NXxas_pfy/ENTRY/PROCESS-group: :bolditalic:`PROCESS`: (optional) :ref:`NXprocess` :ref:`⤆ ` .. collapse:: Description of how :ref:`intensity ... Description of how :ref:`intensity ` was obtained from the raw detector data (i0, if), including any applied correction, e.g., dead-time or self-absorption. .. _/NXxas_pfy/ENTRY/PROCESS/program-field: .. index:: program (field) **program**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Name of the program used for processing. .. _/NXxas_pfy/ENTRY/PROCESS/version-field: .. index:: version (field) **version**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Version of the program used for processing. .. _/NXxas_pfy/ENTRY/PROCESS/date-field: .. index:: date (field) **date**: (optional) :ref:`NX_DATE_TIME ` :ref:`⤆ ` Date and time of processing. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXxas_pfy/ENTRY-group ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system-group ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/depends_on-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/origin-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations-group ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/beam-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/beam@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/beam@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/gravity-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/gravity@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/gravity@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_beam_to_plus_z@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/transformations/rotate_gravity_to_minus_y@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/x-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/x_direction-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/y-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/y_direction-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/z-field ` * :ref:`/NXxas_pfy/ENTRY/beamline_coordinate_system/z_direction-field ` * :ref:`/NXxas_pfy/ENTRY/COLLECTION-group ` * :ref:`/NXxas_pfy/ENTRY/COLLECTION/detector_channels-field ` * :ref:`/NXxas_pfy/ENTRY/COLLECTION/detector_roi-field ` * :ref:`/NXxas_pfy/ENTRY/definition-field ` * :ref:`/NXxas_pfy/ENTRY/emission_energy_window-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/beam-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/beam/depends_on-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations/beam_direction-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations/beam_direction@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/beam/transformations/beam_direction@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/depends_on-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_azimuthal_angle@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_distance@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/grating/transformations/grating_polar_angle@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/data-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/depends_on-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/i0/transformations/i0_distance@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/count_time-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/data-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/dead_time-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/depends_on-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations-group ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_azimuthal_angle@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_distance@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle-field ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/INSTRUMENT/ifluor/transformations/if_polar_angle@vector-attribute ` * :ref:`/NXxas_pfy/ENTRY/intensity-field ` * :ref:`/NXxas_pfy/ENTRY/LINE_emission_line-group ` * :ref:`/NXxas_pfy/ENTRY/LINE_emission_line/name-field ` * :ref:`/NXxas_pfy/ENTRY/PROCESS-group ` * :ref:`/NXxas_pfy/ENTRY/PROCESS/date-field ` * :ref:`/NXxas_pfy/ENTRY/PROCESS/program-field ` * :ref:`/NXxas_pfy/ENTRY/PROCESS/version-field ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE-group ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE/depends_on-field ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE/transformations-group ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation-field ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation@depends_on-attribute ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation@transformation_type-attribute ` * :ref:`/NXxas_pfy/ENTRY/SAMPLE/transformations/sample_rotation@vector-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXxas_pfy.nxdl.xml