2.3.3.3.29. NXapm_paraprobe_ranger_results

Status:

application definition, extends NXobject

Description:

Application definition for results files of the paraprobe-ranger tool. ...

Application definition for results files of the paraprobe-ranger tool.

This tool is part of the paraprobe-toolbox. Inspect the base class NXapm_paraprobe_tool_results. The purpose and need of the paraprobe-ranger tool is to apply a given set of ranging definitions within a certain (possibly complicated) selection of ions (based on their properties or location in the reconstructed volume.

Symbols:

The symbols used in the schema to specify e.g. dimensions of arrays.

n_ions: The total number of ions in the reconstructed volume.

Groups cited:

NXapm_paraprobe_tool_common, NXapm_paraprobe_tool_results, NXcoordinate_system_set, NXcoordinate_system, NXcs_filter_boolean_mask, NXcs_profiling, NXentry, NXion, NXprogram, NXserialized, NXuser

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR ⤆

Obligatory value: NXapm_paraprobe_ranger_results

@version: (required) NX_CHAR ⤆

iontypes: (required) NXapm_paraprobe_tool_results

Paraprobe-ranger loads the iontypes and evaluates for each ...

Paraprobe-ranger loads the iontypes and evaluates for each ion on which iontype it matches. If it matches on None, the ion is considered of the default unknown_type. This iontype is marked with a 0 in the iontypes array.

iontypes: (required) NX_UINT (Rank: 1, Dimensions: [n_ions]) {units=NX_UNITLESS}

The iontype (identifier) for each ion that was best matching, stored ...

The iontype (identifier) for each ion that was best matching, stored in the order of the evaporation sequence ID. The here computed iontypes do not take into account the charge state of the ion which is equivalent to interpreting a RNG and RRNG range files for each ion in such a way that only the those elements are considered of which a (molecular) ion is assumed composed according to the NXion instances.

window: (required) NXcs_filter_boolean_mask ⤆

number_of_ions: (required) NX_UINT ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

ION: (required) NXion

nuclide_hash: (required) NX_UINT ⤆

nuclide_list: (recommended) NX_UINT ⤆

charge_state: (required) NX_INT ⤆

mass_to_charge_range: (required) NX_FLOAT

name: (optional) NX_CHAR ⤆

common: (required) NXapm_paraprobe_tool_common

status: (required) NX_CHAR ⤆

analysis_identifier: (required) NX_UINT ⤆

config: (required) NXserialized ⤆

type: (required) NX_CHAR ⤆

path: (required) NX_CHAR ⤆

checksum: (required) NX_CHAR ⤆

algorithm: (required) NX_CHAR ⤆

programID: (required) NXprogram ⤆

program: (required) NX_CHAR ⤆

@version: (required) NX_CHAR ⤆

profiling: (recommended) NXcs_profiling ⤆

start_time: (required) NX_DATE_TIME ⤆

end_time: (required) NX_DATE_TIME ⤆

total_elapsed_time: (required) NX_FLOAT ⤆

current_working_directory: (required) NX_CHAR ⤆

number_of_processes: (required) NX_POSINT

number_of_threads: (required) NX_POSINT

number_of_gpus: (required) NX_POSINT

userID: (optional) NXuser ⤆

If used, metadata of at least the person who performed this analysis.

name: (required) NX_CHAR ⤆

coordinate_system_set: (required) NXcoordinate_system_set ⤆

paraprobe: (required) NXcoordinate_system ⤆

type: (required) NX_CHAR ⤆

handedness: (required) NX_CHAR ⤆

x: (required) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH} ⤆

y: (required) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH} ⤆

z: (required) NX_NUMBER (Rank: 1, Dimensions: [3]) {units=NX_LENGTH} ⤆

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