.. 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, extends :ref:`NXxrd` **Description**: NXxrd_pan is a specialisation of NXxrd with exptra properties **Symbols**: No symbol table **Groups cited**: :ref:`NXcollection`, :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :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, NXcollection (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: **ENTRY**: (required) :ref:`NXentry` :ref:`⤆ ` .. _/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)' Obligatory value: ``X-Ray Diffraction (XRD)`` .. _/NXxrd_pan/ENTRY/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXxrd_pan/ENTRY/INSTRUMENT/SOURCE-group: **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: ``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 ` Obligatory value: ``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 ` Obligatory value: ``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 ` Obligatory value: ``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: **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/COLLECTION-group: **COLLECTION**: (optional) :ref:`NXcollection` :ref:`⤆ ` Collect user inputs e.g. name or path of the input file. .. _/NXxrd_pan/ENTRY/COLLECTION/data_file-field: .. index:: data_file (field) **data_file**: (optional) :ref:`NX_CHAR ` Name of the data file. .. _/NXxrd_pan/ENTRY/COLLECTION/measurement_type-field: .. index:: measurement_type (field) **measurement_type**: (required) :ref:`NX_CHAR ` Type of measurement. .. _/NXxrd_pan/ENTRY/COLLECTION/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/COLLECTION/goniometer_x-field: .. index:: goniometer_x (field) **goniometer_x**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Goniometer position X. .. _/NXxrd_pan/ENTRY/COLLECTION/goniometer_y-field: .. index:: goniometer_y (field) **goniometer_y**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Goniometer position Y. .. _/NXxrd_pan/ENTRY/COLLECTION/goniometer_z-field: .. index:: goniometer_z (field) **goniometer_z**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Goniometer position Z .. _/NXxrd_pan/ENTRY/COLLECTION/count_time-field: .. index:: count_time (field) **count_time**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} Total time of count. .. _/NXxrd_pan/ENTRY/COLLECTION/2theta-group: **2theta**: (required) :ref:`NXcollection` .. _/NXxrd_pan/ENTRY/COLLECTION/2theta/start-field: .. index:: start (field) **start**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Starting value of the diffraction angle. .. _/NXxrd_pan/ENTRY/COLLECTION/2theta/end-field: .. index:: end (field) **end**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Ending value of the diffraction angle. .. _/NXxrd_pan/ENTRY/COLLECTION/2theta/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/COLLECTION/omega-group: **omega**: (required) :ref:`NXcollection` .. _/NXxrd_pan/ENTRY/COLLECTION/omega/start-field: .. index:: start (field) **start**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Starting value of the incident angle. .. _/NXxrd_pan/ENTRY/COLLECTION/omega/end-field: .. index:: end (field) **end**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Ending value of the incident angle. .. _/NXxrd_pan/ENTRY/COLLECTION/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/2theta_plot-group: **2theta_plot**: (required) :ref:`NXdata` :ref:`⤆ ` Desired plot would be two_theta vs intensity. .. _/NXxrd_pan/ENTRY/2theta_plot/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) Number of scattered electrons per unit time. .. _/NXxrd_pan/ENTRY/2theta_plot/two_theta-field: .. index:: two_theta (field) **two_theta**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) Axis scale represeting the 2-theta range of the difractogram. .. _/NXxrd_pan/ENTRY/2theta_plot/omega-field: .. index:: omega (field) **omega**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) The omega range of the difractogram. .. _/NXxrd_pan/ENTRY/2theta_plot/phi-field: .. index:: phi (field) **phi**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) The phi range of the difractogram .. _/NXxrd_pan/ENTRY/2theta_plot/chi-field: .. index:: chi (field) **chi**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nDet]) The chi range of the difractogram .. _/NXxrd_pan/ENTRY/q_plot-group: **q_plot**: (optional) :ref:`NXdata` :ref:`⤆ ` Desired plot would be q_vector vs intensity. .. _/NXxrd_pan/ENTRY/q_plot/q-field: .. index:: q (field) **q**: (required) :ref:`NX_FLOAT ` Axis scale representing wavevector for scatter energy. .. _/NXxrd_pan/ENTRY/q_plot/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_FLOAT ` Number of scattered electrons per unit time. .. _/NXxrd_pan/ENTRY/SAMPLE-group: **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 ` :ref:`⤆ ` 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 analysed, but sample might be identified b ... Usually in xrd sample are being analysed, but sample might be identified by assumed name or given name. .. _/NXxrd_pan/ENTRY/SAMPLE/prepared_by-field: .. index:: prepared_by (field) **prepared_by**: (required) :ref:`NX_CHAR ` 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/2theta_plot-group ` * :ref:`/NXxrd_pan/ENTRY/2theta_plot/chi-field ` * :ref:`/NXxrd_pan/ENTRY/2theta_plot/intensity-field ` * :ref:`/NXxrd_pan/ENTRY/2theta_plot/omega-field ` * :ref:`/NXxrd_pan/ENTRY/2theta_plot/phi-field ` * :ref:`/NXxrd_pan/ENTRY/2theta_plot/two_theta-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION-group ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/2theta-group ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/2theta/end-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/2theta/start-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/2theta/step-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/beam_attenuation_factors-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/count_time-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/data_file-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/goniometer_x-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/goniometer_y-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/goniometer_z-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/measurement_type-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/omega-group ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/omega/end-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/omega/start-field ` * :ref:`/NXxrd_pan/ENTRY/COLLECTION/omega/step-field ` * :ref:`/NXxrd_pan/ENTRY/definition-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/method-field ` * :ref:`/NXxrd_pan/ENTRY/q_plot-group ` * :ref:`/NXxrd_pan/ENTRY/q_plot/intensity-field ` * :ref:`/NXxrd_pan/ENTRY/q_plot/q-field ` * :ref:`/NXxrd_pan/ENTRY/SAMPLE-group ` * :ref:`/NXxrd_pan/ENTRY/SAMPLE/prepared_by-field ` * :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