2.3.3.3.37. NXapm_paraprobe_tessellator_results

Status:

application definition, extends NXobject

Description:

Application definition for results files of the paraprobe-tessellator tool. ...

Application definition for results files of the paraprobe-tessellator tool.

This tool is part of the paraprobe-toolbox. Inspect the base class NXapm_paraprobe_tool_results.

Symbols:

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

n_ions: The total number of ions in the reconstruction.

n_f: The total number of values required to represent all faces of each cell.

n_f_xdmf: The total number of values required to represent all faces of each cell (polyhedron) using XDMF.

Groups cited:

NXapm_paraprobe_tool_common, NXapm_paraprobe_tool_results, NXcg_face_list_data_structure, NXcg_hexahedron_set, NXcg_polyhedron_set, NXcoordinate_system_set, NXcoordinate_system, NXcs_filter_boolean_mask, NXcs_profiling, NXentry, NXprogram, NXserialized, NXuser

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR ⤆

Obligatory value: NXapm_paraprobe_tessellator_results

@version: (required) NX_CHAR ⤆

tessellation: (required) NXapm_paraprobe_tool_results

The tool can be used to compute a Voronoi tessellation the entire ...

The tool can be used to compute a Voronoi tessellation the entire or of a sub-set of the reconstructed volume. Each point (ion) is wrapped in one (Voronoi) cell. The point cloud in the ROI is wrapped into an axis-aligned bounding box (AABB) that is tight. This means points at the edge of the point cloud can lay on the surface of the bounding box. The tool detects if cells make contact with the walls of this bounding box. The tessellation is computed without periodic boundary conditions.

window: (required) NXcs_filter_boolean_mask ⤆

number_of_ions: (required) NX_UINT ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall: (recommended) NXcg_hexahedron_set

The (tight) axis-aligned bounding box about the point cloud.

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

Coordinate triplet of the corner that lays closests ...

Coordinate triplet of the corner that lays closests to the origin of the paraprobe coordinate system.

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

Coordinate triplet of the corner that lays farthest away ...

Coordinate triplet of the corner that lays farthest away from the origin of the paraprobe coordinate system.

voronoi_cells: (optional) NXcg_polyhedron_set

dimensionality: (required) NX_POSINT {units=NX_UNITLESS} ⤆

Obligatory value: 3

cardinality: (required) NX_POSINT {units=NX_UNITLESS} ⤆

The number of points (and thus cells).

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

Volume of each Voronoi cell.

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

Which MPI process computed which Voronoi cell.

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

Which OpenMP thread computed which Voronoi cell.

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

The number of faces for each cell. Faces of adjoining polyhedra are coun ...

The number of faces for each cell. Faces of adjoining polyhedra are counted for each polyhedron. This field can be used to interpret the concatenated vector with the individual values for the area of each face.

identifier_offset: (required) NX_INT ⤆

xdmf_topology: (required) NX_UINT (Rank: 1, Dimensions: [n_f_xdmf]) {units=NX_UNITLESS}

Sequence of tuples, concatenated in the order of the Voronoi cells. ...

Sequence of tuples, concatenated in the order of the Voronoi cells. Each tuple contains encodes information to visualize using XDMF: Firstly, an XDMF geometric primitive type key. Secondly, the number of vertices of the polygon. Third, the sequence of vertex identifier which define the facet. Tuples encode faces faster than cells.

xdmf_cell_identifier: (required) NX_UINT (Rank: 1, Dimensions: [n_f]) {units=NX_UNITLESS}

Sequence of cell identifier, concatenated such that each face is ...

Sequence of cell identifier, concatenated such that each face is associated with its cell. Given that paraprobe-tessellator assigns each cell the evaporation_id of the ion that the cell wraps this information enables the segmentation of the tessellation and thus correlate per-ion properties with the volume that each cell represents.

polyhedra: (optional) NXcg_face_list_data_structure ⤆

A simple approach to describe the entire set of polyhedra when the main ...

