2.3.3.3.17. NXapm_paraprobe_distancer_results

Status:

application definition (contribution), extends NXapm_paraprobe_tool_results

Description:

Application definition for a results file of the paraprobe-distancer tool. ...

Application definition for a results file of the paraprobe-distancer tool.

The tool paraprobe-distancer tool evaluates exactly the shortest Euclidean distance for each member of a set of points against a set of triangles.

Triangles can represent for instance the facets of a triangulated surface mesh like those returned by paraprobe-surfacer or any other set of triangles. Triangles do not have to be connected.

Currently, paraprobe-distancer does not check if the respectively specified triangle sets are consistent, what their topology is, or whether or not these triangles are consistently oriented.

Symbols:

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

n_ions: The total number of points, i.e. ions in the reconstruction.

n_tri: The total number of triangles in the set.

Groups cited:

NXapm_paraprobe_tool_process, NXcs_filter_boolean_mask, NXentry

Structure:

ENTRY: (required) NXentry ⤆

definition: (required) NX_CHAR ⤆

Obligatory value: NXapm_paraprobe_distancer_results

point_to_triangleID: (required) NXapm_paraprobe_tool_process ⤆

distance: (required) NX_FLOAT (Rank: 1, Dimensions: [n_ions]) {units=NX_LENGTH}

The shortest analytical distance of each point to their ...

The shortest analytical distance of each point to their respectively closest triangle from the joint triangle set.

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

For each point the identifier of the triangle for which the ...

For each point the identifier of the triangle for which the shortest distance was found.

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

A support field to enable the visualization of each point ...

A support field to enable the visualization of each point by an explicit identifier on the interval [0, n_ions - 1]. The field can be used to visualize the points as a function of their distance to the triangle set (e.g. via XDMF/Paraview).

sign_valid: (optional) NXcs_filter_boolean_mask

A bitmask that identifies which of the distance values is ...

A bitmask that identifies which of the distance values is assumed to have a consistent sign because the closest triangle had a consistent outer unit normal defined.

For points whose bit is set to 0 the distance is correct but the sign is not reliable.

number_of_triangles: (required) NX_UINT {units=NX_UNITLESS}

Number of triangles covered by the mask.

bitdepth: (required) NX_UINT {units=NX_UNITLESS} ⤆

Bitdepth of the elementary datatype that is used to store ...

Bitdepth of the elementary datatype that is used to store the information content of the mask (typically 8 bit, uint8).

mask: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) {units=NX_UNITLESS} ⤆

The content of the mask. Like for all masks used in the tools ...

The content of the mask. Like for all masks used in the tools of the paraprobe-toolbox, padding is used when number_of_objects is not an integer multiple of bitdepth. If padding is used, padded bits are set to 0.

window_triangles: (optional) NXcs_filter_boolean_mask

A bitmask that identifies which of the triangles in the set were ...

A bitmask that identifies which of the triangles in the set were considered when certain triangles have been filtered out.

number_of_objects: (required) NX_UINT ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT (Rank: 1, Dimensions: [n_tri]) ⤆

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