NXapm_paraprobe_config_tessellator

Status:

application definition, extends NXobject

Description:

Configuration of a paraprobe-tessellator tool run in atom probe microscopy.

Symbols:

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

Groups cited:

NXapm_input_ranging, NXapm_input_reconstruction, NXcg_cylinder_set, NXcg_ellipsoid_set, NXcg_face_list_data_structure, NXcg_hexahedron_set, NXcs_filter_boolean_mask, NXentry, NXmatch_filter, NXprocess, NXspatial_filter, NXsubsampling_filter

Structure:

ENTRY: (required) NXentry

@version: (required) NX_CHAR

Version specifier of this application definition.

definition: (required) NX_CHAR

Official NeXus NXDL schema with which this file was written.

Obligatory value: NXapm_paraprobe_config_tessellator

program: (required) NX_CHAR

Given name of the program/software/tool with which this NeXus (configuration) file was generated.

@version: (required) NX_CHAR

Ideally program version plus build number, or commit hash or description of ever persistent resources where the source code of the program and build instructions can be found so that the program can be configured ideally in such a manner that the result of this computational process is recreatable in the same deterministic manner.

analysis_identifier: (optional) NX_CHAR

Ideally, a (globally persistent) unique identifier for referring to this analysis.

analysis_description: (optional) NX_CHAR

Possibility for leaving a free-text description about this analysis.

time_stamp: (required) NX_DATE_TIME

ISO 8601 formatted time code with local time zone offset to UTC information included when this configuration file was created.

number_of_processes: (required) NX_UINT {units=NX_UNITLESS}

How many individual analyses should the tool execute.

PROCESS: (required) NXprocess

dataset: (required) NXapm_input_reconstruction

filename: (required) NX_CHAR

@version: (required) NX_CHAR

dataset_name_reconstruction: (required) NX_CHAR

dataset_name_mass_to_charge: (required) NX_CHAR

iontypes: (required) NXapm_input_ranging

filename: (required) NX_CHAR

@version: (required) NX_CHAR

group_name_iontypes: (required) NX_CHAR

spatial_filter: (optional) NXspatial_filter

windowing_method: (required) NX_CHAR

CG_ELLIPSOID_SET: (optional) NXcg_ellipsoid_set

dimensionality: (required) NX_POSINT

cardinality: (required) NX_POSINT

identifier_offset: (required) NX_INT

center: (required) NX_NUMBER

half_axes_radii: (required) NX_NUMBER

orientation: (required) NX_NUMBER

CG_CYLINDER_SET: (optional) NXcg_cylinder_set

dimensionality: (required) NX_POSINT

cardinality: (required) NX_POSINT

identifier_offset: (required) NX_INT

center: (required) NX_NUMBER

height: (required) NX_NUMBER

radii: (required) NX_NUMBER

CG_HEXAHEDRON_SET: (optional) NXcg_hexahedron_set

dimensionality: (required) NX_POSINT

cardinality: (required) NX_POSINT

identifier_offset: (required) NX_INT

hexahedra: (required) NXcg_face_list_data_structure

CS_FILTER_BOOLEAN_MASK: (optional) NXcs_filter_boolean_mask

number_of_objects: (required) NX_UINT

bitdepth: (required) NX_UINT

mask: (required) NX_UINT

identifier: (required) NX_UINT

evaporation_id_filter: (optional) NXsubsampling_filter

iontype_filter: (optional) NXmatch_filter

hit_multiplicity_filter: (optional) NXmatch_filter

ion_to_edge_distances: (optional) NXprocess

The tool enables to inject precomputed distance information for each point which can be used for further post-processing and analysis.

filename: (required) NX_CHAR

Name of an HDF5 file which contains the ion distances. Users are responsible this file and referred to dataset under dataset_name have an ion_distance value for each ion.

@version: (required) NX_CHAR

Version identifier of the file such as a secure hash which documents the binary state of the file to add an additional layer of reproducibility.

dataset_name: (required) NX_CHAR

Absolute HDF5 path to the dataset with distance values for each ion.

tessellating: (required) NXprocess

method: (required) NX_CHAR

Specifies for which points the tool will compute the tessellation. By default, a Voronoi tessellation is computed for all ions in the filtered point cloud.

Obligatory value: default

has_cell_volume: (required) NX_BOOLEAN

Specifies if the tool should report the volume of each cell.

has_cell_neighbors: (required) NX_BOOLEAN

Specifies if the tool should report the first-order neighbors of each cell.

has_cell_geometry: (required) NX_BOOLEAN

Specifies if the tool should report the facets and vertices of each cell.

has_cell_edge_detection: (required) NX_BOOLEAN

Specifies if the tool should report if the cell makes contact with the tight axis-aligned bounding box about the point cloud. This can be used to identify if the shape of the cell is affected by the edge of the dataset or if cells are deeply enough embedded into the point cloud so that the shape of their cells are not affected by the presence of the boundary.

erosion_distance: (required) NX_FLOAT {units=NX_LENGTH}

Maximum distance for which cells are eroded.

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_paraprobe_config_tessellator.nxdl.xml