2.3.3.3.159. NXms_recon

Status:

base class, extends NXobject

Description:

Base class to describe discretized (micro)structural features of a material. ...

Base class to describe discretized (micro)structural features of a material.

One instance of this base class can be used to describe the current configuration the base class does not include time-dependent descriptions for the sake of clarity and because of the fact that virtually all simulations or experiments probe time by sampling. Therefore, time-dependent state descriptions should be realized with creating a set of NXms_snapshot_set with instances of NXms_snapshot using e.g. NXms_recon base class instances.

Symbols:

The symbols used in the schema to specify e.g. dimensions of arrays.

n_c_two: The number of crystal projections.

n_i_two: The number of interface projections.

n_t_two: The number of assumed triple junction projections aka triple points.

n_c: The number of crystals.

n_i: The number of interfaces

n_t: The number of triple lines

n_q: The number of quadruple junctions.

Groups cited:

NXcg_point_set, NXcg_polyhedron_set, NXcg_polyline_set, NXcg_triangle_set, NXms_feature_set, NXprocess, NXrotation_set

Structure:

configuration: (optional) NXprocess

The configuration and parameterization of the reconstruction algorithm ...

The configuration and parameterization of the reconstruction algorithm whereby the microstructural features were identified.

dimensionality: (optional) NX_POSINT {units=NX_UNITLESS}

Dimensionality of the analysis. ...

Dimensionality of the analysis.

This field can be used e.g. by a research data management system to identify if the described feature set specifies a one-, two-, or three-dimensional feature set.

Any of these values: 1 | 2 | 3

algorithm: (optional) NX_CHAR

Which algorithm is used to reconstruct the features. ...

Which algorithm is used to reconstruct the features.

Any of these values:

  • unknown

  • disorientation_clustering

  • fast_multiscale_clustering

  • markov_chain_clustering

disorientation_threshold: (optional) NX_NUMBER {units=NX_ANGLE}

Threshold to define at which disorientation angle to assume ...

Threshold to define at which disorientation angle to assume two crystalline regions have a significant orientation difference which warrants to argue that there is an interface between the two regions.

points: (optional) NXcg_point_set

lines: (optional) NXcg_polyline_set

surfaces: (optional) NXcg_triangle_set

volumes: (optional) NXcg_polyhedron_set

crystal_projections: (optional) NXms_feature_set

Projections of crystals on the sample surface as typically ...

Projections of crystals on the sample surface as typically characterized with optical or electron microscopy.

@discretization: (optional) NX_CHAR

Reference to lines(NXcg_polyline_set) which supports the ...

Reference to lines(NXcg_polyline_set) which supports the discretized shape of each cross-sectioned crystal.

Most microscopy techniques support to generate only a two-dimensional representation (projection) of the characterized material.

For true volumetric techniques use the specifically specialized crystals NXms_feature_set instead. See stereology literature for more details e.g. E.E. Underwood’s book entitled Quantitative Stereology

number_of_crystals: (optional) NX_UINT {units=NX_UNITLESS}

Number of crystals.

crystal_identifier_offset: (optional) NX_INT {units=NX_UNITLESS}

Integer offset whereby the identifier of the first member ...

Integer offset whereby the identifier of the first member of the set differs from zero.

Identifiers can be defined either implicitly or explicitly. For implicit indexing identifiers are defined on the interval \([identifier\_offset, identifier\_offset + c - 1]\).

crystal_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_c_two]) {units=NX_UNITLESS}

Identifier used for crystals for explicit indexing.

number_of_phases: (optional) NX_UINT {units=NX_UNITLESS}

How many phases are distinguished

phase_identifier_offset: (optional) NX_INT {units=NX_UNITLESS}

Integer offset whereby the identifier of the first member ...

Integer offset whereby the identifier of the first member of the set differs from zero.

phase_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_c_two]) {units=NX_UNITLESS}

Identifier used for phase for explicit indexing.

boundary_contact: (optional) NX_BOOLEAN (Rank: 1, Dimensions: [n_c_two])

True, if the crystal makes contact with the edge of the ROI, ...

True, if the crystal makes contact with the edge of the ROI, false otherwise.

orientation_spread: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_c_two]) {units=NX_ANGLE}

Average disorientation angle between individual orientation of the ...

Average disorientation angle between individual orientation of the crystal at probed positions (weighted by area of that position) versus the average disorientation of the crystal.

area: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_c_two]) {units=NX_AREA}

Calibrated area of surrounded by the polyline about each crystal.

ROTATION_SET: (optional) NXrotation_set

interface_projections: (optional) NXms_feature_set

Projections of grain or phase boundaries as typically sectioned ...

Projections of grain or phase boundaries as typically sectioned with optical or electron microscopy characterization.

@discretization: (optional) NX_CHAR

