Skip to content

Commit e3beb27

Browse files
committed
Clarify that Q is elastic
1 parent cfd10e2 commit e3beb27

File tree

1 file changed

+12
-0
lines changed
  • src/scippneutron/conversion

1 file changed

+12
-0
lines changed

src/scippneutron/conversion/tof.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,10 @@ def _wavelength_Q_conversions(x: Variable, two_theta: Variable) -> Variable:
321321
def Q_from_wavelength(*, wavelength: Variable, two_theta: Variable) -> Variable:
322322
r"""Compute the absolute value of the momentum transfer from wavelength.
323323
324+
Attention
325+
---------
326+
:math:`Q` as defined here is the momentum transfer for **elastic** scattering.
327+
324328
The result is
325329
326330
.. math::
@@ -350,6 +354,10 @@ def Q_from_wavelength(*, wavelength: Variable, two_theta: Variable) -> Variable:
350354
def wavelength_from_Q(*, Q: Variable, two_theta: Variable) -> Variable:
351355
r"""Compute the wavelength from momentum transfer.
352356
357+
Attention
358+
---------
359+
:math:`Q` as defined here is the momentum transfer for **elastic** scattering.
360+
353361
The result is the de Broglie wavelength
354362
355363
.. math::
@@ -384,6 +392,10 @@ def Q_elements_from_wavelength(
384392
) -> dict[str, Variable]:
385393
r"""Compute them momentum transfer vector from wavelength.
386394
395+
Attention
396+
---------
397+
:math:`Q` as defined here is the momentum transfer for **elastic** scattering.
398+
387399
Computes the three components of the Q-vector :math:`Q_x, Q_y, Q_z`
388400
separately using
389401

0 commit comments

Comments
 (0)