.. do NOT edit this file automatically generated by dev_tools.docs.nxdl_index .. index:: ! see: class definitions; contributed definition ! contributed definition .. _contributed.definitions: Contributed Definitions ######################### A description of each NeXus contributed definition is given. NXDL files in the NeXus contributed definitions include propositions from the community for NeXus base classes or application definitions, as well as other NXDL files for long-term archival by NeXus. Consider the contributed definitions as either in *incubation* or a special case not for general use. The :ref:`NIAC` is charged to review any new contributed definitions and provide feedback to the authors before ratification and acceptance as either a base class or application definition. :ref:`NXaberration` Models for aberrations of electro-magnetic lenses in electron microscopy. :ref:`NXaperture` A beamline aperture :ref:`NXaperture_em` Details of an individual aperture for beams in electron microscopy. :ref:`NXapm` Application definition for atom probe and field ion microscopy experiments. :ref:`NXapm_input_ranging` Metadata to ranging definitions made for a dataset in atom probe microscopy. :ref:`NXapm_input_reconstruction` Metadata of a dataset (tomographic reconstruction) in atom probe microscopy. :ref:`NXapm_paraprobe_config_clusterer` Configuration of a paraprobe-clusterer tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_distancer` Configuration/settings of a paraprobe-distancer software tool run. :ref:`NXapm_paraprobe_config_intersector` Configuration of a paraprobe-intersector tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_nanochem` Configuration of a paraprobe-nanochem tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_ranger` Configuration of a paraprobe-ranger tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_selector` Configuration of a paraprobe-selector tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_spatstat` Configuration of a paraprobe-spatstat tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_surfacer` Configuration of a paraprobe-surfacer tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_tessellator` Configuration of a paraprobe-tessellator tool run in atom probe microscopy. :ref:`NXapm_paraprobe_config_transcoder` Configurations of a paraprobe-transcoder tool run in atom probe microscopy. :ref:`NXapm_paraprobe_results_clusterer` Results of a paraprobe-clusterer tool run. :ref:`NXapm_paraprobe_results_distancer` Results of a paraprobe-distancer tool run. :ref:`NXapm_paraprobe_results_intersector` Results of a paraprobe-intersector tool run. :ref:`NXapm_paraprobe_results_nanochem` Results of a paraprobe-nanochem tool run. :ref:`NXapm_paraprobe_results_ranger` Results of a paraprobe-ranger tool run. :ref:`NXapm_paraprobe_results_selector` Results of a paraprobe-selector tool run. :ref:`NXapm_paraprobe_results_spatstat` Results of a paraprobe-spatstat tool run. :ref:`NXapm_paraprobe_results_surfacer` Results of a paraprobe-surfacer tool run. :ref:`NXapm_paraprobe_results_tessellator` Results of a paraprobe-tessellator tool run. :ref:`NXapm_paraprobe_results_transcoder` Results of a paraprobe-transcoder tool run. :ref:`NXbeam` Properties of the neutron or X-ray beam at a given location. :ref:`NXcalibration` Subclass of NXprocess to describe post-processing calibrations. :ref:`NXcg_alpha_complex` Computational geometry description of alpha shapes or wrappings to primitives. :ref:`NXcg_cylinder_set` Computational geometry description of a set of cylinders in Euclidean space. :ref:`NXcg_ellipsoid_set` Computational geometry description of a set of ellipsoids in Euclidean space. :ref:`NXcg_face_list_data_structure` Computational geometry description of geometric primitives via a face and edge list. :ref:`NXcg_geodesic_mesh` Computational geometry description of a geodesic mesh. :ref:`NXcg_grid` Computational geometry description of a Wigner-Seitz cell grid in Euclidean space. :ref:`NXcg_half_edge_data_structure` Computational geeometry description of a half-edge data structure. :ref:`NXcg_hexahedron_set` Computational geometry description of a set of hexahedra in Euclidean space. :ref:`NXcg_marching_cubes` Computational geometry description of the marching cubes algorithm. :ref:`NXcg_parallelogram_set` Computational geometry description of a set of parallelograms in Euclidean space. :ref:`NXcg_point_set` Computational geometry description of a set of points in Euclidean space. :ref:`NXcg_polygon_set` Computational geometry description of a set of polygons in Euclidean space. :ref:`NXcg_polyhedron_set` Computational geometry description of a polyhedra in Euclidean space. :ref:`NXcg_polyline_set` Computational geometry description of a set of polylines in Euclidean space. :ref:`NXcg_roi_set` Base class to hold geometric primitives. :ref:`NXcg_sphere_set` Computational geometry description of a set of spheres in Euclidean space. :ref:`NXcg_tetrahedron_set` Computational geometry description of a set of tetrahedra in Euclidean space. :ref:`NXcg_triangle_set` Computational geometry description of a set of triangles in Euclidean space. :ref:`NXcg_triangulated_surface_mesh` Computational geometry description of a mesh of triangles. :ref:`NXcg_unit_normal_set` Computational geometry description of a set of (oriented) unit normal vectors. :ref:`NXchamber` Component of an instrument to store or place objects and specimens. :ref:`NXchemical_composition` (Chemical) composition of a sample or a set of things. :ref:`NXclustering` Metadata to the results of a clustering analysis. :ref:`NXcollectioncolumn` Subclass of NXelectronanalyser to describe the electron collection :ref:`NXcontainer` State of a container holding the sample under investigation. :ref:`NXcoordinate_system_set` Container to hold different coordinate systems conventions. :ref:`NXcorrector_cs` Corrector for aberrations in an electron microscope. :ref:`NXcs_computer` Computer science description of a set of computing nodes. :ref:`NXcs_cpu` Computer science description of a central processing unit (CPU) of a computer. :ref:`NXcs_filter_boolean_mask` Computer science base class for packing and unpacking booleans. :ref:`NXcs_gpu` Computer science description of a graphic processing unit (GPU) of a computer. :ref:`NXcs_io_obj` Computer science description of a storage object in an input/output system. :ref:`NXcs_io_sys` Computer science description of system of a computer. :ref:`NXcs_mm_sys` Computer science description of a main memory system of a computer. :ref:`NXcs_prng` Computer science description of pseudo-random number generator. :ref:`NXcs_profiling` Computer science description for summary performance/profiling data of an application. :ref:`NXcs_profiling_event` Computer science description of a profiling event. :ref:`NXcsg` Constructive Solid Geometry base class, using :ref:`NXquadric` and :ref:`NXoff_geometry` :ref:`NXcxi_ptycho` Application definition for a ptychography experiment, compatible with CXI from version 1.6. :ref:`NXdeflector` Deflectors as they are used e.g. in an electron analyser. :ref:`NXdelocalization` Base class to describe the delocalization of point-like objects on a grid. :ref:`NXdetector` A detector, detector bank, or multidetector. :ref:`NXdispersion` A dispersion denoting a sum of different dispersions. :ref:`NXdispersion_function` This describes a dispersion function for a material or layer :ref:`NXdispersion_repeated_parameter` A repeated parameter for a dispersion function :ref:`NXdispersion_single_parameter` A single parameter for a dispersion function :ref:`NXdispersion_table` A dispersion table denoting energy, dielectric function tabulated values. :ref:`NXdispersive_material` NXdispersion :ref:`NXdistortion` Subclass of NXprocess to describe post-processing distortion correction. :ref:`NXebeam_column` Container for components to form a controlled beam in electron microscopy. :ref:`NXelectronanalyser` Subclass of NXinstrument to describe a photoelectron analyser. :ref:`NXelectrostatic_kicker` definition for a electrostatic kicker. :ref:`NXellipsometry` Ellipsometry, complex systems, up to variable angle spectroscopy. :ref:`NXem` Characterization and session with one sample in an electron microscope. :ref:`NXem_ebsd` Application definition for collecting and indexing Kikuchi pattern into orientation maps. :ref:`NXem_ebsd_conventions` Conventions for rotations and coordinate systems to interpret EBSD data. :ref:`NXem_ebsd_crystal_structure_model` Crystal structure phase models used for indexing Kikuchi pattern. :ref:`NXenergydispersion` Subclass of NXelectronanalyser to describe the energy dispersion :ref:`NXentry` (**required**) :ref:`NXentry` describes the measurement. :ref:`NXevent_data_em` Metadata and settings of an electron microscope for scans and images. :ref:`NXevent_data_em_set` Container to hold NXevent_data_em instances of an electron microscope session. :ref:`NXfabrication` Details about a component as defined by its manufacturer. :ref:`NXgraph_edge_set` A set of (eventually directed) edges which connect nodes/vertices of a graph. :ref:`NXgraph_node_set` A set of nodes/vertices in space representing members of a graph. :ref:`NXgraph_root` An instance of a graph. :ref:`NXibeam_column` Container for components of a focused-ion-beam (FIB) system. :ref:`NXimage_set_em` Container for reporting a set of images taken with an electron microscope. :ref:`NXimage_set_em_adf` Container for reporting a set of annular dark field images. :ref:`NXimage_set_em_bf` Container for reporting a set of images taken in bright field mode. :ref:`NXimage_set_em_bse` Container for reporting a set of back-scattered electron images. :ref:`NXimage_set_em_chamber` Container for images recorded with e.g. a TV camera in the microscope chamber. :ref:`NXimage_set_em_df` Container for reporting a set of images taken in dark field mode. :ref:`NXimage_set_em_diffrac` Container for reporting a set of diffraction images. :ref:`NXimage_set_em_ecci` Container for reporting back-scattered electron channeling contrast images. :ref:`NXimage_set_em_kikuchi` Measured set of electron backscatter diffraction data, aka Kikuchi pattern. :ref:`NXimage_set_em_ronchigram` Container for reporting a set of images related to a ronchigram. :ref:`NXimage_set_em_se` Container for reporting a set of secondary electron images. :ref:`NXinstrument` Collection of the components of the instrument or beamline. Template of :ref:`NXinteraction_vol_em` Base class for storing details about a modelled shape of interaction volume. :ref:`NXion` Set of atoms of a molecular ion or fragment in e.g. ToF mass spectrometry. :ref:`NXisocontour` Computational geometry description of isocontouring/phase-fields in Euclidean space. :ref:`NXiv_temp` Application definition for temperature-dependent IV curve measurements. :ref:`NXlab_electro_chemo_mechanical_preparation` Grinding and polishing of a sample using abrasives in a wet lab. :ref:`NXlab_sample_mounting` Embedding of a sample in a medium for easing processability. :ref:`NXlens_em` Description of an electro-magnetic lens or a compound lens. :ref:`NXmagnetic_kicker` definition for a magnetic kicker. :ref:`NXmanipulator` Extension of NXpositioner to include fields to describe the use of :ref:`NXmatch_filter` Settings of a filter to select or remove entries based on their value. :ref:`NXmpes` This is the most general application definition for multidimensional :ref:`NXms` Application definition, spatiotemporal characterization of a microstructure. :ref:`NXms_atom_set` A base class to wrap details about a spatial configuration of atoms. :ref:`NXms_crystal_set` Base class to describe data about observed crystals in microstructures. :ref:`NXms_dislocation_set` Base class to describe details about dislocations observed in microstructures. :ref:`NXms_interface_set` Base class to describe details about interfaces observed in microstructures. :ref:`NXms_score_config` Application definition to control a simulation with the SCORE model. :ref:`NXms_score_results` Application definition for storing results of the SCORE cellular automaton. :ref:`NXms_snapshot` Base class for data on the state of the microstructure at a given time/iteration. :ref:`NXms_snapshot_set` A collection of spatiotemporal microstructure data. :ref:`NXoptical_system_em` A container for qualifying an electron optical system. :ref:`NXorientation_set` Details about individual orientations of a set of objects. :ref:`NXpeak` Description of peaks, their functional form or measured support. :ref:`NXpid` Contains the settings of a PID controller. :ref:`NXprocess` Document an event of data processing, reconstruction, or analysis for this data. :ref:`NXprogram` Base class to describe a software tool or library. :ref:`NXpulser_apm` Metadata for laser- and/or voltage-pulsing in atom probe microscopy. :ref:`NXpump` Device to reduce an atmosphere to a controlled remaining pressure level. :ref:`NXquadric` definition of a quadric surface. :ref:`NXquadrupole_magnet` definition for a quadrupole magnet. :ref:`NXreflectron` Device for reducing flight time differences of ions in ToF experiments. :ref:`NXregion` Geometry and logical description of a region of data in a parent group. When used, it could be a child group to, say, :ref:`NXdetector`. :ref:`NXregistration` Describes image registration procedures. :ref:`NXsample` Any information on the sample. :ref:`NXscanbox_em` Scan box and coils which deflect an electron beam in a controlled manner. :ref:`NXsensor_scan` Application definition for a generic scan using sensors. :ref:`NXseparator` definition for an electrostatic separator. :ref:`NXsimilarity_grouping` Metadata to the results of a similarity grouping analysis. :ref:`NXslip_system_set` Base class for describing a set of crystallographic slip systems. :ref:`NXsnsevent` This is a definition for event data from Spallation Neutron Source (SNS) at ORNL. :ref:`NXsnshisto` This is a definition for histogram data from Spallation Neutron Source (SNS) at ORNL. :ref:`NXsolenoid_magnet` definition for a solenoid magnet. :ref:`NXsolid_geometry` the head node for constructively defined geometry :ref:`NXsource` The neutron or x-ray storage ring/facility. :ref:`NXspatial_filter` Spatial filter to filter entries within a region-of-interest based on their position. :ref:`NXspectrum_set_em_auger` Container for reporting a set of auger electron energy spectra. :ref:`NXspectrum_set_em_cathodolum` Container for reporting a set of cathodoluminescence spectra. :ref:`NXspectrum_set_em_eels` Container for reporting a set of electron energy loss (EELS) spectra. :ref:`NXspectrum_set_em_xray` Container for reporting a set of energy-dispersive X-ray spectra. :ref:`NXspin_rotator` definition for a spin rotator. :ref:`NXspindispersion` Subclass of NXelectronanalyser to describe the spin filters in :ref:`NXstage_lab` A stage lab can be used to hold, align, orient, and prepare a specimen. :ref:`NXsubsampling_filter` Settings of a filter to sample entries based on their value. :ref:`NXtransmission` Application definition for transmission experiments :ref:`NXxpcs` X-ray Photon Correlation Spectroscopy (XPCS) data (results). .. toctree:: :hidden: NXaberration NXaperture NXaperture_em NXapm NXapm_input_ranging NXapm_input_reconstruction NXapm_paraprobe_config_clusterer NXapm_paraprobe_config_distancer NXapm_paraprobe_config_intersector NXapm_paraprobe_config_nanochem NXapm_paraprobe_config_ranger NXapm_paraprobe_config_selector NXapm_paraprobe_config_spatstat NXapm_paraprobe_config_surfacer NXapm_paraprobe_config_tessellator NXapm_paraprobe_config_transcoder NXapm_paraprobe_results_clusterer NXapm_paraprobe_results_distancer NXapm_paraprobe_results_intersector NXapm_paraprobe_results_nanochem NXapm_paraprobe_results_ranger NXapm_paraprobe_results_selector NXapm_paraprobe_results_spatstat NXapm_paraprobe_results_surfacer NXapm_paraprobe_results_tessellator NXapm_paraprobe_results_transcoder NXbeam NXcalibration NXcg_alpha_complex NXcg_cylinder_set NXcg_ellipsoid_set NXcg_face_list_data_structure NXcg_geodesic_mesh NXcg_grid NXcg_half_edge_data_structure NXcg_hexahedron_set NXcg_marching_cubes NXcg_parallelogram_set NXcg_point_set NXcg_polygon_set NXcg_polyhedron_set NXcg_polyline_set NXcg_roi_set NXcg_sphere_set NXcg_tetrahedron_set NXcg_triangle_set NXcg_triangulated_surface_mesh NXcg_unit_normal_set NXchamber NXchemical_composition NXclustering NXcollectioncolumn NXcontainer NXcoordinate_system_set NXcorrector_cs NXcs_computer NXcs_cpu NXcs_filter_boolean_mask NXcs_gpu NXcs_io_obj NXcs_io_sys NXcs_mm_sys NXcs_prng NXcs_profiling NXcs_profiling_event NXcsg NXcxi_ptycho NXdeflector NXdelocalization NXdetector NXdispersion NXdispersion_function NXdispersion_repeated_parameter NXdispersion_single_parameter NXdispersion_table NXdispersive_material NXdistortion NXebeam_column NXelectronanalyser NXelectrostatic_kicker NXellipsometry NXem NXem_ebsd NXem_ebsd_conventions NXem_ebsd_crystal_structure_model NXenergydispersion NXentry NXevent_data_em NXevent_data_em_set NXfabrication NXgraph_edge_set NXgraph_node_set NXgraph_root NXibeam_column NXimage_set_em NXimage_set_em_adf NXimage_set_em_bf NXimage_set_em_bse NXimage_set_em_chamber NXimage_set_em_df NXimage_set_em_diffrac NXimage_set_em_ecci NXimage_set_em_kikuchi NXimage_set_em_ronchigram NXimage_set_em_se NXinstrument NXinteraction_vol_em NXion NXisocontour NXiv_temp NXlab_electro_chemo_mechanical_preparation NXlab_sample_mounting NXlens_em NXmagnetic_kicker NXmanipulator NXmatch_filter NXmpes NXms NXms_atom_set NXms_crystal_set NXms_dislocation_set NXms_interface_set NXms_score_config NXms_score_results NXms_snapshot NXms_snapshot_set NXoptical_system_em NXorientation_set NXpeak NXpid NXprocess NXprogram NXpulser_apm NXpump NXquadric NXquadrupole_magnet NXreflectron NXregion NXregistration NXsample NXscanbox_em NXsensor_scan NXseparator NXsimilarity_grouping NXslip_system_set NXsnsevent NXsnshisto NXsolenoid_magnet NXsolid_geometry NXsource NXspatial_filter NXspectrum_set_em_auger NXspectrum_set_em_cathodolum NXspectrum_set_em_eels NXspectrum_set_em_xray NXspin_rotator NXspindispersion NXstage_lab NXsubsampling_filter NXtransmission NXxpcs