.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXmicrostructure_odf.nxdl.xml -- DO NOT EDIT .. index:: ! NXmicrostructure_odf (base class) ! microstructure_odf (base class) see: microstructure_odf (base class); NXmicrostructure_odf .. _NXmicrostructure_odf: ==================== NXmicrostructure_odf ==================== **Status**: *base class* (contribution), extends :ref:`NXprocess` **Description**: .. collapse:: Base class to store an orientation distribution function (ODF). ... Base class to store an orientation distribution function (ODF). An orientation distribution function is a probability distribution that details how much volume of material has a specific orientation. An ODF is computed from pole figure data in a computational process called `pole figure inversion `_. **Symbols**: **n_varphi_two**: Number of pixel per varphi section plot along the :math:`\varphi_2` slow direction. **n_capital_phi**: Number of pixel per varphi section plot along the :math:`\Phi` fast direction. **n_varphi_one**: Number of pixel per varphi section plot along the :math:`\varphi_1` fastest direction. **k**: Number of local maxima evaluated in the component analysis. **n_pos**: Number of sampled positions in orientation space. **Groups cited**: :ref:`NXdata`, :ref:`NXparameters`, :ref:`NXprocess` .. index:: NXparameters (base class); used in base class, NXprocess (base class); used in base class, NXdata (base class); used in base class **Structure**: .. _/NXmicrostructure_odf/configuration-group: **configuration**: (optional) :ref:`NXparameters` :ref:`⤆ ` Details about the algorithm used for computing the ODF. .. _/NXmicrostructure_odf/configuration/crystal_symmetry_point_group-field: .. index:: crystal_symmetry_point_group (field) **crystal_symmetry_point_group**: (optional) :ref:`NX_CHAR ` .. collapse:: Point group of the crystal structure of the phase for which the here documen ... Point group of the crystal structure of the phase for which the here documented phase-dependent ODF was computed following the notation of the International Table of Crystallography. .. _/NXmicrostructure_odf/configuration/specimen_symmetry_point_group-field: .. index:: specimen_symmetry_point_group (field) **specimen_symmetry_point_group**: (optional) :ref:`NX_CHAR ` .. collapse:: Point group assumed for additionally considered sample symmetries ... Point group assumed for additionally considered sample symmetries following the notation of the International Table of Crystallography. .. _/NXmicrostructure_odf/configuration/kernel_halfwidth-field: .. index:: kernel_halfwidth (field) **kernel_halfwidth**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} Halfwidth of the kernel. .. _/NXmicrostructure_odf/configuration/kernel_name-field: .. index:: kernel_name (field) **kernel_name**: (optional) :ref:`NX_CHAR ` Name of the kernel. .. _/NXmicrostructure_odf/configuration/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} Resolution of the kernel. .. _/NXmicrostructure_odf/characteristics-group: **characteristics**: (optional) :ref:`NXprocess` Group to store descriptors for a rough classification of an ODF. .. _/NXmicrostructure_odf/characteristics/texture_index-field: .. index:: texture_index (field) **texture_index**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} .. collapse:: The texture index :math:`t = \int_{\mathcal{SO(3)}} f(R)^{2}dR` with :math:` ... The texture index :math:`t = \int_{\mathcal{SO(3)}} f(R)^{2}dR` with :math:`f(R)`, denoting the ODF is evaluated in orientation space :math:`\mathcal{SO(3)}`. The higher it is the texture index the sharper it is the ODF. .. _/NXmicrostructure_odf/kth_extrema-group: **kth_extrema**: (optional) :ref:`NXprocess` Group to store descriptors and summary statistics for extrema of the ODF. .. _/NXmicrostructure_odf/kth_extrema/extrema-field: .. index:: extrema (field) **extrema**: (optional) :ref:`NX_CHAR ` .. collapse:: Minima or maxima, if extrema is set to minima values for location and volume ... Minima or maxima, if extrema is set to minima values for location and volume_fraction are sorted in increasing order. If extrema is set to maxima values for location and volume_fraction are sorted in decreasing order. Therefore, the global extremum is always the first entry in location and volume_fraction. Any of these values: ``minima`` | ``maxima`` .. _/NXmicrostructure_odf/kth_extrema/kth-field: .. index:: kth (field) **kth**: (optional) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} Number of local extrema evaluated .. _/NXmicrostructure_odf/kth_extrema/theta-field: .. index:: theta (field) **theta**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} .. collapse:: Disorientation threshold within which intensity of the ODF ... Disorientation threshold within which intensity of the ODF is integrated for the component analysis. .. _/NXmicrostructure_odf/kth_extrema/location-field: .. index:: location (field) **location**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [k, 3]) {units=\ :ref:`NX_ANGLE `} .. collapse:: Euler angle representation :math:`\varphi_1`, :math:`\Phi`, :math:`\varphi_2 ... Euler angle representation :math:`\varphi_1`, :math:`\Phi`, :math:`\varphi_2` of the kth-most maxima in decreasing order of the intensity maximum. .. _/NXmicrostructure_odf/kth_extrema/volume_fraction-field: .. index:: volume_fraction (field) **volume_fraction**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [k]) {units=\ :ref:`NX_ANY `} .. collapse:: Integrated ODF intensity within a theta angular region of the orientation sp ... Integrated ODF intensity within a theta angular region of the orientation space :math:`SO3` about each location (obeying symmetries) as specified for each location. .. _/NXmicrostructure_odf/sampling-group: **sampling**: (optional) :ref:`NXprocess` The ODF intensity values (weights) as sampled with a software. .. _/NXmicrostructure_odf/sampling/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} Sampling resolution .. _/NXmicrostructure_odf/sampling/euler-field: .. index:: euler (field) **euler**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [n_pos, 3]) {units=\ :ref:`NX_ANGLE `} .. collapse:: Bunge-Euler (i.e. ZXZ convention) locations of each position ... Bunge-Euler (i.e. ZXZ convention) locations of each position in orientation space for which a weight was sampled. .. _/NXmicrostructure_odf/sampling/weight-field: .. index:: weight (field) **weight**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_pos]) {units=\ :ref:`NX_DIMENSIONLESS `} Weight at each sampled position following the order in euler. .. _/NXmicrostructure_odf/phi_two_plot-group: **phi_two_plot**: (optional) :ref:`NXdata` :ref:`⤆ ` .. collapse:: Visualization of the ODF intensity as discretized orthogonal sections through ... Visualization of the ODF intensity as discretized orthogonal sections through orientation space parameterized using Bunge-Euler angles. This is one example of typical default plots used in the texture community in materials engineering. Mind that the orientation space is a distorted space when it using an Euler angle parameterization. Therefore, equivalent orientations show intensity contributions in eventually multiple locations. .. _/NXmicrostructure_odf/phi_two_plot/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [n_varphi_two, n_capital_phi, n_varphi_one]) {units=\ :ref:`NX_DIMENSIONLESS `} .. collapse:: ODF intensity at probed locations relative to the intensity of the null mode ... ODF intensity at probed locations relative to the intensity of the null model of a random texture. .. _/NXmicrostructure_odf/phi_two_plot/varphi_one-field: .. index:: varphi_one (field) **varphi_one**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_varphi_one]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` Pixel center angular position along the :math:`\varphi_1` direction. .. _/NXmicrostructure_odf/phi_two_plot/capital_phi-field: .. index:: capital_phi (field) **capital_phi**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_capital_phi]) {units=\ :ref:`NX_ANGLE `} Pixel center angular position along the :math:`\Phi` direction. .. _/NXmicrostructure_odf/phi_two_plot/varphi_two-field: .. index:: varphi_two (field) **varphi_two**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_varphi_two]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` Pixel center angular position along the :math:`\varphi_2` direction. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXmicrostructure_odf/characteristics-group ` * :ref:`/NXmicrostructure_odf/characteristics/texture_index-field ` * :ref:`/NXmicrostructure_odf/configuration-group ` * :ref:`/NXmicrostructure_odf/configuration/crystal_symmetry_point_group-field ` * :ref:`/NXmicrostructure_odf/configuration/kernel_halfwidth-field ` * :ref:`/NXmicrostructure_odf/configuration/kernel_name-field ` * :ref:`/NXmicrostructure_odf/configuration/resolution-field ` * :ref:`/NXmicrostructure_odf/configuration/specimen_symmetry_point_group-field ` * :ref:`/NXmicrostructure_odf/kth_extrema-group ` * :ref:`/NXmicrostructure_odf/kth_extrema/extrema-field ` * :ref:`/NXmicrostructure_odf/kth_extrema/kth-field ` * :ref:`/NXmicrostructure_odf/kth_extrema/location-field ` * :ref:`/NXmicrostructure_odf/kth_extrema/theta-field ` * :ref:`/NXmicrostructure_odf/kth_extrema/volume_fraction-field ` * :ref:`/NXmicrostructure_odf/phi_two_plot-group ` * :ref:`/NXmicrostructure_odf/phi_two_plot/capital_phi-field ` * :ref:`/NXmicrostructure_odf/phi_two_plot/intensity-field ` * :ref:`/NXmicrostructure_odf/phi_two_plot/varphi_one-field ` * :ref:`/NXmicrostructure_odf/phi_two_plot/varphi_two-field ` * :ref:`/NXmicrostructure_odf/sampling-group ` * :ref:`/NXmicrostructure_odf/sampling/euler-field ` * :ref:`/NXmicrostructure_odf/sampling/resolution-field ` * :ref:`/NXmicrostructure_odf/sampling/weight-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmicrostructure_odf.nxdl.xml