3.3.1.106. NXherfd

Status:

base class, extends NXobject

Description:

High-energy resolution fluorescence detection (HERFD) is a particular case ...

High-energy resolution fluorescence detection (HERFD) is a particular case of partial fluorescence yield measured with a crystal analyzer spectrometer with an energy bandwidth of approximately 1-2 eV.

The HERFD spectrum corresponds to a constant-emission-energy cut through the Resonant Inelastic X-ray Scattering (RIXS) plane. The spectral shape depends on the emission energy, making the emission line and emission energy mandatory metadata.

\[\mu(E) \propto I_f/I_0\]

The spectrometer uses Rowland circle geometry (Johann or Johansson type). Multiple crystal analyzers may be arranged at different horizontal angles around the sample to increase solid angle coverage.

Symbols:

nEnergy: Number of energy data points

Groups cited:

NXbeam, NXcoordinate_system, NXcrystal, NXdetector, NXemission_line, NXprocess, NXsource, NXtransformations

Structure:

emission_line: (optional) NXemission_line

The emission line at which the HERFD spectrum is measured.

emission_energy: (optional) NX_FLOAT {units=NX_ENERGY}

The emission energy at which the spectrometer is set.

beamline_coordinate_system: (recommended) NXcoordinate_system

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.

origin: (optional) NX_CHAR ⤆

Obligatory value: sample

x_direction: (optional) NX_CHAR ⤆

Obligatory value: along incident beam

y_direction: (optional) NX_CHAR ⤆

Obligatory value: horizontal perpendicular to beam

z_direction: (optional) NX_CHAR ⤆

Obligatory value: opposite to gravity

x: (optional) NX_NUMBER ⤆

Obligatory value: [1, 0, 0]

y: (optional) NX_NUMBER ⤆

Obligatory value: [0, 1, 0]

z: (optional) NX_NUMBER ⤆

Obligatory value: [0, 0, 1]

depends_on: (optional) NX_CHAR ⤆

Should point to ...

Should point to transformations/beam.

transformations: (optional) NXtransformations ⤆

Two rotations relating the beamline frame to ...

Two rotations relating the beamline frame to the NeXus/McStas laboratory frame, plus direction vectors labeling beam and gravity.

beam: (optional) NX_NUMBER {units=NX_UNITLESS} ⤆

Direction of the incident beam in the beamline ...

Direction of the incident beam in the beamline coordinate system.

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [1, 0, 0]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: gravity

gravity: (optional) NX_NUMBER {units=NX_UNITLESS} ⤆

Direction of gravity in the beamline coordinate ...

Direction of gravity in the beamline coordinate system.

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [0, 0, -1]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: rotate_gravity_to_minus_y

rotate_gravity_to_minus_y: (optional) NX_NUMBER {units=NX_ANGLE} ⤆

Active rotation moving gravity from the ...

Active rotation moving gravity from the beamline direction (-z) to the McStas direction (-y).

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: rotation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [1, 0, 0]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: rotate_beam_to_plus_z

rotate_beam_to_plus_z: (optional) NX_NUMBER {units=NX_ANGLE} ⤆

Active rotation moving the beam from the ...

Active rotation moving the beam from the beamline direction (+x) to the McStas direction (+z).

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: rotation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [0, 1, 0]

@depends_on: (optional) NX_CHAR ⤆

Should point to ``.`` (the McStas laboratory ...

Should point to . (the McStas laboratory frame).

beam: (recommended) NXbeam

The incident X-ray beam.

incident_energy: (optional) NX_FLOAT {units=NX_ENERGY} ⤆

Energy of the incident beam at the sample position.

depends_on: (recommended) NX_CHAR ⤆

Should point to ...

Should point to beam/transformations/beam_direction.

transformations: (recommended) NXtransformations ⤆

beam_direction: (optional) NX_NUMBER {units=NX_UNITLESS} ⤆

Beam direction in the beamline coordinate ...

Beam direction in the beamline coordinate system. The beam travels along +x.

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [1, 0, 0]

@depends_on: (optional) NX_CHAR ⤆

Should point to the beamline coordinate system ...

Should point to the beamline coordinate system or to the sample.

SOURCE: (optional) NXsource

type: (optional) NX_CHAR ⤆

name: (optional) NX_CHAR ⤆

probe: (optional) NX_CHAR ⤆

Obligatory value: x-ray

i0: (optional) NXdetector

Detector measuring the incident beam intensity ...

Detector measuring the incident beam intensity \(I_0\), positioned upstream of the sample along the beam direction.

data: (optional) NX_NUMBER (Rank: 1, Dimensions: [nEnergy]) ⤆

depends_on: (recommended) NX_CHAR ⤆

Should point to ...

Should point to i0/transformations/i0_distance.

transformations: (recommended) NXtransformations ⤆

i0_distance: (optional) NX_NUMBER {units=NX_LENGTH} ⤆

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).

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: translation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [-1, 0, 0]

@depends_on: (optional) NX_CHAR ⤆

Should point to the sample.

ANALYZERCRYSTAL: (optional) NXcrystal

Crystal analyzer on the Rowland circle. For ...

Crystal analyzer on the Rowland circle. For multi-crystal spectrometers, use one group per crystal (e.g. analyzer1, analyzer2).

