SimpleVibration¶
-
class
hcipy.optics.SimpleVibration(mode, amplitude, frequency, phase_0=0)¶ Bases:
hcipy.optics.optical_element.OpticalElementAttributes Summary
Methods Summary
backward(self, wavefront)Propagate a wavefront backward through the optical element.
forward(self, wavefront)Propagate a wavefront forward through the optical element.
Attributes Documentation
-
frequency¶
-
phase¶
Methods Documentation
-
backward(self, wavefront)¶ Propagate a wavefront backward through the optical element.
A backward propagation is a literal backward propagation through the element. It is not (in general) the inverse of the forward propagation, except in cases where energy is conserved.
This function will be implemented by the derived class.
- Parameters
- wavefrontWavefront
The wavefront to propagate.
- Returns
- Wavefront
The propagated wavefront.
-
forward(self, wavefront)¶ Propagate a wavefront forward through the optical element.
This will be implemented by the derived class.
- Parameters
- wavefrontWavefront
The wavefront to propagate.
- Returns
- Wavefront
The propagated wavefront.
-