EmptyOpticalElement¶
-
class
hcipy.optics.EmptyOpticalElement¶ Bases:
hcipy.optics.optical_element.OpticalElementAn empty optical element.
This optical element doesn’t modify the wavefront at all. This can be used as a replacement for optical elements. For example, when you don’t want to use a coronagraph for code that expects an optical element as a coronagraph, you can pass an instance of this class to effectively do nothing.
Methods Summary
backward(wavefront)Propagate the wavefront backward through the empty optical element.
forward(wavefront)Propagate the wavefront forward through the empty optical element.
get_transformation_matrix_backward([wavelength])Calculate the backward linear transformation matrix for the empty optical element.
get_transformation_matrix_forward([wavelength])Calculate the backward linear transformation matrix for the empty optical element.
Methods Documentation
-
backward(wavefront)¶ Propagate the wavefront backward through the empty optical element.
- Parameters
- wavefrontWavefront
The wavefront to propagate.
- Returns
- Wavefront
The propagated wavefront.
-
forward(wavefront)¶ Propagate the wavefront forward through the empty optical element.
- Parameters
- wavefrontWavefront
The wavefront to propagate.
- Returns
- Wavefront
The propagated wavefront.
-
get_transformation_matrix_backward(wavelength=1)¶ Calculate the backward linear transformation matrix for the empty optical element.
- Parameters
- wavelengthscalar
The wavelength for which the transformation matrix will be calculated.
- Returns
- ndarray
The full propagation matrix.
-
get_transformation_matrix_forward(wavelength=1)¶ Calculate the backward linear transformation matrix for the empty optical element.
- Parameters
- wavelengthscalar
The wavelength for which the transformation matrix will be calculated.
- Returns
- ndarray
The full propagation matrix.
-