ess.reduce.nexus.workflow.get_calibrated_detector#

ess.reduce.nexus.workflow.get_calibrated_detector(detector, *, transform, offset, bank_sizes)[source]#

Extract the data array corresponding to a detector’s signal field.

The returned data array includes coords and masks pertaining directly to the signal values array, but not additional information about the detector. The data array is reshaped to the logical detector shape, which by folding the data array along the detector_number dimension.

Parameters:

detector (NeXusComponent[NXdetector, TypeVar(RunType, nexus.types.BackgroundRun (int), nexus.types.EmptyBeamRun (int), nexus.types.SampleRun (int), TransmissionRun[nexus.types.SampleRun (int)], TransmissionRun[nexus.types.BackgroundRun (int)], nexus.types.VanadiumRun (int))]) – NeXus detector group.
offset (DetectorPositionOffset[TypeVar(RunType, nexus.types.BackgroundRun (int), nexus.types.EmptyBeamRun (int), nexus.types.SampleRun (int), TransmissionRun[nexus.types.SampleRun (int)], TransmissionRun[nexus.types.BackgroundRun (int)], nexus.types.VanadiumRun (int))]) – Offset to add to the detector position.
bank_sizes (nexus.types.DetectorBankSizes (dict)) – Dictionary of detector bank sizes.

Return type:

CalibratedDetector[TypeVar(RunType, nexus.types.BackgroundRun (int), nexus.types.EmptyBeamRun (int), nexus.types.SampleRun (int), TransmissionRun[nexus.types.SampleRun (int)], TransmissionRun[nexus.types.BackgroundRun (int)], nexus.types.VanadiumRun (int))]