2.3.3.3.39. NXapm_paraprobe_tool_config¶
Status:
base class, extends NXobject
Description:
Base class documenting the configuration used for a tool of the paraprobe-toolbo ...
Base class documenting the configuration used for a tool of the paraprobe-toolbox.
The paraprobe-toolbox is a collection of open-source software tools for performing efficient analyses of point cloud data where each point can represent atoms or (molecular) ions. A key application of the toolbox has been for research in the field of Atom Probe Tomography (APT) and related Field Ion Microscopy (FIM):
The toolbox does not replace but complements existent software tools in this research field. Given its capabilities of handling points as objects with properties and enabling analyses of the spatial arrangement of and inter- sections between geometric primitives, the software can equally be used for analyzing data in Materials Science and Materials Engineering.
The configuration and results of a run of a tool from the toolbox is documented using binary container formats. Currently, paraprobe-toolbox uses the Hierarchical Data Format 5 (HDF5).
Symbols:
No symbol table
- Groups cited:
NXidentifier, NXmatch_filter, NXserialized, NXspatial_filter, NXsubsampling_filter
Structure:
analysis_identifier: (optional) NX_UINT {units=NX_UNITLESS}
Internal identifier used by the tool to refer to an analysis (aka simulation ...
Internal identifier used by the tool to refer to an analysis (aka simulation id).
description: (optional) NX_CHAR
Possibility for leaving a free-text description about this analysis. ...
Possibility for leaving a free-text description about this analysis.
Although offered here for convenience we strongly encourage to parameterize such descriptions as much as possible to support reusage and clearer communication.
IDENTIFIER: (optional) NXidentifier
reconstruction: (optional) NXserialized
Specification of the tomographic reconstruction to use for this analysis. ...
Specification of the tomographic reconstruction to use for this analysis.
Typically, reconstructions in the field of atom probe tomography are communicated via files which store at least reconstructed ion positions and mass-to-charge-state-ratio values. Container files like HDF5 though can store multiple reconstructions. Therefore, the position and mass_to_charge concepts point to specific instances to use for this analysis.
position: (optional) NX_CHAR
Name of the node which resolves the reconstructed ion position ...
Name of the node which resolves the reconstructed ion position values to use for this analysis.
mass_to_charge: (optional) NX_CHAR
Name of the node which resolves the mass-to-charge-state-ratio ...
Name of the node which resolves the mass-to-charge-state-ratio values to use for this analysis.
ranging: (optional) NXserialized
Specification of the ranging definitions to use for this analysis. ...
Specification of the ranging definitions to use for this analysis.
Ranging is the process of labeling time-of-flight data with so-called iontypes (aka ion species). Ideally, iontypes specify the most likely (molecular) ion that is assumed to have been evaporated given that its mass-to-charge-state ratio lies within the specific mass-to-charge-state-ratio value interval of the iontype.
The so-called UNKNOWNTYPE iontype represents the null model of an ion that has not been ranged (for whatever reasons). The identifier of this special iontype is always the reserved value 0.
ranging_definitions: (optional) NX_CHAR
Name of the (parent) node directly below which (in the hierarchy) ...
Name of the (parent) node directly below which (in the hierarchy) the ranging definition for (molecular) ions are stored.
surface: (optional) NXserialized
Specification of the triangulated surface mesh to use for this analysis. ...
Specification of the triangulated surface mesh to use for this analysis.
Such a surface mesh can be used to define the edge of the reconstructed volume to account for finite size effects.
surface_distance: (optional) NXserialized
Specification of the point-to-triangulated-surface-mesh distances to ...
Specification of the point-to-triangulated-surface-mesh distances to use for this analysis.
distance: (optional) NX_CHAR
Absolute path in the (HDF5) file that points to the distance values. ...
Absolute path in the (HDF5) file that points to the distance values. The tool assumes that the values are stored in the same order as points (ions).
SPATIAL_FILTER: (optional) NXspatial_filter
SUBSAMPLING_FILTER: (optional) NXsubsampling_filter
MATCH_FILTER: (optional) NXmatch_filter
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
