lentil.field.Field.shift

Field.shift(z, wavelength, pixelscale, oversample, indexing='ij')[source]

Compute Field shift due to associated Tilt objects

Parameters
  • z (float) – Propagation distance

  • wavelength (float) – Wavelength

  • pixelscale ((2,) float) – Output plane spatial sampling

  • oversample (int) – Output plane oversampling factor

  • indexing ({'ij', 'xy'}, optional) – Cartesian (‘xy’) or matrix (‘ij’, default) indexing of output.

Returns

shift – Shifted location of the center of the field

Return type

tuple of floats

Notes

This function is capable of doing the conversion between the (x, y) coordinates of a Tilt and the (r, c) coordinates of a Field.