type: (optional) NX_CHAR ⤆

Type or material of the analyzer crystal ...

Type or material of the analyzer crystal (Si, Ge, etc.).

reflection: (optional) NX_INT (Rank: 1, Dimensions: [3]) {units=NX_UNITLESS} ⤆

Miller indices (hkl) values of the nominal ...

Miller indices (hkl) values of the nominal reflection.

d_spacing: (optional) NX_FLOAT {units=NX_LENGTH} ⤆

The spacing between crystal planes of the ...

The spacing between crystal planes of the reflection.

bragg_angle: (optional) NX_FLOAT {units=NX_ANGLE} ⤆

Bragg angle :math:`\theta_B` of the nominal ...

Bragg angle \(\theta_B\) of the nominal reflection.

bending_radius: (optional) NX_FLOAT {units=NX_LENGTH}

Bending radius of the spherically bent crystal ...

Bending radius of the spherically bent crystal analyzer. In Johann geometry this is \(2R_R\) (twice the Rowland radius).

rowland_radius: (optional) NX_FLOAT {units=NX_LENGTH}

Radius of the Rowland circle :math:`R_R`. The ...

Radius of the Rowland circle \(R_R\). The sample, crystal center, and detector focus all lie on this circle.

energy_resolution: (optional) NX_FLOAT {units=NX_ENERGY}

The energy bandwidth or resolution of the crystal ...

The energy bandwidth or resolution of the crystal analyzer.

geometry_type: (optional) NX_CHAR

The type of crystal analyzer geometry. ...

The type of crystal analyzer geometry.

Any of these values: Johann | Johansson

diameter: (optional) NX_FLOAT {units=NX_LENGTH}

Diameter of the crystal analyzer wafer.

depends_on: (recommended) NX_CHAR ⤆

Should point to the last transformation in the ...

Should point to the last transformation in the chain, i.e. transformations/analyzer_distance.

transformations: (recommended) NXtransformations ⤆

Transformation chain placing the analyzer relative ...

Transformation chain placing the analyzer relative to the sample: azimuthal angle, polar angle, then distance.

analyzer_distance: (optional) NX_NUMBER {units=NX_LENGTH} ⤆

Sample-to-analyzer distance.

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: translation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [1, 0, 0]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: analyzer_polar_angle

analyzer_polar_angle: (optional) NX_NUMBER {units=NX_ANGLE} ⤆

Polar angle of the analyzer in the vertical ...

Polar angle of the analyzer in the vertical Rowland plane. Elevation from the horizontal beam plane to the sample-analyzer direction.

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: rotation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [0, -1, 0]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: analyzer_azimuthal_angle

analyzer_azimuthal_angle: (optional) NX_NUMBER {units=NX_ANGLE} ⤆

Azimuthal (horizontal) angle of the ...

Azimuthal (horizontal) angle of the spectrometer arm from the incident beam direction. Rotation around the vertical z-axis. Typically around 90 degrees to minimize elastic scattering.

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: rotation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [0, 0, 1]

@depends_on: (optional) NX_CHAR ⤆

Should point to the sample.

if: (optional) NXdetector

Detector measuring the fluorescence intensity ...

Detector measuring the fluorescence intensity \(I_f\) diffracted by the crystal analyzer(s).

data: (optional) NX_NUMBER (Rank: 1, Dimensions: [nEnergy]) ⤆

depends_on: (recommended) NX_CHAR ⤆

Should point to the last transformation in the ...

Should point to the last transformation in the chain, i.e. transformations/detector_distance.

transformations: (recommended) NXtransformations ⤆

Transformation chain placing the detector relative ...

Transformation chain placing the detector relative to the sample: azimuthal angle, polar angle, then distance.

detector_distance: (optional) NX_NUMBER {units=NX_LENGTH} ⤆

Distance from the sample to the detector.

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: translation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [1, 0, 0]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: detector_polar_angle

detector_polar_angle: (optional) NX_NUMBER {units=NX_ANGLE} ⤆

Polar angle of the detector in the vertical ...

Polar angle of the detector in the vertical Rowland plane.

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: rotation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [0, -1, 0]

@depends_on: (optional) NX_CHAR ⤆

Obligatory value: detector_azimuthal_angle

detector_azimuthal_angle: (optional) NX_NUMBER {units=NX_ANGLE} ⤆

Azimuthal (horizontal) angle of the detector ...

Azimuthal (horizontal) angle of the detector from the incident beam direction. Should match the analyzer azimuthal angle for on-Rowland focusing.

@transformation_type: (optional) NX_CHAR ⤆

Obligatory value: rotation

@vector: (optional) NX_NUMBER ⤆

Obligatory value: [0, 0, 1]

@depends_on: (optional) NX_CHAR ⤆

Should point to the sample.

PROCESS: (optional) NXprocess

Description of how the intensity was obtained from ...

Description of how the intensity was obtained from the raw detector data (i0, if).

program: (optional) NX_CHAR ⤆

Name of the program used for processing.

version: (optional) NX_CHAR ⤆

Version of the program used for processing.

date: (optional) NX_DATE_TIME ⤆

Date and time of processing.

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/nexusformat/definitions/blob/main/base_classes/NXherfd.nxdl.xml