.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_tool_common.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_tool_common (base class) ! apm_paraprobe_tool_common (base class) see: apm_paraprobe_tool_common (base class); NXapm_paraprobe_tool_common .. _NXapm_paraprobe_tool_common: =========================== NXapm_paraprobe_tool_common =========================== **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: Base class documenting the information common to tools of the paraprobe-toolbox. ... Base class documenting the information common to tools of 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. The common section can be used as a place to store e.g. organizational metadata and contextualization of that analysis in a research data management system. **Symbols**: No symbol table **Groups cited**: :ref:`NXcoordinate_system_set`, :ref:`NXcoordinate_system`, :ref:`NXcs_profiling`, :ref:`NXidentifier`, :ref:`NXprogram`, :ref:`NXserialized`, :ref:`NXtransformations`, :ref:`NXuser` .. index:: NXprogram (base class); used in base class, NXidentifier (base class); used in base class, NXserialized (base class); used in base class, NXcs_profiling (base class); used in base class, NXuser (base class); used in base class, NXcoordinate_system_set (base class); used in base class, NXcoordinate_system (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXapm_paraprobe_tool_common/status-field: .. index:: status (field) **status**: (optional) :ref:`NX_CHAR ` .. collapse:: A statement whether the tool executable managed to process the analysis ... A statement whether the tool executable managed to process the analysis or whether this failed. Status is written to the results file after the end_time beyond which point in time the tool must no longer compute any further analysis results but exit. Only when this status message is present and its value is `success`, one should consider the results of the tool. In all other cases it might be that the tool has terminated prematurely or another error occurred. Any of these values: ``success`` | ``failure`` .. _/NXapm_paraprobe_tool_common/analysis_identifier-field: .. index:: analysis_identifier (field) **analysis_identifier**: (optional) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} .. collapse:: Internal identifier used by the tool to refer to an analysis (aka simulation ... Internal identifier used by the tool to refer to an analysis (aka simulation id). .. _/NXapm_paraprobe_tool_common/PROGRAM-group: **PROGRAM**: (optional) :ref:`NXprogram` .. _/NXapm_paraprobe_tool_common/IDENTIFIER-group: **IDENTIFIER**: (optional) :ref:`NXidentifier` .. _/NXapm_paraprobe_tool_common/config-group: **config**: (optional) :ref:`NXserialized` .. collapse:: The configuration file that was used to parameterize ... The configuration file that was used to parameterize the algorithms that this tool has executed. .. _/NXapm_paraprobe_tool_common/profiling-group: **profiling**: (optional) :ref:`NXcs_profiling` .. _/NXapm_paraprobe_tool_common/profiling/start_time-field: .. index:: start_time (field) **start_time**: (optional) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. collapse:: ISO 8601 formatted time code with local time zone offset to UTC ... ISO 8601 formatted time code with local time zone offset to UTC information included when the analysis in this results file was started, i.e. when the respective executable/tool was started as a process. .. _/NXapm_paraprobe_tool_common/profiling/end_time-field: .. index:: end_time (field) **end_time**: (optional) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. collapse:: ISO 8601 formatted time code with local time zone offset to UTC ... ISO 8601 formatted time code with local time zone offset to UTC information included when the analysis in this results file were completed and the respective process of the tool exited. .. _/NXapm_paraprobe_tool_common/profiling/total_elapsed_time-field: .. index:: total_elapsed_time (field) **total_elapsed_time**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} Wall-clock time. .. _/NXapm_paraprobe_tool_common/USER-group: **USER**: (optional) :ref:`NXuser` .. _/NXapm_paraprobe_tool_common/COORDINATE_SYSTEM_SET-group: **COORDINATE_SYSTEM_SET**: (optional) :ref:`NXcoordinate_system_set` .. collapse:: Details about coordinate systems (reference frames) used. In atom probe severa ... Details about coordinate systems (reference frames) used. In atom probe several coordinate systems have to be distinguished. Names of instances of such :ref:`NXcoordinate_system` should be documented explicitly and doing so by picking from the following controlled set of names: * paraprobe * lab * specimen * laser * instrument * detector * recon The aim of this convention is to support users with contextualizing which reference frame each instance (coordinate system) is. If needed, instances of :ref:`NXtransformations` are used to detail the explicit affine transformations whereby one can convert representations between different reference frames. Inspect :ref:`NXtransformations` for further details. .. _/NXapm_paraprobe_tool_common/COORDINATE_SYSTEM_SET/COORDINATE_SYSTEM-group: **COORDINATE_SYSTEM**: (optional) :ref:`NXcoordinate_system` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_common/COORDINATE_SYSTEM_SET/COORDINATE_SYSTEM/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_tool_common/analysis_identifier-field ` * :ref:`/NXapm_paraprobe_tool_common/config-group ` * :ref:`/NXapm_paraprobe_tool_common/COORDINATE_SYSTEM_SET-group ` * :ref:`/NXapm_paraprobe_tool_common/COORDINATE_SYSTEM_SET/COORDINATE_SYSTEM-group ` * :ref:`/NXapm_paraprobe_tool_common/COORDINATE_SYSTEM_SET/COORDINATE_SYSTEM/TRANSFORMATIONS-group ` * :ref:`/NXapm_paraprobe_tool_common/IDENTIFIER-group ` * :ref:`/NXapm_paraprobe_tool_common/profiling-group ` * :ref:`/NXapm_paraprobe_tool_common/profiling/end_time-field ` * :ref:`/NXapm_paraprobe_tool_common/profiling/start_time-field ` * :ref:`/NXapm_paraprobe_tool_common/profiling/total_elapsed_time-field ` * :ref:`/NXapm_paraprobe_tool_common/PROGRAM-group ` * :ref:`/NXapm_paraprobe_tool_common/status-field ` * :ref:`/NXapm_paraprobe_tool_common/USER-group ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_paraprobe_tool_common.nxdl.xml