.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_spatstat_results.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_spatstat_results (application definition) ! apm_paraprobe_spatstat_results (application definition) see: apm_paraprobe_spatstat_results (application definition); NXapm_paraprobe_spatstat_results .. _NXapm_paraprobe_spatstat_results: ================================ NXapm_paraprobe_spatstat_results ================================ **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: 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 :ref:`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. **Groups cited**: :ref:`NXapm_paraprobe_tool_common`, :ref:`NXapm_paraprobe_tool_results`, :ref:`NXcoordinate_system_set`, :ref:`NXcoordinate_system`, :ref:`NXcs_filter_boolean_mask`, :ref:`NXcs_profiling`, :ref:`NXentry`, :ref:`NXprocess`, :ref:`NXprogram`, :ref:`NXserialized`, :ref:`NXuser` .. index:: NXentry (base class); used in application definition, NXapm_paraprobe_tool_results (base class); used in application definition, NXcs_filter_boolean_mask (base class); used in application definition, NXprocess (base class); used in application definition, NXapm_paraprobe_tool_common (base class); used in application definition, NXserialized (base class); used in application definition, NXprogram (base class); used in application definition, NXcs_profiling (base class); used in application definition, NXuser (base class); used in application definition, NXcoordinate_system_set (base class); used in application definition, NXcoordinate_system (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_spatstat_results/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXapm_paraprobe_spatstat_results/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``NXapm_paraprobe_spatstat_results`` .. _/NXapm_paraprobe_spatstat_results/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID-group: **spatial_statisticsID**: (optional) :ref:`NXapm_paraprobe_tool_results` .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/iontypes_randomized-field: .. index:: iontypes_randomized (field) **iontypes_randomized**: (required) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_ions]) {units=\ :ref:`NX_UNITLESS `} .. collapse:: 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. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window-group: **window**: (required) :ref:`NXcs_filter_boolean_mask` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window/number_of_ions-field: .. index:: number_of_ions (field) **number_of_ions**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn-group: **knn**: (optional) :ref:`NXprocess` K-nearest neighbor statistics. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [i]) {units=\ :ref:`NX_LENGTH `} Right boundary of the binning. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/probability_mass-field: .. index:: probability_mass (field) **probability_mass**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [i]) {units=\ :ref:`NX_DIMENSIONLESS `} .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/cumulated-field: .. index:: cumulated (field) **cumulated**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [i]) {units=\ :ref:`NX_UNITLESS `} Cumulated not normalized by total counts. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/cumulated_normalized-field: .. index:: cumulated_normalized (field) **cumulated_normalized**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [i]) {units=\ :ref:`NX_DIMENSIONLESS `} Cumulated and normalized by total counts. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf-group: **rdf**: (optional) :ref:`NXprocess` Radial distribution statistics. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [j]) {units=\ :ref:`NX_LENGTH `} Right boundary of the binning. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/probability_mass-field: .. index:: probability_mass (field) **probability_mass**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [j]) {units=\ :ref:`NX_DIMENSIONLESS `} .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/cumulated-field: .. index:: cumulated (field) **cumulated**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [j]) {units=\ :ref:`NX_UNITLESS `} Cumulated not normalized by total counts. .. _/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/cumulated_normalized-field: .. index:: cumulated_normalized (field) **cumulated_normalized**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [j]) {units=\ :ref:`NX_DIMENSIONLESS `} Cumulated and normalized by total counts. .. _/NXapm_paraprobe_spatstat_results/ENTRY/common-group: **common**: (required) :ref:`NXapm_paraprobe_tool_common` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/status-field: .. index:: status (field) **status**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/analysis_identifier-field: .. index:: analysis_identifier (field) **analysis_identifier**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/config-group: **config**: (required) :ref:`NXserialized` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/config/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/config/path-field: .. index:: path (field) **path**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/config/checksum-field: .. index:: checksum (field) **checksum**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/config/algorithm-field: .. index:: algorithm (field) **algorithm**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/programID-group: **programID**: (required) :ref:`NXprogram` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/programID/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/programID/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling-group: **profiling**: (recommended) :ref:`NXcs_profiling` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/total_elapsed_time-field: .. index:: total_elapsed_time (field) **total_elapsed_time**: (required) :ref:`NX_FLOAT ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/current_working_directory-field: .. index:: current_working_directory (field) **current_working_directory**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/number_of_processes-field: .. index:: number_of_processes (field) **number_of_processes**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/number_of_threads-field: .. index:: number_of_threads (field) **number_of_threads**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/number_of_gpus-field: .. index:: number_of_gpus (field) **number_of_gpus**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/userID-group: **userID**: (optional) :ref:`NXuser` :ref:`⤆ ` If used, metadata of at least the person who performed this analysis. .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/userID/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set-group: **coordinate_system_set**: (required) :ref:`NXcoordinate_system_set` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe-group: **paraprobe**: (required) :ref:`NXcoordinate_system` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/handedness-field: .. index:: handedness (field) **handedness**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/x-field: .. index:: x (field) **x**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/y-field: .. index:: y (field) **y**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/z-field: .. index:: z (field) **z**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/analysis_identifier-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/config-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/config/algorithm-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/config/checksum-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/config/path-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/config/type-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/handedness-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/type-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/x-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/y-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/coordinate_system_set/paraprobe/z-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/current_working_directory-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/end_time-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/number_of_gpus-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/number_of_processes-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/number_of_threads-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/start_time-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/profiling/total_elapsed_time-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/programID-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/programID/program-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/programID/program@version-attribute ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/status-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/userID-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/common/userID/name-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/definition@version-attribute ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/iontypes_randomized-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/cumulated-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/cumulated_normalized-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/distance-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/knn/probability_mass-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/cumulated-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/cumulated_normalized-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/distance-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/rdf/probability_mass-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window-group ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window/bitdepth-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window/mask-field ` * :ref:`/NXapm_paraprobe_spatstat_results/ENTRY/spatial_statisticsID/window/number_of_ions-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_paraprobe_spatstat_results.nxdl.xml