.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXimage_set_em_kikuchi.nxdl.xml .. index:: ! NXimage_set_em_kikuchi (base class) ! image_set_em_kikuchi (base class) see: image_set_em_kikuchi (base class); NXimage_set_em_kikuchi .. _NXimage_set_em_kikuchi: ====================== NXimage_set_em_kikuchi ====================== **Status**: base class, extends :ref:`NXobject` **Description**: Electron backscatter diffraction (EBSD) Kikuchi pattern. The container can also store data related to a post-processing of these Kikuchi pattern, which is the backbone of orientation microscopy especially in materials science and materials engineering. Based on a fuse of the `M. A. Jackson et al. `_ of the DREAM.3D community and the open H5OINA format of Oxford Instruments `P. Pinard et al. `_ EBSD can be used, usually with FIB/SEM microscopes, for three-dimensional orientation microscopy. So-called serial section analyses. For a detailed overview of these techniques see e.g. * `M. A. Groeber et al. `_ * `A. J. Schwartz et al. `_ * `P. A. Rottman et al. `_ With serial-sectioning this involves however always a sequence of measuring, milling. In this regard, each serial section (measuring) and milling is an own NXevent_data_em instance and thus there such a three-dimensional characterization should be stored as a set of two-dimensional data, with as many NXevent_data_em instances as sections were measured. These measured serial sectioning images need virtually always post-processing to arrive at the aligned and cleaned image stack respective digital microstructure representation as (a representative) volume element. Several software packages are available for this post-processing. For now we do not consider metadata of these post-processing steps as a part of this base class. **Symbols**: **n_p**: Number of scan points, one pattern per scan point. **n_y**: Number of pixel per Kikuchi pattern in the slow direction **n_x**: Number of pixel per Kikuchi pattern in the fast direction **Groups cited**: :ref:`NXcollection`, :ref:`NXdata`, :ref:`NXprocess` .. index:: NXdata (base class); used in base class, NXprocess (base class); used in base class, NXcollection (base class); used in base class **Structure**: .. _/NXimage_set_em_kikuchi/grid_type-field: .. index:: grid_type (field) **grid_type**: (optional) :ref:`NX_CHAR ` Which pixel primitive shape is used. Any of these values: ``square`` | ``hexagon`` .. _/NXimage_set_em_kikuchi/step_size-field: .. index:: step_size (field) **step_size**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_LENGTH `} The prescribed step size. First value is for the slow changing, second value is for the fast changing dimension. .. _/NXimage_set_em_kikuchi/DATA-group: **DATA**: (optional) :ref:`NXdata` Collected Kikuchi pattern as an image stack. .. _/NXimage_set_em_kikuchi/DATA/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [n_p, n_y, n_x]) {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/DATA/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Kikuchi pattern intensity .. _/NXimage_set_em_kikuchi/DATA/image_id-field: .. index:: image_id (field) **image_id**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/DATA/image_id@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Kikuchi pattern identifier .. _/NXimage_set_em_kikuchi/DATA/ypos-field: .. index:: ypos (field) **ypos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH `} .. _/NXimage_set_em_kikuchi/DATA/ypos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the y axis .. _/NXimage_set_em_kikuchi/DATA/xpos-field: .. index:: xpos (field) **xpos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH `} .. _/NXimage_set_em_kikuchi/DATA/xpos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the x axis .. _/NXimage_set_em_kikuchi/calibration-group: **calibration**: (optional) :ref:`NXprocess` .. _/NXimage_set_em_kikuchi/oim-group: **oim**: (optional) :ref:`NXprocess` OIM, orientation imaging microscopy. Post-processing of the Kikuchi pattern to identify orientations. .. _/NXimage_set_em_kikuchi/oim/pattern_quality-field: .. index:: pattern_quality (field) **pattern_quality**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/oim/pattern_center-field: .. index:: pattern_center (field) **pattern_center**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_LENGTH `} .. _/NXimage_set_em_kikuchi/oim/detector_distance-field: .. index:: detector_distance (field) **detector_distance**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_LENGTH `} .. _/NXimage_set_em_kikuchi/oim/background_correction-group: **background_correction**: (optional) :ref:`NXprocess` Details about the background correction applied to each Kikuchi pattern. .. _/NXimage_set_em_kikuchi/oim/band_detection-group: **band_detection**: (optional) :ref:`NXprocess` .. _/NXimage_set_em_kikuchi/oim/band_detection/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` How are Kikuchi bands detected Obligatory value: ``center`` .. _/NXimage_set_em_kikuchi/oim/band_detection/band_contrast-field: .. index:: band_contrast (field) **band_contrast**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/oim/band_detection/band_slope-field: .. index:: band_slope (field) **band_slope**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/oim/band_detection/bands-field: .. index:: bands (field) **bands**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} How many bands were detected in the pattern. .. _/NXimage_set_em_kikuchi/oim/indexing-group: **indexing**: (optional) :ref:`NXprocess` .. _/NXimage_set_em_kikuchi/oim/indexing/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` How are pattern being indexed? Obligatory value: ``optimize_bd`` .. _/NXimage_set_em_kikuchi/oim/indexing/min_bands-field: .. index:: min_bands (field) **min_bands**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) Minimum number of bands required to index the pattern .. _/NXimage_set_em_kikuchi/oim/indexing/status-field: .. index:: status (field) **status**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} Which return value did the indexing algorithm yield for each pattern. * Details about bad pixels * Too high angular deviation * No solution * Not analyzed * Success * Unexpected errors .. _/NXimage_set_em_kikuchi/oim/indexing/phase_identifier-field: .. index:: phase_identifier (field) **phase_identifier**: (optional) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} Labels referring to the phase_identifier for each pattern (from reflectors) that matched best. .. _/NXimage_set_em_kikuchi/oim/indexing/mean_angular_deviation-field: .. index:: mean_angular_deviation (field) **mean_angular_deviation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_ANGLE `} .. _/NXimage_set_em_kikuchi/oim/indexing/confidence_index-field: .. index:: confidence_index (field) **confidence_index**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/oim/indexing/reflector-group: **reflector**: (optional) :ref:`NXcollection` Lattice planes used as reflectors for indexing pattern in electron-backscatter diffraction (EBSD). One collection for each reflector. .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/unit_cell_abc-field: .. index:: unit_cell_abc (field) **unit_cell_abc**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} Crystallography unit cell parameters a, b, and c .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/unit_cell_alphabetagamma-field: .. index:: unit_cell_alphabetagamma (field) **unit_cell_alphabetagamma**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_ANGLE `} Crystallography unit cell parameters alpha, beta, and gamma .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/unit_cell_class-field: .. index:: unit_cell_class (field) **unit_cell_class**: (optional) :ref:`NX_CHAR ` Any of these values: * ``triclinic`` * ``monoclinic`` * ``orthorhombic`` * ``tetragonal`` * ``rhombohedral`` * ``hexagonal`` * ``cubic`` .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/space_group-field: .. index:: space_group (field) **space_group**: (optional) :ref:`NX_CHAR ` Crystallographic space group .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/laue_group-field: .. index:: laue_group (field) **laue_group**: (optional) :ref:`NX_CHAR ` Laue group .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/phase_identifier-field: .. index:: phase_identifier (field) **phase_identifier**: (optional) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} Numeral identifier for each phase. The value 0 is reversed for the unknown phase. .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/phase_name-field: .. index:: phase_name (field) **phase_name**: (optional) :ref:`NX_CHAR ` Name of the phase/alias. .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/number_of_reflectors-field: .. index:: number_of_reflectors (field) **number_of_reflectors**: (optional) :ref:`NX_UINT ` .. _/NXimage_set_em_kikuchi/oim/indexing/reflector/miller_indices-field: .. index:: miller_indices (field) **miller_indices**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [number_of_reflectors, 6]) {units=\ :ref:`NX_UNITLESS `} Miller indices :math:`(hkl)[uvw]`. .. _/NXimage_set_em_kikuchi/binning-group: **binning**: (optional) :ref:`NXcollection` .. _/NXimage_set_em_kikuchi/binning/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` Free-text description for instrument specific settings .. _/NXimage_set_em_kikuchi/binning/binning-field: .. index:: binning (field) **binning**: (optional) :ref:`NX_UINT ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_UNITLESS `} How is the camera signal binned. First the number of pixel along the slow direction. Second the number of pixel along the fast direction. .. _/NXimage_set_em_kikuchi/hough_transformation-group: **hough_transformation**: (optional) :ref:`NXprocess` .. _/NXimage_set_em_kikuchi/hough_transformation/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} .. _/NXimage_set_em_kikuchi/profiling-group: **profiling**: (optional) :ref:`NXcollection` .. _/NXimage_set_em_kikuchi/profiling/acquisition_speed-field: .. index:: acquisition_speed (field) **acquisition_speed**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_FREQUENCY `} Average number of patterns taken on average. .. _/NXimage_set_em_kikuchi/profiling/acquisition_time-field: .. index:: acquisition_time (field) **acquisition_time**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} Wall-clock time the acquisition took. .. _/NXimage_set_em_kikuchi/profiling/hit_rate-field: .. index:: hit_rate (field) **hit_rate**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} Fraction of successfully indexed pattern of the set. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXimage_set_em_kikuchi/binning-group ` * :ref:`/NXimage_set_em_kikuchi/binning/binning-field ` * :ref:`/NXimage_set_em_kikuchi/binning/mode-field ` * :ref:`/NXimage_set_em_kikuchi/calibration-group ` * :ref:`/NXimage_set_em_kikuchi/DATA-group ` * :ref:`/NXimage_set_em_kikuchi/DATA/image_id-field ` * :ref:`/NXimage_set_em_kikuchi/DATA/image_id@long_name-attribute ` * :ref:`/NXimage_set_em_kikuchi/DATA/intensity-field ` * :ref:`/NXimage_set_em_kikuchi/DATA/intensity@long_name-attribute ` * :ref:`/NXimage_set_em_kikuchi/DATA/xpos-field ` * :ref:`/NXimage_set_em_kikuchi/DATA/xpos@long_name-attribute ` * :ref:`/NXimage_set_em_kikuchi/DATA/ypos-field ` * :ref:`/NXimage_set_em_kikuchi/DATA/ypos@long_name-attribute ` * :ref:`/NXimage_set_em_kikuchi/grid_type-field ` * :ref:`/NXimage_set_em_kikuchi/hough_transformation-group ` * :ref:`/NXimage_set_em_kikuchi/hough_transformation/resolution-field ` * :ref:`/NXimage_set_em_kikuchi/oim-group ` * :ref:`/NXimage_set_em_kikuchi/oim/background_correction-group ` * :ref:`/NXimage_set_em_kikuchi/oim/band_detection-group ` * :ref:`/NXimage_set_em_kikuchi/oim/band_detection/band_contrast-field ` * :ref:`/NXimage_set_em_kikuchi/oim/band_detection/band_slope-field ` * :ref:`/NXimage_set_em_kikuchi/oim/band_detection/bands-field ` * :ref:`/NXimage_set_em_kikuchi/oim/band_detection/mode-field ` * :ref:`/NXimage_set_em_kikuchi/oim/detector_distance-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing-group ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/confidence_index-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/mean_angular_deviation-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/min_bands-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/mode-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/phase_identifier-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector-group ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/laue_group-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/miller_indices-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/number_of_reflectors-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/phase_identifier-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/phase_name-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/space_group-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/unit_cell_abc-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/unit_cell_alphabetagamma-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/reflector/unit_cell_class-field ` * :ref:`/NXimage_set_em_kikuchi/oim/indexing/status-field ` * :ref:`/NXimage_set_em_kikuchi/oim/pattern_center-field ` * :ref:`/NXimage_set_em_kikuchi/oim/pattern_quality-field ` * :ref:`/NXimage_set_em_kikuchi/profiling-group ` * :ref:`/NXimage_set_em_kikuchi/profiling/acquisition_speed-field ` * :ref:`/NXimage_set_em_kikuchi/profiling/acquisition_time-field ` * :ref:`/NXimage_set_em_kikuchi/profiling/hit_rate-field ` * :ref:`/NXimage_set_em_kikuchi/step_size-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXimage_set_em_kikuchi.nxdl.xml