2.3.3.1. Base Class Definitions¶
A description of each NeXus base class definition is given. NeXus base class definitions define the set of terms that might be used in an instance of that class. Consider the base classes as a set of components that are used to construct a data file.
- NXaberration
Quantified aberration coefficient in an aberration_model.
- NXactivity
A planned or unplanned action that has a temporal extension and for some time depends on some entity.
- NXactuator
An actuator used to control an external condition.
- NXaperture
A beamline aperture.
- NXatom
Base class for documenting a set of atoms.
- NXattenuator
A device that reduces the intensity of a beam by attenuation.
- NXbeam
Properties of the neutron or X-ray beam at a given location.
- NXbeam_stop
A device that blocks the beam completely, usually to protect a detector.
- NXbeam_transfer_matrix_table
Contains data structures of an experimental optical setup (i.e., multiple
- NXbending_magnet
A bending magnet
- NXcalibration
Subclass of NXprocess to describe post-processing calibrations.
- NXcapillary
A capillary lens to focus the X-ray beam.
- NXchemical_composition
Chemical composition of a sample or a set of things.
- NXcircuit
Base class for documenting circuit devices.
- NXcite
A literature reference
- NXcollection
An unvalidated set of terms, such as the description of a beam line.
- NXcollectioncolumn
Electron collection column of an electron analyzer.
- NXcollimator
A beamline collimator.
- NXcomponent
Base class for components of an instrument - real ones or simulated ones.
- NXcoordinate_system
Base class to detail a coordinate system (CS).
- NXcorrector_cs
Base class for a corrector reducing (spherical) aberrations of an electron optical setup.
- NXcrystal
A crystal monochromator or analyzer.
- NXcs_computer
Base class for reporting the description of a computer
- NXcs_filter_boolean_mask
Base class for packing and unpacking booleans.
- NXcs_memory
Base class for reporting the description of the memory system of a computer.
- NXcs_prng
Computer science description of pseudo-random number generator.
- NXcs_processor
Base class for reporting the description of processing units of a computer.
- NXcs_profiling
Computer science description for performance and profiling data of an application.
- NXcs_profiling_event
Computer science description of a profiling event.
- NXcs_storage
Base class for reporting the description of the I/O of a computer.
- NXcylindrical_geometry
Geometry description for cylindrical shapes.
- NXdata
The NXdata class is designed to encapsulate all the information required for a set of data to be plotted.
- NXdeflector
Component of an electron analyzer that deflects the paths of electrons. This includes electrostatic and electromagnetic deflectors.
- NXdetector
A detector, detector bank, or multidetector.
- NXdetector_channel
Description and metadata for a single channel from a multi-channel detector.
- NXdetector_group
Logical grouping of detectors. When used, describes a group of detectors.
- NXdetector_module
Geometry and logical description of a detector module. When used, child group to NXdetector.
- NXdisk_chopper
A device blocking the beam in a temporal periodic pattern.
- NXdistortion
Subclass of NXprocess to describe post-processing distortion correction.
- NXebeam_column
Base class for a set of components providing a controllable electron beam.
- NXelectromagnetic_lens
Base class for an electro-magnetic lens or a compound lens.
- NXelectron_detector
A subclass of NXdetector for detectors that detect electrons.
- NXelectronanalyzer
Basic class for describing an electron analyzer.
- NXem_ebsd
Base class method-specific for Electron Backscatter Diffraction (EBSD).
- NXem_eds
Base class method-specific for energy-dispersive X-ray spectroscopy (EDS/EDXS).
- NXem_eels
Base class method-specific for Electron Energy Loss Spectroscopy (EELS).
- NXem_event_data
Base class to store state and (meta)data of events for electron microscopy.
- NXem_img
Base class for method-specific generic imaging with electron microscopes.
- NXem_instrument
Base class for instrument-related details of a real or simulated electron microscope.
- NXem_interaction_volume
Base class to describe the volume of interaction for particle-matter interaction.
- NXem_measurement
Base class for documenting a measurement with an electron microscope.
- NXem_optical_system
Base class for qualifying an electron optical system.
- NXem_simulation
Base class for documenting a simulation of electron beam-matter interaction.
- NXenergydispersion
Energy dispersion section of an electron analyzer.
- NXentry
(required) NXentry describes the measurement.
- NXenvironment
Parameters for controlling external conditions
- NXevent_data
NXevent_data is a special group for storing data from neutron
- NXfabrication
Details about a component as it is defined by its manufacturer.
- NXfermi_chopper
A Fermi chopper, possibly with curved slits.
- NXfilter
For band pass beam filters.
- NXfit
Description of a fit procedure using a scalar valued global function
- NXfit_function
This describes a fit function that is used to fit data to any functional form.
- NXflipper
A spin flipper.
- NXfresnel_zone_plate
A fresnel zone plate
- NXgeometry
legacy class - recommend to use NXtransformations now
- NXgrating
A diffraction grating, as could be used in a soft X-ray monochromator
- NXguide
A neutron optical element to direct the path of the beam.
- NXhistory
A set of activities that occurred to a physical entity prior/during experiment.
- NXibeam_column
Base class for a set of components equipping an instrument with FIB capabilities.
- NXimage
Base class for reporting a set of images representing specializations of NXdata.
- NXinsertion_device
An insertion device, as used in a synchrotron light source.
- NXinstrument
Collection of the components of the instrument or beamline.
- NXlog
Information recorded as a function of time.
- NXmanipulator
Base class to describe the use of manipulators and sample stages.
- NXmirror
A beamline mirror or supermirror.
- NXmoderator
A neutron moderator
- NXmonitor
A monitor of incident beam data.
- NXmonochromator
A wavelength defining device.
- NXnote
Any additional freeform information not covered by the other base classes.
- NXobject
This is the base object of NeXus. The groups and fields contained
- NXoff_geometry
Geometry (shape) description.
- NXoptical_lens
Description of an optical lens.
- NXoptical_window
A window of a cryostat, heater, vacuum chamber or a simple glass slide.
- NXorientation
legacy class - recommend to use NXtransformations now
- NXparameters
Container for parameters, usually used in processing or analysis.
- NXpdb
A NeXus transliteration of a PDB file, to be validated only as a PDB
- NXpeak
Base class for describing a peak, its functional form, and support values
- NXphase
Base class to describe a (thermodynamic) phase as a component of a material.
- NXpid_controller
A description of a feedback system in terms of the settings of a proportional-integral-derivative (PID) controller.
- NXpinhole
A simple pinhole.
- NXpolarizer
A spin polarizer.
- NXpositioner
A generic positioner such as a motor or piezo-electric transducer.
- NXprocess
The NXprocess class describes an operation used to
- NXprogram
Base class to describe a software tool or library.
- NXpump
Device to reduce an atmosphere to a controlled pressure.
- NXreflections
Reflection data from diffraction experiments
- NXregistration
Describes image registration procedures.
- NXresolution
Describes the resolution of a physical quantity.
- NXroi_process
Base class to report on the characterization of an area or volume of material.
- NXroot
The root of a NeXus file.
- NXrotations
Base class to detail a set of rotations, orientations, and disorientations.
- NXsample
Any information on the sample.
- NXsample_component
One group like this per component can be recorded for a sample consisting of multiple components.
- NXscan_controller
The scan box or scan controller is a component that is used to deflect a
- NXsensor
A sensor used to monitor an external condition
- NXshape
legacy class - (used by NXgeometry) - the shape and size of a component.
- NXslit
A simple slit.
- NXsource
Radiation source emitting a beam.
- NXspectrum
Base class container for reporting a set of spectra.
- NXspindispersion
Class to describe spin filters in photoemission experiments.
- NXsubentry
Group of multiple application definitions for “multi-modal” (e.g. SAXS/WAXS) measurements.
- NXtransformations
Collection of axis-based translations and rotations to describe a geometry.
- NXtranslation
legacy class - (used by NXgeometry) - general spatial location of a component.
- NXunit_cell
Base class to describe structural aspects of an arrangement of
- NXuser
Contact information for a user.
- NXvelocity_selector
A neutron velocity selector
- NXwaveplate
A waveplate or retarder.
- NXxraylens
An X-ray lens, typically at a synchrotron X-ray beam line.