Reference to lines(NXcg_polyline_set) which supports the ...

Reference to lines(NXcg_polyline_set) which supports the discretized shape of each cross-sectioned crystal.

Set of tuples of polyline segments which build the interface.

crystals: (optional) NX_INT (Rank: 2, Dimensions: [n_i_two, 2]) {units=NX_UNITLESS}

Set of pairs of crystal_identifier resolved via depends_on which ...

Set of pairs of crystal_identifier resolved via depends_on which are adjacent to each interface.

@depends_on: (optional) NX_CHAR

The specific crystal_projections(NXms_feature_set) instance ...

The specific crystal_projections(NXms_feature_set) instance to resolve crystal identifier.

triple_points: (optional) NX_INT (Rank: 2, Dimensions: [n_i_two, 2]) {units=NX_UNITLESS}

Set of pairs of triple_point_identifier which the interface connects. ...

Set of pairs of triple_point_identifier which the interface connects. For 2D projections of 3D microstructural features a triple point is physically only the projection of a triple line.

@depends_on: (optional) NX_CHAR

The specific triple_line_projections(NXms_feature_set) instance ...

The specific triple_line_projections(NXms_feature_set) instance whereby to resolve triple_point identifier.

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

The length of the interface. ...

The length of the interface.

This is not necessarily the same as the length of the individual polyline segments whereby the interface is discretized.

The actual coordinate system whereby the geometry is calibrated with real physical dimensions is typically documented by the depends_on attribute of the respective NXcg_primitive_set. This depends_on attribute should point explicitly to an instance of a NXcoordinate_system to support users as much as possible with interpreting how and where the lines are located in the reference frame.

interface_identifier_offset: (optional) NX_INT {units=NX_UNITLESS}

Integer offset whereby the identifier of the first member ...

Integer offset whereby the identifier of the first member of the set differs from zero.

Identifiers can be defined either implicitly or explicitly. For implicit indexing identifiers are defined on the interval \([identifier\_offset, identifier\_offset + c - 1]\).

interface_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_i_two]) {units=NX_UNITLESS}

Identifier for each interface using explicit indexing.

triple_line_projections: (optional) NXms_feature_set

Projections of triple lines as typically characterized with optical ...

Projections of triple lines as typically characterized with optical or electron microscopy.

Mind that most specimens are thermo-chemo-mechanically treated before they are characterized. Therefore, the projected crystal defects are have physically no longer the same structure as in the bulk.

Examples are manifest as effects such as thermal grooving, or relaxation effects of an intersection between a triple line that is cut by the specimen surface as these defects are then exposed typically to a different atmosphere and hence have different thermodynamic boundary conditions than of their true volumetric defects in the bulk.

@discretization: (optional) NX_CHAR

Reference to points(NXcg_point_set) which supports the ...

Reference to points(NXcg_point_set) which supports the locations of these triple points.

number_of_triple_points: (optional) NX_UINT {units=NX_UNITLESS}

Number of triple points.

triple_point_identifier_offset: (optional) NX_INT {units=NX_UNITLESS}

Integer offset whereby the identifier of the first member ...

Integer offset whereby the identifier of the first member of the set differs from zero.

Identifiers can be defined either implicitly or explicitly. For implicit indexing identifiers are defined on the interval \([identifier\_offset, identifier\_offset + c - 1]\).

triple_point_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_t_two]) {units=NX_UNITLESS}

Identifier for each triple point using explicit indexing.

location: (optional) NX_INT (Rank: 1, Dimensions: [n_t_two]) {units=NX_UNITLESS}

Set of triple point identifiers.

@depends_on: (optional) NX_CHAR

The relevant points(NXcg_point_set) instance whereby to ...

The relevant points(NXcg_point_set) instance whereby to resolve interface identifiers.

interfaces: (optional) NX_INT (Rank: 2, Dimensions: [n_t_two, 3]) {units=NX_UNITLESS}

Set of triplets of identifier of line-like features. ...

Set of triplets of identifier of line-like features. Each triplet resolves which three interface projections the triple point connects.

@depends_on: (optional) NX_CHAR

The specific interface_projections(NXms_feature_set) ...

The specific interface_projections(NXms_feature_set) instance whereby to resolve interface identifiers.

polylines: (optional) NX_INT (Rank: 2, Dimensions: [n_t_two, 3]) {units=NX_UNITLESS}

Triplet of identifier of polyline segments. Each triplet resolves ...

Triplet of identifier of polyline segments. Each triplet resolves which three segments of polyline segments the triple junction connects.

@depends_on: (optional) NX_CHAR

The specific lines(NXcg_polyline_set) instance to resolve ...

The specific lines(NXcg_polyline_set) instance to resolve polyline segments.

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/NXms_recon.nxdl.xml