2.3.3.3.32. NXapm_paraprobe_tool_common

Status:

base class (contribution), extends NXobject

Description:

Base class documenting organizational metadata used by all tools of the ...

Base class documenting organizational metadata used by all tools of the paraprobe-toolbox.

Symbols:

No symbol table

Groups cited:

NXcoordinate_system, NXcs_profiling, NXnote, NXprogram, NXuser

Structure:

status: (optional) NX_CHAR

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

identifier_analysis: (optional) NX_UINT {units=NX_UNITLESS}

Internal identifier used by the tool to refer to an analysis. ...

Internal identifier used by the tool to refer to an analysis. Simulation ID is an alias.

config: (optional) NXnote ⤆

The configuration file that was used to parameterize ...

The configuration file that was used to parameterize the algorithms that this tool has executed.

programID: (optional) NXprogram

profiling: (optional) NXcs_profiling

start_time: (optional) NX_DATE_TIME ⤆

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.

end_time: (optional) NX_DATE_TIME ⤆

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.

total_elapsed_time: (optional) NX_FLOAT {units=NX_TIME}

Wall-clock time.

userID: (optional) NXuser

NAMED_reference_frameID: (optional) NXcoordinate_system

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 NXcoordinate_system should be documented explicitly and doing so by picking from the following controlled set of names:

  • paraprobe_reference_frame

  • lab_reference_frame

  • specimen_reference_frame

  • laser_reference_frame

  • instrument_reference_frame

  • detector_reference_frame

  • reconstruction_reference_frame

The aim of this convention is to support users with contextualizing which reference frame each instance (coordinate system) is. If needed, instances of NXtransformations are used to detail the explicit affine transformations whereby one can convert representations between different reference frames. Inspect NXtransformations for further details.

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