scippneutron.conversion.beamline.straight_incident_beam

scippneutron.conversion.beamline.straight_incident_beam(*, source_position, sample_position)

Compute the length of the beam from source to sample.

Assumes a straight beam. The result is

\[\mathtt{incident\_beam} = \mathtt{sample\_position} - \mathtt{source\_position}\]

Parameters:

• source_position (Variable | DataArray | Dataset | DataGroup[Any]) – Position of the beam’s source.

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

Returns:

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