A simple approach to describe the entire set of polyhedra when the main intention is to store the shape of the polyhedra for visualization purposes.

number_of_vertices: (required) NX_INT ⤆

number_of_faces: (required) NX_INT ⤆

vertex_identifier_offset: (required) NX_INT ⤆

face_identifier_offset: (required) NX_INT ⤆

vertices: (required) NX_FLOAT

wall_contact_global: (recommended) NXcs_filter_boolean_mask

A bitmask that documents which of the cells are likely truncated because t ...

A bitmask that documents which of the cells are likely truncated because they share at least one face with the aabb of the point cloud. This field encodes the result of the boolean or operator applied to the value of all six wall_contact groups that document contact in specific outer unit normal directions of the aabb.

number_of_objects: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall_contact_left: (recommended) NXcs_filter_boolean_mask

In the spirit of wall_contact_global, the left face of *aabb*. ...

In the spirit of wall_contact_global, the left face of aabb. Its outer unit normal points in the opposite direction of the x-axis of the paraprobe coordinate system.

number_of_objects: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall_contact_right: (recommended) NXcs_filter_boolean_mask

In the spirit of wall_contact_global, the right face of *aabb*. ...

In the spirit of wall_contact_global, the right face of aabb. Its outer unit normal points in the direction of the x-axis of the paraprobe coordinate system.

number_of_objects: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall_contact_front: (recommended) NXcs_filter_boolean_mask

In the spirit of wall_contact_global, the front face of *aabb*. ...

In the spirit of wall_contact_global, the front face of aabb. Its outer unit normal points in the opposite direction of the y-axis of the paraprobe coordinate system.

number_of_objects: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall_contact_rear: (recommended) NXcs_filter_boolean_mask

In the spirit of wall_contact_global, the rear face of *aabb*. ...

In the spirit of wall_contact_global, the rear face of aabb. Its outer unit normal points in the direction of the y-axis of the paraprobe coordinate system.

number_of_objects: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall_contact_bottom: (recommended) NXcs_filter_boolean_mask

In the spirit of wall_contact_global, the front face of *aabb*. ...

In the spirit of wall_contact_global, the front face of aabb. Its outer unit normal points in the opposite direction of the z-axis of the paraprobe coordinate system.

number_of_objects: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

wall_contact_top: (required) NXcs_filter_boolean_mask

In the spirit of wall_contact_global, the front face of *aabb*. ...

In the spirit of wall_contact_global, the front face of aabb. Its outer unit normal points in the direction of the z-axis of the paraprobe coordinate system.

number_of_ions: (required) NX_UINT (Rank: 1, Dimensions: [n_ions])

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

common: (required) NXapm_paraprobe_tool_common

status: (required) NX_CHAR ⤆

analysis_identifier: (required) NX_UINT ⤆

config: (required) NXserialized ⤆

type: (required) NX_CHAR ⤆

path: (required) NX_CHAR ⤆

checksum: (required) NX_CHAR ⤆

algorithm: (required) NX_CHAR ⤆

programID: (required) NXprogram ⤆

program: (required) NX_CHAR ⤆

@version: (required) NX_CHAR ⤆

profiling: (recommended) NXcs_profiling ⤆

start_time: (required) NX_DATE_TIME ⤆

end_time: (required) NX_DATE_TIME ⤆

total_elapsed_time: (required) NX_FLOAT ⤆

current_working_directory: (required) NX_CHAR ⤆

number_of_processes: (required) NX_POSINT

number_of_threads: (required) NX_POSINT

number_of_gpus: (required) NX_POSINT

userID: (optional) NXuser ⤆

If used, metadata of at least the person who performed this analysis.

name: (required) NX_CHAR ⤆

coordinate_system_set: (required) NXcoordinate_system_set ⤆

paraprobe: (required) NXcoordinate_system ⤆

type: (required) NX_CHAR ⤆

handedness: (required) NX_CHAR ⤆

x: (required) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH} ⤆

y: (required) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH} ⤆

z: (required) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH} ⤆

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_tessellator_results.nxdl.xml