scippneutron.conversion.beamline.straight_scattered_beam#

scippneutron.conversion.beamline.straight_scattered_beam(*, position, sample_position)[source]#

Compute the length of the beam from sample to detector.

Assumes a straight beam. The result is

\[\mathtt{scattered\_beam} = \mathtt{position} - \mathtt{sample\_position}\]

Parameters:

position (Variable | DataArray | Dataset | DataGroup[Any]) – Position of the detector.
sample_position (Variable | DataArray | Dataset | DataGroup[Any]) – Position of the sample.

Returns:

Variable | DataArray | Dataset | DataGroup[Any] – scattered_beam