nxtomo.nxobject.nxdetector

Module for handling an NXdetector.

Functions

cast_and_check_array_1D(array, array_name)	Cast the provided array to 1D and handle pint quantities.
check_dimensionality(expected_dimension[, ...])	Decorator to check the dimensionality of a pint.Quantity parameter.
check_quantity_consistency(reference, ...)	Compare two pint quantities and warn (or raise) when they differ.
deprecated([func, reason, replacement, ...])	Decorator that deprecates the use of a function.
docstring(origin)	Decorator to initialize the docstring from another source.
from_virtual_source_to_data_url(vs[, vs_slice])	Convert a h5py.VirtualSource to a DataUrl.
get_data(file_path, data_path)	Proxy to h5py_read_dataset, handling the case where data_path is not present in the file.
get_lr_flip(transformations)	Check along all transformations for those matching a left-right flip.
get_nexus_path(version)
get_quantity(file_path, data_path, default_unit)	Return the value and unit of an HDF5 dataset.
get_ud_flip(transformations)	Check along all transformations for those matching an up-down flip.
hdf5_open(filename)	Open a file as an h5py-like object.
ignore_deprecation_warning()	Filter logs from 'nxtomo.DEPRECATION'.
is_not(a, b, /)	Same as a is not b.

Classes

DataUrl([path, file_path, data_path, ...])	Non-mutable object to parse a string representing a resource data locator.
DetXFlipTransformation(flip[, axis_name, ...])	Convenient class to a flip with X (1, 0, 0) as the rotation axis.
DetYFlipTransformation(flip[, axis_name, ...])	Convenient class to a flip with Y (0, 1, 0) as the rotation axis.
FOV(value[, names, module, qualname, type, ...])	Possible field-of-view values.
FieldOfView	alias of FOV
FrameAppender(data, file_path, data_path, where)
ImageKey(value[, names, module, qualname, ...])	NXdetector image_key.
NXdetector([node_name, parent, ...])
NXdetectorWithUnit(default_unit[, ...])
NXobject(node_name[, parent])
NXtransformations([node_name, parent])
VDSmap(vspace, file_name, dset_name, src_space)	Defines a region in a virtual dataset mapping to part of a source dataset
VirtualSource(path_or_dataset[, name, ...])	Source definition for virtual data sets.
partial	partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.