.. 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. Some contributions are grouped together: :ref:`Optical Spectroscopy ` :ref:`Multi-dimensional Photoemission Spectroscopy ` :ref:`Atom Probe Microscopy ` :ref:`Electron Microscopy ` :ref:`Transport Measurements ` :ref:`Geometry and Microstructures ` and others are simply listed here: :ref:`NXaberration` Quantified aberration coefficient in an aberration_model. :ref:`NXaberration_model` Models for aberrations of electro-magnetic lenses in electron microscopy. :ref:`NXaberration_model_ceos` CEOS definitions/model for aberrations of electro-magnetic lenses. :ref:`NXaberration_model_nion` NION definitions/model for aberrations of electro-magnetic lenses. :ref:`NXadc` Analog-to-digital converter component/integrated circuit. :ref:`NXaperture_em` Details of an individual aperture for beams in electron microscopy. :ref:`NXbeam_path` A beam path consisting of one or more optical elements. :ref:`NXbeam_splitter` A beam splitter, i.e. a device splitting the light into two or more beams. :ref:`NXcalibration` Subclass of NXprocess to describe post-processing calibrations. :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:`NXcircuit_board` Circuit board with e.g. ADC and/or DAC electronic components. :ref:`NXclustering` Metadata to the results of a clustering analysis. :ref:`NXcollectioncolumn` Subclass of NXelectronanalyser to describe the electron collection column of a :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:`NXdac` Digital-to-analog converter component/integrated circuit. :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:`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 of a sample during a session on 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 section of a :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:`NXfiber` An optical fiber, e.g. glass fiber. :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` Container for reporting a set of images taken. :ref:`NXimage_set_em_adf` Container for reporting a set of annular dark field images. :ref:`NXimage_set_em_kikuchi` Measured set of electron backscatter diffraction data, aka Kikuchi pattern. :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:`NXlens_opt` Description of an optical lens. :ref:`NXmagnetic_kicker` definition for a magnetic kicker. :ref:`NXmanipulator` Extension of NXpositioner to include fields to describe the use of manipulators :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:`NXopt` An application definition for optical spectroscopy experiments. :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:`NXpolarizer_opt` An optical polarizer. :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:`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:`NXspatial_filter` Spatial filter to filter entries within a region-of-interest based on their :ref:`NXspectrum_set` Container for reporting a set of 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 photoemission :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:`NXwaveplate` A waveplate or retarder. :ref:`NXxpcs` X-ray Photon Correlation Spectroscopy (XPCS) data (results). .. toctree:: :hidden: em-structure ellipsometry-structure mpes-structure apm-structure transport-structure cgms-structure NXaberration NXaberration_model NXaberration_model_ceos NXaberration_model_nion NXadc NXaperture_em NXapm NXapm_composition_space_results 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_path NXbeam_splitter 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 NXcircuit_board 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 NXdac NXdeflector NXdelocalization 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 NXevent_data_em NXevent_data_em_set NXfabrication NXfiber NXgraph_edge_set NXgraph_node_set NXgraph_root NXibeam_column NXimage_set NXimage_set_em_adf NXimage_set_em_kikuchi NXinteraction_vol_em NXion NXisocontour NXiv_temp NXlab_electro_chemo_mechanical_preparation NXlab_sample_mounting NXlens_em NXlens_opt NXmagnetic_kicker NXmanipulator NXmatch_filter NXmpes NXms NXms_feature_set NXms_score_config NXms_score_results NXms_snapshot NXms_snapshot_set NXopt NXoptical_system_em NXorientation_set NXpeak NXpid NXpolarizer_opt NXprogram NXpulser_apm NXpump NXquadric NXquadrupole_magnet NXreflectron NXregion NXregistration NXscanbox_em NXsensor_scan NXseparator NXsimilarity_grouping NXslip_system_set NXsnsevent NXsnshisto NXsolenoid_magnet NXsolid_geometry NXspatial_filter NXspectrum_set NXspectrum_set_em_eels NXspectrum_set_em_xray NXspin_rotator NXspindispersion NXstage_lab NXsubsampling_filter NXtransmission NXwaveplate NXxpcs