nxtomo.nxobject.nxdetector#

module for handling a nxdetector

Functions

cast_and_check_array_1D(array, array_name)

cast provided array to 1D

deprecated([func, reason, replacement, ...])

Decorator that deprecates the use of a function

deprecated_warning(type_, name[, reason, ...])

Function to log a deprecation warning

docstring(origin)

Decorator to initialize the docstring from another source.

from_virtual_source_to_data_url(vs)

convert a h5py.VirtualSource to a DataUrl

get_data(file_path, data_path)

proxy to h5py_read_dataset, handling use case 'data_path' not present in the file.

get_data_and_unit(file_path, data_path, ...)

return for an HDF5 dataset his value and his unit.

get_lr_flip(transformations)

check along all transformations if find Transformation matching 'LRTransformation'

get_nexus_path(version)

get_ud_flip(transformations)

check along all transformations if find Transformation matching 'UDTransformation'

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.

DetYFlipTransformation(flip[, axis_name, ...])

convenient class to define a detector up-down flip if we consider the center of the detector to be at (0, 0)

DetZFlipTransformation(flip[, axis_name, ...])

convenient class to define a detector up-down flip if we consider the center of the detector to be at (0, 0)

ElementWithUnit(default_unit)

FOV(value)

Possible existing field of view.

FieldOfView

alias of FOV

FrameAppender(data, file_path, data_path, where)

ImageKey(value)

NXdetector image_key.

MetricSystem(value)

Util enum to retrieve metric.

NXdetector([node_name, parent, ...])

NXdetectorWithUnit(default_unit[, ...])

NXobject(node_name[, parent])

NXtransformations([node_name, parent])

TimeSystem(value)

Unit system for time in SI units (seconds)

Unit(value)

Base class for all Unit.

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.