3.3.3.26. NXapm_paraprobe_config_transcoder

Status:

application definition (contribution), extends NXobject

Description:

Configurations of a paraprobe-transcoder 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, NXcs_profiling, NXentry, NXprocess

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. ...

Official NeXus NXDL schema with which this file was written.

Obligatory value: NXapm_paraprobe_config_transcoder

program: (required) NX_CHAR

Given name of the program/software/tool with which this NeXus ...

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 ...

Ideally program version plus build number, or commit hash or description of ideally an ever persistent resource 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 deterministically.

analysis_identifier: (required) NX_CHAR

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

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.

results_path: (optional) NX_CHAR

Path to the directory where the tool should store NeXus/HDF5 results ...

Path to the directory where the tool should store NeXus/HDF5 results of this analysis. If not specified results will be stored in the current working directory.

time_stamp: (required) 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 this configuration file was created.

PROCESS: (required) NXprocess ⤆

dataset: (required) NXapm_input_reconstruction

filename: (required) NX_CHAR ⤆

The path and name of the file (technology partner or community format) ...

The path and name of the file (technology partner or community format) from which to read the reconstructed ion positions. Currently, POS, ePOS, APT files from APSuite, and NXS, i.e. NeXus/HDF5 files are supported.

@version: (required) NX_CHAR ⤆

iontypes: (required) NXapm_input_ranging

filename: (required) NX_CHAR ⤆

The path and name of the file (technology partner or community format ...

The path and name of the file (technology partner or community format from which to read the ranging definitions, i.e. how to map mass-to- charge-state ratios on iontypes. Currently, RRNG, RNG, and NXS, i.e. NeXus/HDF5 files are supported.

@version: (required) NX_CHAR ⤆

performance: (required) NXcs_profiling

current_working_directory: (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_config_transcoder.nxdl.xml