.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_distancer_results.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_distancer_results (application definition) ! apm_paraprobe_distancer_results (application definition) see: apm_paraprobe_distancer_results (application definition); NXapm_paraprobe_distancer_results .. _NXapm_paraprobe_distancer_results: ================================= NXapm_paraprobe_distancer_results ================================= **Status**: *application definition* (contribution), extends :ref:`NXapm_paraprobe_tool_results` **Description**: .. collapse:: 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**: :ref:`NXapm_paraprobe_tool_process`, :ref:`NXcs_filter_boolean_mask`, :ref:`NXentry` .. index:: NXentry (base class); used in application definition, NXapm_paraprobe_tool_process (base class); used in application definition, NXcs_filter_boolean_mask (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_distancer_results/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``NXapm_paraprobe_distancer_results`` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID-group: **point_to_triangle**\ :bolditalic:`ID`: (required) :ref:`NXapm_paraprobe_tool_process` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_ions]) {units=\ :ref:`NX_LENGTH `} .. collapse:: 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. .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/indices_triangle-field: .. index:: indices_triangle (field) **indices_triangle**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_ions]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: 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. .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/indices_point-field: .. index:: indices_point (field) **indices_point**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_ions]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: 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). .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid-group: **sign_valid**: (optional) :ref:`NXcs_filter_boolean_mask` .. collapse:: 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. .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid/number_of_triangles-field: .. index:: number_of_triangles (field) **number_of_triangles**: (required) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} Number of triangles covered by the mask. .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` .. collapse:: 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). .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_ions]) {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` .. collapse:: 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. .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles-group: **window_triangles**: (optional) :ref:`NXcs_filter_boolean_mask` .. collapse:: 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. .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles/number_of_objects-field: .. index:: number_of_objects (field) **number_of_objects**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_tri]) :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_distancer_results/ENTRY-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/distance-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/indices_point-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/indices_triangle-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid/bitdepth-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid/mask-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/sign_valid/number_of_triangles-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles/bitdepth-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles/mask-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangleID/window_triangles/number_of_objects-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_paraprobe_distancer_results.nxdl.xml