.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_tool_results.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_tool_results (application definition) ! apm_paraprobe_tool_results (application definition) see: apm_paraprobe_tool_results (application definition); NXapm_paraprobe_tool_results .. _NXapm_paraprobe_tool_results: ============================ NXapm_paraprobe_tool_results ============================ **Status**: *application definition* (contribution), extends :ref:`NXobject` **Description**: .. collapse:: 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): * `paraprobe-toolbox `_ * `M. Kühbach et al. `_ 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**: :ref:`NXapm_paraprobe_tool_common`, :ref:`NXapm_paraprobe_tool_process`, :ref:`NXcoordinate_system`, :ref:`NXcs_filter_boolean_mask`, :ref:`NXcs_profiling`, :ref:`NXentry`, :ref:`NXnote`, :ref:`NXprogram`, :ref:`NXuser` .. 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, NXapm_paraprobe_tool_common (base class); used in application definition, NXnote (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 (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_tool_results/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` .. _/NXapm_paraprobe_tool_results/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED-group: :bolditalic:`TASKPROCESSED`: (required) :ref:`NXapm_paraprobe_tool_process` A specific processing result .. _/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window-group: **window**: (required) :ref:`NXcs_filter_boolean_mask` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window/number_of_ions-field: .. index:: number_of_ions (field) **number_of_ions**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common-group: **common**: (required) :ref:`NXapm_paraprobe_tool_common` .. _/NXapm_paraprobe_tool_results/ENTRY/common/status-field: .. index:: status (field) **status**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/identifier_analysis-field: .. index:: identifier_analysis (field) **identifier_analysis**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/config-group: **config**: (required) :ref:`NXnote` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/config/file_name-field: .. index:: file_name (field) **file_name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/config/checksum-field: .. index:: checksum (field) **checksum**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/config/algorithm-field: .. index:: algorithm (field) **algorithm**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/programID-group: **program**\ :bolditalic:`ID`: (required) :ref:`NXprogram` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/programID/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/programID/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling-group: **profiling**: (recommended) :ref:`NXcs_profiling` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling/total_elapsed_time-field: .. index:: total_elapsed_time (field) **total_elapsed_time**: (required) :ref:`NX_FLOAT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling/max_processes-field: .. index:: max_processes (field) **max_processes**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling/max_threads-field: .. index:: max_threads (field) **max_threads**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/profiling/max_gpus-field: .. index:: max_gpus (field) **max_gpus**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/userID-group: **user**\ :bolditalic:`ID`: (optional) :ref:`NXuser` :ref:`⤆ ` If used, metadata of at least the person who performed this analysis. .. _/NXapm_paraprobe_tool_results/ENTRY/common/userID/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame-group: **paraprobe_reference_frame**: (required) :ref:`NXcoordinate_system` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/x-field: .. index:: x (field) **x**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/x_alias-field: .. index:: x_alias (field) **x_alias**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/y-field: .. index:: y (field) **y**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/y_alias-field: .. index:: y_alias (field) **y_alias**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/z-field: .. index:: z (field) **z**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/z_alias-field: .. index:: z_alias (field) **z_alias**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_tool_results/ENTRY-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/config-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/config/algorithm-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/config/checksum-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/config/file_name-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/identifier_analysis-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/type-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/x-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/x_alias-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/y-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/y_alias-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/z-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/paraprobe_reference_frame/z_alias-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling/end_time-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling/max_gpus-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling/max_processes-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling/max_threads-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling/start_time-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/profiling/total_elapsed_time-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/programID-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/programID/program-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/programID/program@version-attribute ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/status-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/userID-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/common/userID/name-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/definition@version-attribute ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window-group ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window/bitdepth-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window/mask-field ` * :ref:`/NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED/window/number_of_ions-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_paraprobe_tool_results.nxdl.xml