.. 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, extends :ref:`NXobject` **Description**: .. collapse:: Application definition for results files of the paraprobe-distancer tool. ... Application definition for results files of the paraprobe-distancer tool. This tool is part of the paraprobe-toolbox. Inspect the base class :ref:`NXapm_paraprobe_tool_results`. The paraprobe-distancer tool can be used for the computing of the shortest Euclidean distance for each member of a set of points against a set of triangles. In contrast to most approaches in atom probe where the distance is computed as the projected distance, this tool evaluates robustly the exact distance between a point and a triangle. 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_common`, :ref:`NXapm_paraprobe_tool_results`, :ref:`NXcoordinate_system_set`, :ref:`NXcoordinate_system`, :ref:`NXcs_filter_boolean_mask`, :ref:`NXcs_profiling`, :ref:`NXentry`, :ref:`NXprogram`, :ref:`NXserialized`, :ref:`NXuser` .. index:: NXentry (base class); used in application definition, NXapm_paraprobe_tool_results (base class); used in application definition, NXserialized (base class); used in application definition, NXcs_filter_boolean_mask (base class); used in application definition, NXapm_paraprobe_tool_common (base class); used in application definition, NXprogram (base class); used in application definition, NXcs_profiling (base class); used in application definition, NXuser (base class); used in application definition, NXcoordinate_system_set (base class); used in application definition, NXcoordinate_system (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_distancer_results/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/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/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle-group: **point_to_triangle**: (required) :ref:`NXapm_paraprobe_tool_results` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/analysis_identifier-field: .. index:: analysis_identifier (field) **analysis_identifier**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/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_triangle/triangle_identifier-field: .. index:: triangle_identifier (field) **triangle_identifier**: (optional) :ref:`NX_UINT ` (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_triangle/point_identifier-field: .. index:: point_identifier (field) **point_identifier**: (optional) :ref:`NX_UINT ` (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_triangle/config-group: **config**: (required) :ref:`NXserialized` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/path-field: .. index:: path (field) **path**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/checksum-field: .. index:: checksum (field) **checksum**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/algorithm-field: .. index:: algorithm (field) **algorithm**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window-group: **window**: (required) :ref:`NXcs_filter_boolean_mask` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window/number_of_ions-field: .. index:: number_of_ions (field) **number_of_ions**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/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_triangle/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_triangle/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_triangle/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_triangle/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_triangle/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_triangle/window_triangles/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window_triangles/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_tri]) :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common-group: **common**: (required) :ref:`NXapm_paraprobe_tool_common` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/status-field: .. index:: status (field) **status**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/programID-group: **programID**: (required) :ref:`NXprogram` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/programID/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/programID/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling-group: **profiling**: (recommended) :ref:`NXcs_profiling` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/total_elapsed_time-field: .. index:: total_elapsed_time (field) **total_elapsed_time**: (required) :ref:`NX_FLOAT ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/current_working_directory-field: .. index:: current_working_directory (field) **current_working_directory**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/number_of_processes-field: .. index:: number_of_processes (field) **number_of_processes**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/number_of_threads-field: .. index:: number_of_threads (field) **number_of_threads**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/number_of_gpus-field: .. index:: number_of_gpus (field) **number_of_gpus**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/userID-group: **userID**: (optional) :ref:`NXuser` :ref:`⤆ ` If used, metadata of at least the person who performed this analysis. .. _/NXapm_paraprobe_distancer_results/ENTRY/common/userID/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set-group: **coordinate_system_set**: (required) :ref:`NXcoordinate_system_set` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe-group: **paraprobe**: (required) :ref:`NXcoordinate_system` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/handedness-field: .. index:: handedness (field) **handedness**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/x-field: .. index:: x (field) **x**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/y-field: .. index:: y (field) **y**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/z-field: .. index:: z (field) **z**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :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/common-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/handedness-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/type-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/x-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/y-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/coordinate_system_set/paraprobe/z-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/current_working_directory-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/end_time-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/number_of_gpus-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/number_of_processes-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/number_of_threads-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/start_time-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/profiling/total_elapsed_time-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/programID-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/programID/program-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/programID/program@version-attribute ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/status-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/userID-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/common/userID/name-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/definition@version-attribute ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/analysis_identifier-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/algorithm-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/checksum-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/path-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/config/type-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/distance-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/point_identifier-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/sign_valid-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/sign_valid/bitdepth-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/sign_valid/mask-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/sign_valid/number_of_triangles-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/triangle_identifier-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window/bitdepth-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window/mask-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window/number_of_ions-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window_triangles-group ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window_triangles/bitdepth-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/window_triangles/mask-field ` * :ref:`/NXapm_paraprobe_distancer_results/ENTRY/point_to_triangle/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