.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXmicrostructure_pf.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXmicrostructure_pf (base class)
    ! microstructure_pf (base class)
    see: microstructure_pf (base class); NXmicrostructure_pf

.. _NXmicrostructure_pf:

===================
NXmicrostructure_pf
===================

**Status**:

  *base class* (contribution), extends :ref:`NXprocess`

**Description**:

  .. collapse:: Base class to store a pole figure (PF) computation. ...

      Base class to store a pole figure (PF) computation.

      A pole figure is the X-ray diffraction intensity for specific integrated
      peaks for a hemispherical illumination of a real or virtual specimen.

**Symbols**:


  **n_y**: Number of pixel per pole figure in the slow direction.

  **n_x**: Number of pixel per pole figure in the fast direction.

**Groups cited**:
  :ref:`NXdata`, :ref:`NXparameters`

.. index:: NXparameters (base class); used in base class, NXdata (base class); used in base class

**Structure**:

  .. _/NXmicrostructure_pf/configuration-group:

  **configuration**: (optional) :ref:`NXparameters` :ref:`⤆ </NXprocess/PARAMETERS-group>`

    Details about the algorithm that was used to compute the pole figure.

    .. _/NXmicrostructure_pf/configuration/crystal_symmetry_point_group-field:

    .. index:: crystal_symmetry_point_group (field)

    **crystal_symmetry_point_group**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

      .. collapse:: Point group of the crystal structure of the phase for which the pole figure  ...

          Point group of the crystal structure of the phase for which the pole figure was
          computed following the notation of the International Table of Crystallography.

    .. _/NXmicrostructure_pf/configuration/specimen_symmetry_point_group-field:

    .. index:: specimen_symmetry_point_group (field)

    **specimen_symmetry_point_group**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

      .. collapse:: Point group of assumed sample symmetries following the ...

          Point group of assumed sample symmetries following the
          notation of the International Table of Crystallography.

    .. _/NXmicrostructure_pf/configuration/halfwidth-field:

    .. index:: halfwidth (field)

    **halfwidth**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

      Halfwidth of the kernel.

    .. _/NXmicrostructure_pf/configuration/miller_indices-field:

    .. index:: miller_indices (field)

    **miller_indices**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

      .. collapse:: Miller (:math:`(hkl)[uvw]`) or Miller-Bravais indices used to specify the po ...

          Miller (:math:`(hkl)[uvw]`) or Miller-Bravais indices used to specify the pole
          figure.

    .. _/NXmicrostructure_pf/configuration/resolution-field:

    .. index:: resolution (field)

    **resolution**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

      Resolution of the kernel.

  .. _/NXmicrostructure_pf/pf-group:

  **pf**: (optional) :ref:`NXdata` :ref:`⤆ </NXprocess/DATA-group>`

    Pole figure.

    .. _/NXmicrostructure_pf/pf/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [n_y, n_x]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

      Pole figure intensity.

    .. _/NXmicrostructure_pf/pf/axis_y-field:

    .. index:: axis_y (field)

    **axis_y**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

      .. collapse:: Pixel center along y direction in the equatorial plane of ...

          Pixel center along y direction in the equatorial plane of
          a stereographic projection of the unit sphere.

    .. _/NXmicrostructure_pf/pf/axis_x-field:

    .. index:: axis_x (field)

    **axis_x**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

      .. collapse:: Pixel center along x direction in the equatorial plane of ...

          Pixel center along x direction in the equatorial plane of
          a stereographic projection of the unit sphere.


Hypertext Anchors
-----------------

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


* :ref:`/NXmicrostructure_pf/configuration-group </NXmicrostructure_pf/configuration-group>`
* :ref:`/NXmicrostructure_pf/configuration/crystal_symmetry_point_group-field </NXmicrostructure_pf/configuration/crystal_symmetry_point_group-field>`
* :ref:`/NXmicrostructure_pf/configuration/halfwidth-field </NXmicrostructure_pf/configuration/halfwidth-field>`
* :ref:`/NXmicrostructure_pf/configuration/miller_indices-field </NXmicrostructure_pf/configuration/miller_indices-field>`
* :ref:`/NXmicrostructure_pf/configuration/resolution-field </NXmicrostructure_pf/configuration/resolution-field>`
* :ref:`/NXmicrostructure_pf/configuration/specimen_symmetry_point_group-field </NXmicrostructure_pf/configuration/specimen_symmetry_point_group-field>`
* :ref:`/NXmicrostructure_pf/pf-group </NXmicrostructure_pf/pf-group>`
* :ref:`/NXmicrostructure_pf/pf/axis_x-field </NXmicrostructure_pf/pf/axis_x-field>`
* :ref:`/NXmicrostructure_pf/pf/axis_y-field </NXmicrostructure_pf/pf/axis_y-field>`
* :ref:`/NXmicrostructure_pf/pf/intensity-field </NXmicrostructure_pf/pf/intensity-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmicrostructure_pf.nxdl.xml