SimpleVibration
- class hcipy.optics.SimpleVibration(mode, amplitude, frequency, phase_0=0)[source]
Bases:
OpticalElementA simple vibration model.
This models a purely sinusoidal vibration of a single mode (such as tip or tilt). No noise is added: the motion is purely sinusoidal with a single frequency. However, the frequency and amplitude can be changed on the fly, if necessary.
- Parameters:
- modeField
The spatial mode of the vibration.
- amplitudescalar
The amplitude of the vibration. After multiplying the mode and the amplitude, the resuilting units should be meters.
- frequencyscalar
The temporal frequency of the vibration in Hz.
- phase_0scalar, optional
The initial phase of the vibration in radians. Default is 0.
- Attributes:
- tfloat
The time in seconds.
Attributes Summary
The temporal frequency of the vibration in Hz.
The current phase of the vibration in radians.
Methods Summary
backward(wavefront)Propagate the wavefront backward through the vibration.
forward(wavefront)Propagate the wavefront forward through the vibration.
Attributes Documentation
- frequency
The temporal frequency of the vibration in Hz.
- phase
The current phase of the vibration in radians.
Methods Documentation