2.3.3.3.59. NXmicrostructure_ipf

Status:

base class (contribution), extends NXprocess

Description:

Base class to store an inverse pole figure (IPF) mapping (IPF map).

Symbols:

v: Number of pixel along the slow direction used for the IPF color key.

u: Number of pixel along the fast direction used for the IPF color key.

n_z: Number of pixel along the slowest direction, typically labeled z or k.

n_y: Number of pixel along the slow direction, typically labeled y or j.

n_x: Number of pixel along the fast direction, typically labeled x or i.

n_rgb: Number of RGB values along the fastest direction, always three.

Groups cited:

NXcg_grid, NXdata

Structure:

depends_on: (optional) NX_CHAR

Reference to an instance of :ref:`NXcoordinate_system` in which the axes axis_ ...

Reference to an instance of NXcoordinate_system in which the axes axis_z, axis_y, and axis_x are defined.

color_model: (optional) NX_CHAR

The algorithm whereby orientations are colored. ...

The algorithm whereby orientations are colored.

Any of these values: tsl | mtex

projection_direction: (optional) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_UNITLESS}

The direction normal vector along which orientations are projected.

@depends_on: (optional) NX_CHAR

Reference to an instance of :ref:`NXcoordinate_system` in which the projecti ...

Reference to an instance of NXcoordinate_system in which the projection_direction is defined.

If the field depends_on is not provided but parents of the instance of this base class or its specializations define an instance of NXcoordinate_system, projection_direction is defined in this coordinate system.

If nothing is provided, it is assumed that projection_direction is defined in the McStas coordinate system.

interpolation: (optional) NX_CHAR

How where orientation values at positions of input_grid computed to values on ...

How where orientation values at positions of input_grid computed to values on output_grid.

Nearest neighbour means the orientation of the closed (Euclidean distance) grid point of the input_grid was taken.

Obligatory value: nearest_neighbour

input_grid: (optional) NXcg_grid

Details about the original grid, i.e. the grid for which the IPF map was compu ...

Details about the original grid, i.e. the grid for which the IPF map was computed when that IPF map was exported from the tech partner’s file format representation.

output_grid: (optional) NXcg_grid

Details about the grid onto which the IPF is recomputed. ...

Details about the grid onto which the IPF is recomputed.

Rescaling the visualization of the IPF map may be needed to enable visualization in specific software tools like H5Web.

map: (optional) NXdata

Inverse pole figure mapping. ...

Inverse pole figure mapping.

Instances named phase0 should by definition refer to the null phase notIndexed. Inspect the definition of NXphase and its field phase_id for further details.

Details about possible regridding and associated interpolation during the computation of the IPF map visualization can be stored using the input_grid, output_grid, and interpolation fields.

The main purpose of this map is to offer a normalized default representation of the IPF map for consumption by a research data management system (RDMS).

data: (optional) NX_NUMBER {units=NX_UNITLESS}

Inverse pole figure color code for each map coordinate. ...

Inverse pole figure color code for each map coordinate.

Different types of AXISNAME dimensional scale axes are found in practice. A few examples:

  • No scaling, e.g. pixel position values like 0, 1, 2, 3 pixel. Pixels on the map can be distinguished but that map is disconnected from any sample surface context and eventually physical scaling

  • Scaling but no offset, e.g. calibrated pixel position 0., 0.5, 1.0, 1.5 micron. Pixels on the map can be compared for their distance to obtain e.g. size of features but the position of the map relative to the e.g. the sample surface is unclear. For IPF maps this is the most frequently reported situation.

  • Scaling and offset, which resolves also the absolute position of the map in relation to the sample surface. This is useful information for stitching multiple mappings together and other processing where precise and accurate position data are relevant e.g. for correlative materials characterization.

Three types of dimensional constraints for maps are possible:

  • (n_x, 3), a one-dimensional map, typically used for coarse sampling and crystal size statistics.

  • (n_y, n_x, 3), a two-dimensional map, the most frequently found reported

  • (n_z, n_y, n_x, 3), a three-dimensional map, these are commonly generated using computational methods, or in cases multiple EBSD maps have been stitched/reconstructed into a three-dimensional map.

axis_z: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_z]) {units=NX_LENGTH}

Pixel center coordinate calibrated for step size along the z axis of the map.

axis_y: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_y]) {units=NX_LENGTH}

Pixel center coordinate calibrated for step size along the y axis of the map.

axis_x: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_x]) {units=NX_LENGTH}

Pixel center coordinate calibrated for step size along the x axis of the map.

legend: (optional) NXdata

The color code which maps color to orientation in the fundamental zone. ...

The color code which maps color to orientation in the fundamental zone.

For each stereographic standard triangle (SST), i.e. a rendering of the fundamental zone of the crystal-symmetry-reduced orientation space SO3, it is possible to define a color model which assigns a color to each point in the fundamental zone.

Different mapping models are used. These implement (slightly) different scaling relations. Differences exist across representations of tech partners.

Differences are which base colors of the RGB color model are placed in which extremal position of the SST and where the white point is located.

For further details see:

Details are implementation-specific and not standardized yet.

data: (optional) NX_NUMBER (Rank: 3, Dimensions: [v, u, 3]) {units=NX_ANY}

Inverse pole figure color code for each map coordinate.

axis_y: (optional) NX_NUMBER (Rank: 1, Dimensions: [v]) {units=NX_UNITLESS}

Pixel along the y-axis.

axis_x: (optional) NX_NUMBER (Rank: 1, Dimensions: [u]) {units=NX_UNITLESS}

Pixel along the x-axis.

Hypertext Anchors

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

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmicrostructure_ipf.nxdl.xml