3.3.3.33. NXapm_paraprobe_tool_results

Status:

application definition (contribution), extends NXobject

Description:

Application definition for storing processing results of a tool from the parapro ...

Application definition for storing processing results of a tool from the paraprobe-toolbox.

The paraprobe-toolbox is a collection of open-source tools for performing efficient analyses of point cloud data where each point can represent atoms or (molecular) ions. A key application of the toolbox has been for research in the field of Atom Probe Tomography (APT) and related Field Ion Microscopy (FIM):

The toolbox does not replace but complements existent software tools in this research field. Given its capabilities of handling points as objects with properties and enabling analyses of the spatial arrangement of and inter- sections between geometric primitives, the software can equally be used for analyzing data in Materials Science and Materials Engineering.

Symbols:

No symbol table

Groups cited:

NXapm_paraprobe_tool_common, NXapm_paraprobe_tool_process, NXcoordinate_system, NXcs_filter_boolean_mask, NXcs_profiling, NXentry, NXnote, NXprogram, NXuser

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR

@version: (required) NX_CHAR

TASKPROCESSED: (required) NXapm_paraprobe_tool_process

A specific processing result

window: (required) NXcs_filter_boolean_mask

number_of_ions: (required) NX_UINT

bitdepth: (required) NX_UINT

mask: (required) NX_UINT

common: (required) NXapm_paraprobe_tool_common

status: (required) NX_CHAR

identifier_analysis: (required) NX_UINT

config: (required) NXnote

file_name: (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

max_processes: (required) NX_UINT

max_threads: (required) NX_UINT

max_gpus: (required) NX_UINT

userID: (optional) NXuser

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

name: (required) NX_CHAR

paraprobe_reference_frame: (required) NXcoordinate_system

type: (required) NX_CHAR

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

x_alias: (required) NX_CHAR

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

y_alias: (required) NX_CHAR

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

z_alias: (required) NX_CHAR

Hypertext Anchors

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

NXDL Source:

https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXapm_paraprobe_tool_results.nxdl.xml