2.3.3.3.34. NXapm_paraprobe_spatstat_results

Status:

application definition, extends NXobject

Description:

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

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

This tool is part of the paraprobe-toolbox. Inspect the base class NXapm_paraprobe_tool_results.

Symbols:

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

n_ions: The total number of ions in the reconstruction.

n_knn: The total number of bins in the histogram for the k-th nearest neighbor.

n_rdf: The total number of bins in the histogram for the radial distribution function.

Groups cited:

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

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR ⤆

Obligatory value: NXapm_paraprobe_spatstat_results

@version: (required) NX_CHAR ⤆

spatial_statisticsID: (optional) NXapm_paraprobe_tool_results

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

The iontype ID for each ion that was assigned to each ion during ...

The iontype ID for each ion that was assigned to each ion during the randomization of the ionlabels. Iontype labels are just permuted but the total number of values for each iontype remain the same.

The order matches the iontypes array from a given ranging results as it is specified in the configuration settings inside the specific config_filename that was used for this paraprobe-spatstat analysis.

window: (required) NXcs_filter_boolean_mask ⤆

number_of_ions: (required) NX_UINT ⤆

bitdepth: (required) NX_UINT ⤆

mask: (required) NX_UINT ⤆

knn: (optional) NXprocess

K-nearest neighbor statistics.

distance: (required) NX_FLOAT (Rank: 1, Dimensions: [n_knn]) {units=NX_LENGTH}

Right boundary of the binning.

probability_mass: (required) NX_FLOAT (Rank: 1, Dimensions: [n_knn]) {units=NX_DIMENSIONLESS}

cumulated: (required) NX_FLOAT (Rank: 1, Dimensions: [n_knn]) {units=NX_UNITLESS}

Cumulated not normalized by total counts.

cumulated_normalized: (required) NX_FLOAT (Rank: 1, Dimensions: [n_knn]) {units=NX_DIMENSIONLESS}

Cumulated and normalized by total counts.

rdf: (optional) NXprocess

Radial distribution statistics.

distance: (required) NX_FLOAT (Rank: 1, Dimensions: [n_rdf]) {units=NX_LENGTH}

Right boundary of the binning.

probability_mass: (required) NX_FLOAT (Rank: 1, Dimensions: [n_rdf]) {units=NX_DIMENSIONLESS}

cumulated: (required) NX_FLOAT (Rank: 1, Dimensions: [n_rdf]) {units=NX_UNITLESS}

Cumulated not normalized by total counts.

cumulated_normalized: (required) NX_FLOAT (Rank: 1, Dimensions: [n_rdf]) {units=NX_DIMENSIONLESS}

Cumulated and normalized by total counts.

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