ess.bifrost.live.cut#
- ess.bifrost.live.cut(data, *, axis_1, axis_2, arc_energy)[source]#
Cut data along two axes.
This function projects the input
dataexpressed in \(Q\) and \(\Delta E\) onto a 2D surface defined by the cut axes. This integrates over the other dimensions while preserving the arc dimension if present. Then, the projected data is histogrammed according to the axis bins.- Parameters:
data (
EnergyQDetector[TypeVar(RunType,ess.reduce.nexus.types.SampleRun(int),ess.reduce.nexus.types.VanadiumRun(int))]) – Input data with coordinates “sample_table_momentum_transfer” and “energy_transfer”.axis_1 (
ess.bifrost.live.CutAxis1(ess.bifrost.live.CutAxis)) – Defines the projection onto and binning in the first axis.axis_2 (
ess.bifrost.live.CutAxis2(ess.bifrost.live.CutAxis)) – Defines the projection onto and binning in the second axis.arc_energy (
ess.bifrost.types.ArcEnergy(scipp.Variable)) – The final energies for each analyzer arc.
- Returns:
CutData[TypeVar(RunType,ess.reduce.nexus.types.SampleRun(int),ess.reduce.nexus.types.VanadiumRun(int))] –dataprojected and histogrammed along the cut axes. If the input has an arc dimension, it is preserved in the output. Otherwise, all dimensions are integrated.