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

.. index::
    ! NXsingle_crystal (base class)
    ! single_crystal (base class)
    see: single_crystal (base class); NXsingle_crystal

.. _NXsingle_crystal:

================
NXsingle_crystal
================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Description of a single crystal material or a single crystalline phase in a mate ...

      Description of a single crystal material or a single crystalline phase in a material.

      There is the option of using Busing-Levy convention (as orginally designed in NXsample)
      or using a more detailed description with NXrotation_set.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXrotation_set`, :ref:`NXunit_cell`

.. index:: NXrotation_set (base class); used in base class, NXunit_cell (base class); used in base class

**Structure**:

  .. _/NXsingle_crystal/sample_orientation-field:

  .. index:: sample_orientation (field)

  **sample_orientation**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

    .. collapse:: This will follow the Busing-Levy convention: ...

        This will follow the Busing-Levy convention:
        W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464

  .. _/NXsingle_crystal/orientation_matrix-field:

  .. index:: orientation_matrix (field)

  **orientation_matrix**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 2, Dimensions: [3, 3]) 

    .. collapse:: Orientation matrix of single crystal sample using Busing-Levy convention: ...

        Orientation matrix of single crystal sample using Busing-Levy convention:
        W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464

  .. _/NXsingle_crystal/ub_matrix-field:

  .. index:: ub_matrix (field)

  **ub_matrix**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 2, Dimensions: [3, 3]) 

    .. collapse:: UB matrix of single crystal sample using Busing-Levy convention: ...

        UB matrix of single crystal sample using Busing-Levy convention:
        W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464. This is
        the multiplication of the orientation_matrix, given above,
        with the :math:`B` matrix which can be derived from the lattice constants.

  .. _/NXsingle_crystal/rotation_set-group:

  **rotation_set**: (optional) :ref:`NXrotation_set` 

    Detailed description of single crystal orientation and misorientation.

  .. _/NXsingle_crystal/UNIT_CELL-group:

  **UNIT_CELL**: (optional) :ref:`NXunit_cell` 

    Unit cell of the single crystal.


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

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


* :ref:`/NXsingle_crystal/orientation_matrix-field </NXsingle_crystal/orientation_matrix-field>`
* :ref:`/NXsingle_crystal/rotation_set-group </NXsingle_crystal/rotation_set-group>`
* :ref:`/NXsingle_crystal/sample_orientation-field </NXsingle_crystal/sample_orientation-field>`
* :ref:`/NXsingle_crystal/ub_matrix-field </NXsingle_crystal/ub_matrix-field>`
* :ref:`/NXsingle_crystal/UNIT_CELL-group </NXsingle_crystal/UNIT_CELL-group>`

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