.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXxrd_pan.nxdl.xml -- DO NOT EDIT .. index:: ! NXxrd_pan (application definition) ! xrd_pan (application definition) see: xrd_pan (application definition); NXxrd_pan .. _NXxrd_pan: ========= NXxrd_pan ========= **Status**: *application definition* (contribution), extends :ref:`NXxrd` **Description**: .. collapse:: NXxrd_pan is a specialization of NXxrd with extra properties ... NXxrd_pan is a specialization of NXxrd with extra properties for the PANalytical XRD data format. **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXobject`, :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, NXobject (base class); used in application definition, NXdata (base class); used in application definition, NXsample (base class); used in application definition **Structure**: .. _/NXxrd_pan/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXxrd_pan/ENTRY/data_file-field: .. index:: data_file (field) **data_file**: (optional) :ref:`NX_CHAR ` Name of the data file. .. _/NXxrd_pan/ENTRY/measurement_type-field: .. index:: measurement_type (field) **measurement_type**: (required) :ref:`NX_CHAR ` Type of measurement. .. _/NXxrd_pan/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: ``NXxrd_pan`` .. _/NXxrd_pan/ENTRY/method-field: .. index:: method (field) **method**: (required) :ref:`NX_CHAR ` .. collapse:: Method used to collect the data ... Method used to collect the data default='X-Ray Diffraction (XRD)' Any of these values or a custom value (if you use a custom value, also set @custom=True): ``X-Ray Diffraction (XRD)`` .. _/NXxrd_pan/ENTRY/INSTRUMENT-group: :bolditalic:`INSTRUMENT`: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE-group: :bolditalic:`SOURCE`: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/xray_tube_material-field: .. index:: xray_tube_material (field) **xray_tube_material**: (required) :ref:`NX_CHAR ` .. collapse:: Type of the X-ray tube. ... Type of the X-ray tube. Any of these values or a custom value (if you use a custom value, also set @custom=True): ``Cu`` | ``Cr`` | ``Mo`` | ``Fe`` | ``Ag`` | ``In`` | ``Ga`` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/xray_tube_current-field: .. index:: xray_tube_current (field) **xray_tube_current**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_CURRENT `} Current of the X-ray tube. .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/xray_tube_voltage-field: .. index:: xray_tube_voltage (field) **xray_tube_voltage**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} Voltage of the X-ray tube. .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_one-field: .. index:: k_alpha_one (field) **k_alpha_one**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} Wavelength of the K\u03b1 1 line. .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_one@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Any of these values or a custom value (if you use a custom value, also set @custom=True): ``angstrom`` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_two-field: .. index:: k_alpha_two (field) **k_alpha_two**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} Wavelength of the K\u03b1 2 line. .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_two@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Any of these values or a custom value (if you use a custom value, also set @custom=True): ``angstrom`` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/ratio_k_alphatwo_k_alphaone-field: .. index:: ratio_k_alphatwo_k_alphaone (field) **ratio_k_alphatwo_k_alphaone**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} K\u03b1 2/K\u03b1 1 intensity ratio. .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/kbeta-field: .. index:: kbeta (field) **kbeta**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} Wavelength of the K\u00df line. .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/kbeta@units-attribute: .. index:: units (field attribute) **@units**: (required) :ref:`NX_CHAR ` Any of these values or a custom value (if you use a custom value, also set @custom=True): ``angstrom`` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/source_peak_wavelength-field: .. index:: source_peak_wavelength (field) **source_peak_wavelength**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} Wavelength of the X-ray source. Used to convert from 2-theta to Q. .. _/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR-group: :bolditalic:`DETECTOR`: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR/scan_axis-field: .. index:: scan_axis (field) **scan_axis**: (required) :ref:`NX_CHAR ` Axis scanned. .. _/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR/scan_mode-field: .. index:: scan_mode (field) **scan_mode**: (required) :ref:`NX_CHAR ` Mode of scan. .. _/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR/integration_time-field: .. index:: integration_time (field) **integration_time**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} Integration time per channel. .. _/NXxrd_pan/ENTRY/experiment_config-group: **experiment_config**: (optional) :ref:`NXobject` Collect user inputs e.g. name or path of the input file. .. _/NXxrd_pan/ENTRY/experiment_config/beam_attenuation_factors-field: .. index:: beam_attenuation_factors (field) **beam_attenuation_factors**: (required) :ref:`NX_CHAR ` Beam attenuation factors over the path. .. _/NXxrd_pan/ENTRY/experiment_config/goniometer_x-field: .. index:: goniometer_x (field) **goniometer_x**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Goniometer position X. .. _/NXxrd_pan/ENTRY/experiment_config/goniometer_y-field: .. index:: goniometer_y (field) **goniometer_y**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Goniometer position Y. .. _/NXxrd_pan/ENTRY/experiment_config/goniometer_z-field: .. index:: goniometer_z (field) **goniometer_z**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Goniometer position Z .. _/NXxrd_pan/ENTRY/experiment_config/count_time-field: .. index:: count_time (field) **count_time**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} Total time of count. .. _/NXxrd_pan/ENTRY/experiment_config/two_theta-group: **two_theta**: (required) :ref:`NXobject` .. _/NXxrd_pan/ENTRY/experiment_config/two_theta/start-field: .. index:: start (field) **start**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Starting value of the diffraction angle. .. _/NXxrd_pan/ENTRY/experiment_config/two_theta/end-field: .. index:: end (field) **end**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Ending value of the diffraction angle. .. _/NXxrd_pan/ENTRY/experiment_config/two_theta/step-field: .. index:: step (field) **step**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Minimum step size in-between two diffraction angles. .. _/NXxrd_pan/ENTRY/experiment_config/omega-group: **omega**: (required) :ref:`NXobject` .. _/NXxrd_pan/ENTRY/experiment_config/omega/start-field: .. index:: start (field) **start**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Starting value of the incident angle. .. _/NXxrd_pan/ENTRY/experiment_config/omega/end-field: .. index:: end (field) **end**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Ending value of the incident angle. .. _/NXxrd_pan/ENTRY/experiment_config/omega/step-field: .. index:: step (field) **step**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Minimum step size in the between two incident angles. .. _/NXxrd_pan/ENTRY/experiment_result-group: **experiment_result**: (required) :ref:`NXdata` :ref:`⤆ ` .. collapse:: All experiment results data such as scattering angle (2theta), ... All experiment results data such as scattering angle (2theta), intensity, incident angle, scattering vector, etc will be stored here. .. _/NXxrd_pan/ENTRY/experiment_result/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) Number of scattered electrons per unit time. .. _/NXxrd_pan/ENTRY/experiment_result/two_theta-field: .. index:: two_theta (field) **two_theta**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_ANGLE `} Two-theta (scattering angle) of the diffractogram. .. _/NXxrd_pan/ENTRY/experiment_result/omega-field: .. index:: omega (field) **omega**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_ANGLE `} Incident angle of the diffractogram. .. _/NXxrd_pan/ENTRY/experiment_result/phi-field: .. index:: phi (field) **phi**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_ANGLE `} The phi range of the diffractogram. .. _/NXxrd_pan/ENTRY/experiment_result/chi-field: .. index:: chi (field) **chi**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_ANGLE `} The chi range of the diffractogram .. _/NXxrd_pan/ENTRY/experiment_result/q_parallel-field: .. index:: q_parallel (field) **q_parallel**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} The scattering vector component, which is parallel to the sample surface. .. _/NXxrd_pan/ENTRY/experiment_result/q_perpendicular-field: .. index:: q_perpendicular (field) **q_perpendicular**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} The scattering vector component, which is perpendicular to the sample surface. .. _/NXxrd_pan/ENTRY/experiment_result/q_norm-field: .. index:: q_norm (field) **q_norm**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. collapse:: The norm value of the scattering vector, q. The scattering vector is defin ... The norm value of the scattering vector, q. The scattering vector is defined as a difference between the incident and scattered wave vectors. For details: https://en.wikipedia.org/wiki/Powder_diffraction and https://theory.labster.com/scattering-vector/ .. _/NXxrd_pan/ENTRY/q_data-group: **q_data**: (optional) :ref:`NXdata` :ref:`⤆ ` The desired view for scattering vectors. .. _/NXxrd_pan/ENTRY/q_data/q-field: .. index:: q (field) **q**: (optional) :ref:`NX_FLOAT ` .. collapse:: This concept corresponds to the norm value of the scattering vector(q). ... This concept corresponds to the norm value of the scattering vector(q). The concept is the same as 'q_norm' of 'experiment_result' and should be linked to /entry[ENTRY]/experiment_result/q_norm. .. _/NXxrd_pan/ENTRY/q_data/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_FLOAT ` .. collapse:: Number of scattered electrons per unit time at each scattering vector (q) ... Number of scattered electrons per unit time at each scattering vector (q) value. The concept is the same as the 'intensity' of experiment_result and should be linked to /entry[ENTRY]/experiment_result/intensity. .. _/NXxrd_pan/ENTRY/q_data/q_parallel-field: .. index:: q_parallel (field) **q_parallel**: (optional) :ref:`NX_FLOAT ` .. collapse:: The scattering vector (q) component, which is parallel to the sample surfa ... The scattering vector (q) component, which is parallel to the sample surface. This component is used in the Reciprocal Space Mapping (RSM) technique of X-ray diffraction method. The concept is the same as 'q_parallel' of experiment_result, and should be linked to /entry[ENTRY]/experiment_result/q_parallel. .. _/NXxrd_pan/ENTRY/q_data/q_perpendicular-field: .. index:: q_perpendicular (field) **q_perpendicular**: (optional) :ref:`NX_FLOAT ` .. collapse:: The scattering vector component, which is perpendicular to the sample surf ... The scattering vector component, which is perpendicular to the sample surface. The concept is the same as 'q_perpendicular' of experiment_result, and should be linked to /entry[ENTRY]/experiment_result/q_perpendicular. .. _/NXxrd_pan/ENTRY/SAMPLE-group: :bolditalic:`SAMPLE`: (optional) :ref:`NXsample` :ref:`⤆ ` Description on sample. .. _/NXxrd_pan/ENTRY/SAMPLE/sample_mode-field: .. index:: sample_mode (field) **sample_mode**: (required) :ref:`NX_CHAR ` Mode of sample. .. _/NXxrd_pan/ENTRY/SAMPLE/sample_id-field: .. index:: sample_id (field) **sample_id**: (required) :ref:`NX_CHAR ` Id of sample. .. _/NXxrd_pan/ENTRY/SAMPLE/sample_name-field: .. index:: sample_name (field) **sample_name**: (required) :ref:`NX_CHAR ` .. collapse:: Usually in xrd sample are being analyzed, but sample might be identified b ... Usually in xrd sample are being analyzed, but sample might be identified by assumed name or given name. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXxrd_pan/ENTRY-group ` * :ref:`/NXxrd_pan/ENTRY/data_file-field ` * :ref:`/NXxrd_pan/ENTRY/definition-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config-group ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/beam_attenuation_factors-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/count_time-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/goniometer_x-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/goniometer_y-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/goniometer_z-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/omega-group ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/omega/end-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/omega/start-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/omega/step-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/two_theta-group ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/two_theta/end-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/two_theta/start-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_config/two_theta/step-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result-group ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/chi-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/intensity-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/omega-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/phi-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/q_norm-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/q_parallel-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/q_perpendicular-field ` * :ref:`/NXxrd_pan/ENTRY/experiment_result/two_theta-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT-group ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR-group ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR/integration_time-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR/scan_axis-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/DETECTOR/scan_mode-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE-group ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_one-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_one@units-attribute ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_two-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/k_alpha_two@units-attribute ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/kbeta-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/kbeta@units-attribute ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/ratio_k_alphatwo_k_alphaone-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/source_peak_wavelength-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/xray_tube_current-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/xray_tube_material-field ` * :ref:`/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE/xray_tube_voltage-field ` * :ref:`/NXxrd_pan/ENTRY/measurement_type-field ` * :ref:`/NXxrd_pan/ENTRY/method-field ` * :ref:`/NXxrd_pan/ENTRY/q_data-group ` * :ref:`/NXxrd_pan/ENTRY/q_data/intensity-field ` * :ref:`/NXxrd_pan/ENTRY/q_data/q-field ` * :ref:`/NXxrd_pan/ENTRY/q_data/q_parallel-field ` * :ref:`/NXxrd_pan/ENTRY/q_data/q_perpendicular-field ` * :ref:`/NXxrd_pan/ENTRY/SAMPLE-group ` * :ref:`/NXxrd_pan/ENTRY/SAMPLE/sample_id-field ` * :ref:`/NXxrd_pan/ENTRY/SAMPLE/sample_mode-field ` * :ref:`/NXxrd_pan/ENTRY/SAMPLE/sample_name-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXxrd_pan.nxdl.xml