API Reference#

Classes#

Data Structures#

Attrs(attrs)

Field(dataset, parent[, sizes, dtype, errors])

NeXus field.

File(*args[, definitions])

Group(group[, definitions])

A group in a NeXus file.

NXaperture(attrs, children)

NXattenuator(attrs, children)

NXbeam(attrs, children)

NXbeam_stop(attrs, children)

NXbending_magnet(attrs, children)

NXcapillary(attrs, children)

NXcite(attrs, children)

NXcollection(attrs, children)

NXcollimator(attrs, children)

NXcrystal(attrs, children)

NXcylindrical_geometry(attrs, children)

NXdata(attrs, children[, fallback_dims, ...])

NXdetector(attrs, children)

NXdetector_group(attrs, children)

NXdetector_module(attrs, children)

NXdisk_chopper(attrs, children)

NXentry(attrs, children)

Entry in a NeXus file.

NXenvironment(attrs, children)

NXevent_data(attrs, children)

NXfermi_chopper(attrs, children)

NXfilter(attrs, children)

NXflipper(attrs, children)

NXfresnel_zone_plate(attrs, children)

NXgeometry(attrs, children)

NXgrating(attrs, children)

NXguide(attrs, children)

NXinsertion_device(attrs, children)

NXinstrument(attrs, children)

Group of instrument-related information.

NXlog(attrs, children)

NXlog, a time-series that can be loaded as a DataArray.

NXmirror(attrs, children)

NXmoderator(attrs, children)

NXmonitor(attrs, children)

NXmonochromator(attrs, children)

NXnote(attrs, children)

NXobject(attrs, children)

NXoff_geometry(attrs, children)

NXorientation(attrs, children)

NXparameters(attrs, children)

NXpdb(attrs, children)

NXpinhole(attrs, children)

NXpolarizer(attrs, children)

NXpositioner(attrs, children)

NXprocess(attrs, children)

NXreflections(attrs, children)

NXroot(attrs, children)

NXsample(attrs, children)

NXsample_component(attrs, children)

NXsensor(attrs, children)

NXshape(attrs, children)

NXslit(attrs, children)

NXsource(attrs, children)

NXsubentry(attrs, children)

NXtransformations(attrs, children)

Group of transformations.

NXtranslation(attrs, children)

NXuser(attrs, children)

NXvelocity_selector(attrs, children)

NXxraylens(attrs, children)

Exceptions#

NexusStructureError

Invalid or unsupported class and field structure in Nexus.

Typing#

typing.H5Dataset(*args, **kwargs)

h5py.Dataset-like

typing.H5Group(*args, **kwargs)

h5py.Group-like

typing.ScippIndex

alias of Union[ellipsis, int, tuple, slice, Tuple[str, Union[int, slice]], Dict[str, Union[int, slice]]]

Top-level functions#

compute_positions(dg, *[, store_position, ...])

Recursively compute positions from depends_on attributes as well as the [xyz]_pixel_offset fields of NXdetector groups.

create_field(group, name, data, **kwargs)

rtype:

H5Dataset

create_class(group, name, nx_class)

Create empty HDF5 group with given name and set the NX_class attribute.

Submodules#