lentil.Pupil.multiply¶
- Pupil.multiply(wavefront, inplace=False)[source]¶
Multiply with a wavefront
- Parameters
wavefront (
Wavefront
object) – Wavefront to be multipliedinplace (bool, optional) – If True, the wavefront object is multiplied in-place, otherwise a copy is created before performing the multiplication. Default is False.
Note
It is possible to customize the way multiplication is performed by creating a subclass and overloading its
multiply
method.- Returns
wavefront – Updated wavefront
- Return type
Wavefront
object