.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_config_transcoder.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_config_transcoder (application definition) ! apm_paraprobe_config_transcoder (application definition) see: apm_paraprobe_config_transcoder (application definition); NXapm_paraprobe_config_transcoder .. _NXapm_paraprobe_config_transcoder: ================================= NXapm_paraprobe_config_transcoder ================================= **Status**: application definition, extends :ref:`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**: :ref:`NXapm_input_ranging`, :ref:`NXapm_input_reconstruction`, :ref:`NXcs_profiling`, :ref:`NXentry`, :ref:`NXprocess` .. index:: NXentry (base class); used in application definition, NXprocess (base class); used in application definition, NXapm_input_reconstruction (base class); used in application definition, NXapm_input_ranging (base class); used in application definition, NXcs_profiling (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_config_transcoder/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXapm_paraprobe_config_transcoder/ENTRY@version-attribute: .. index:: version (group attribute) **@version**: (required) :ref:`NX_CHAR ` Version specifier of this application definition. .. _/NXapm_paraprobe_config_transcoder/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` Official NeXus NXDL schema with which this file was written. Obligatory value: ``NXapm_paraprobe_config_transcoder`` .. _/NXapm_paraprobe_config_transcoder/ENTRY/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` Given name of the program/software/tool with which this NeXus (configuration) file was generated. .. _/NXapm_paraprobe_config_transcoder/ENTRY/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` 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. .. _/NXapm_paraprobe_config_transcoder/ENTRY/analysis_identifier-field: .. index:: analysis_identifier (field) **analysis_identifier**: (optional) :ref:`NX_CHAR ` Ideally, a (globally persistent) unique identifier for referring to this analysis. .. _/NXapm_paraprobe_config_transcoder/ENTRY/analysis_description-field: .. index:: analysis_description (field) **analysis_description**: (optional) :ref:`NX_CHAR ` Possibility for leaving a free-text description about this analysis. .. _/NXapm_paraprobe_config_transcoder/ENTRY/results_path-field: .. index:: results_path (field) **results_path**: (optional) :ref:`NX_CHAR ` 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. .. _/NXapm_paraprobe_config_transcoder/ENTRY/time_stamp-field: .. index:: time_stamp (field) **time_stamp**: (required) :ref:`NX_DATE_TIME ` ISO 8601 formatted time code with local time zone offset to UTC information included when this configuration file was created. .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS-group: **PROCESS**: (required) :ref:`NXprocess` .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/dataset-group: **dataset**: (required) :ref:`NXapm_input_reconstruction` .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/dataset/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` 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. .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/dataset/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/iontypes-group: **iontypes**: (required) :ref:`NXapm_input_ranging` .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/iontypes/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` 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. .. _/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/iontypes/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_transcoder/ENTRY/performance-group: **performance**: (required) :ref:`NXcs_profiling` .. _/NXapm_paraprobe_config_transcoder/ENTRY/performance/current_working_directory-field: .. index:: current_working_directory (field) **current_working_directory**: (required) :ref:`NX_CHAR ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY-group ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/analysis_description-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/analysis_identifier-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/performance-group ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/performance/current_working_directory-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS-group ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/dataset-group ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/dataset/filename-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/dataset/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/iontypes-group ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/iontypes/filename-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/PROCESS/iontypes/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/program-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/program@version-attribute ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/results_path-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY/time_stamp-field ` * :ref:`/NXapm_paraprobe_config_transcoder/ENTRY@version-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXapm_paraprobe_config_transcoder.nxdl.xml