scippnexus.NXdetector

class scippnexus.NXdetector(attrs, children)

__init__(attrs, children)

Subclasses should call this in their __init__ method, or ensure that they initialize the fields in children with the correct sizes and dtypes.

Methods

__init__(attrs, children)	Subclasses should call this in their __init__ method, or ensure that they initialize the fields in children with the correct sizes and dtypes.
assemble(dg)	When a Group is indexed, this method is called to assemble the read children into the result object.
convert_label_index_to_positional(sel)
coord_allow_list()	Names of datasets that will be treated as coordinates.
index_child(child, sel)	Same as NXobject.index_child but also handles bin edges.
read_children(sel)	When a Group is indexed, this method is called to read all children.
transform_bitmask_to_dict_of_masks(bitmask)

Attributes

detector_number
sizes
unit

assemble(dg)

When a Group is indexed, this method is called to assemble the read children into the result object.

The default implementation simply returns the DataGroup.

Subclasses of NXobject, in particular NXdata, override this method to return an object with more semantics such as a DataArray or Dataset.

Return type:

DataGroup

coord_allow_list()

Names of datasets that will be treated as coordinates.

Note that in addition to these, all datasets matching the data’s dimensions as well as datasets explicitly referenced by an “indices” attribute in the group’s list of attributes will be treated as coordinates.

Override in subclasses to customize assembly of datasets into loaded output.

Return type:

list[str]