2.3.3.3.25. NXapm_paraprobe_intersector_results

Status:

application definition, extends NXobject

Description:

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

Application definition for results files of the paraprobe-intersector 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_c2n: The total number of links pointing from current to next.

n_n2c: The total number of links pointing from next to current.

n_features_curr: The total number of members in the current_set.

n_features_next: The total number of members in the next_set.

n_cluster: The total number of cluster found for coprecipitation analysis.

n_total: The number of rows in the table/matrix for coprecipitation statistics.

Groups cited:

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

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR ⤆

Obligatory value: NXapm_paraprobe_intersector_results

@version: (required) NX_CHAR ⤆

v_v_spatial_correlation: (optional) NXapm_paraprobe_tool_results

The results of an overlap/intersection analysis.

current_to_next_link: (required) NX_UINT (Rank: 2, Dimensions: [n_c2n, 2]) {units=NX_UNITLESS}

A matrix of feature_identifier that specifies which named features ...

A matrix of feature_identifier that specifies which named features from the current_set have directed link(s) pointing to which named feature(s) from the next_set.

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

For each link/pair in current_to_next a characterization whether the ...

For each link/pair in current_to_next a characterization whether the link is due to volumetric overlap (0x00 == 0), proximity (0x01 == 1), or something else unknown (0xFF == 255).

next_to_current_link: (optional) NX_UINT (Rank: 2, Dimensions: [n_n2c, 2]) {units=NX_UNITLESS}

A matrix of feature_identifier which specifies which named feature(s) ...

A matrix of feature_identifier which specifies which named feature(s) from the next_set have directed link(s) pointing to which named feature(s) from the current_set. Only if the mapping whereby the links are defined is symmetric it holds that next_to_current maps the links for current_to_next in just the opposite direction.

next_to_current_link_type: (optional) NX_UINT (Rank: 1, Dimensions: [n_n2c]) {units=NX_UNITLESS}

For each link/pair in next_to_current a characterization whether the ...

For each link/pair in next_to_current a characterization whether the link is due to a volumetric overlap (0x00 == 0), proximity (0x01 == 1), or something else unknown (0xFF == 255).

intersection_volume: (optional) NX_FLOAT (Rank: 1, Dimensions: [n_c2n]) {units=NX_VOLUME}

For each pair of links in current_to_next the volume of the ...

For each pair of links in current_to_next the volume of the intersection, i.e. how much volume do the two features share. If features do not intersect the volume is zero.

coprecipitation_analysis: (optional) NXprocess

During coprecipitation analysis the current and next set are analyzed ...

During coprecipitation analysis the current and next set are analyzed for links in a special way. Three set comparisons are made. Members of the set in each comparison are analyzed for overlap and proximity:

The first comparison is the current_set against the current_set. The second comparison is the next_set against the next_set. The third comparison is the current_set against the next_set.

Once the (forward) links for these comparisons are ready, pair relations are analyzed with respect to which objects with feature_identifier(s) cluster in identifier space. Thereby, a logical connection (link) is established between the features in the current_set and the next_set. Recall that these two sets typically represent different features within an observed system for otherwise the same parameterization.

Examples include two sets of e.g. precipitates with differing chemical composition that were characterized in the same material volume representing a snapshot of an e.g. microstructure at the same point in time. Researchers may have performed two analyses, one to characterize precipitates A and another one for percipitates B.

Coprecipitation analysis now logically connects these independent characterization results to establish spatial correlations of e.g. the precipitates’ spatial arrangement.

current_set_feature_to_cluster: (required) NX_UINT (Rank: 2, Dimensions: [n_features_curr, 2]) {units=NX_UNITLESS}

Matrix of feature_identifier and cluster_identifier pairs which ...

Matrix of feature_identifier and cluster_identifier pairs which encodes the cluster to which each feature_identifier was assigned. Here for features of the current_set.

next_set_feature_to_cluster: (required) NX_UINT (Rank: 2, Dimensions: [n_features_next, 2]) {units=NX_UNITLESS}

Matrix of feature_identifier and cluster_identifier pairs which ...

Matrix of feature_identifier and cluster_identifier pairs which encodes the cluster to which each feature_identifier was assigned. Here for features of the next_set.

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

The identifier (names) of the cluster.

cluster_composition: (required) NX_UINT (Rank: 2, Dimensions: [n_cluster, 3]) {units=NX_UNITLESS}

Pivot table as a matrix. ...

Pivot table as a matrix. The first column encodes how many members from the current_set are in each cluster, one row per cluster.

The second column encodes how many members from the next_set are in each cluster, in the same row per cluster respectively.

The third column encodes the total number of members in the cluster.

cluster_statistics: (required) NX_UINT (Rank: 2, Dimensions: [n_total, 2]) {units=NX_UNITLESS}

Pivot table as a matrix. ...

Pivot table as a matrix.

The first column encodes the different types of clusters based on their number of members in the sub-graph.

The second column encodes how many clusters with as many members exist.

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