JonesMatrixOpticalElement

class hcipy.optics.JonesMatrixOpticalElement(jones_matrix)

Bases: hcipy.optics.optical_element.AgnosticOpticalElement

A general Jones Matrix.

Parameters

jones_matrixmatrix or Field

The Jones matrix describing the optical element.

Attributes Summary

mueller_matrix

Returns the Mueller matrix corresponding to the Jones matrix.

Methods Summary

backward(wavefront, *args, **kwargs)	Propagate a wavefront backward through the optical element.
forward(wavefront, *args, **kwargs)	Propagate a wavefront forward through the optical element.
get_input_grid(output_grid, wavelength)	Calculate a best guess for the input grid given an output grid and wavelength.
get_output_grid(input_grid, wavelength)	Calculate a best guess for the output grid given an input grid and wavelength.
make_instance(instance_data, input_grid, …)	Make an instance for this specific input_grid, output_grid, wavelength.

Attributes Documentation

mueller_matrix

Returns the Mueller matrix corresponding to the Jones matrix.

Methods Documentation

backward(wavefront, *args, **kwargs)

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(wavefront, *args, **kwargs)

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.

get_input_grid(output_grid, wavelength)

Calculate a best guess for the input grid given an output grid and wavelength.

This function is intended to be implemented by a derived class.

Parameters

output_gridGrid

The output grid.

wavelengthscalar

The wavelength.

Returns

Grid

The best-guess input grid based on the given output grid and wavelength.

get_output_grid(input_grid, wavelength)

Calculate a best guess for the output grid given an input grid and wavelength.

This function is intended to be implemented by a derived class.

Parameters

input_gridGrid

The input grid.

wavelengthscalar

The wavelength.

Returns

Grid

The best-guess output grid based on the given input grid and wavelength.

make_instance(instance_data, input_grid, output_grid, wavelength)

Make an instance for this specific input_grid, output_grid, wavelength.

This function is intended to be implemented by a derived class. Any properties evaluated for the instance can be stored into the instance_data object which is stored in the internal cache.

Parameters

instance_dataInstanceData

An object storing all data for this instance. This object can be modified this function.

input_gridGrid or None

The input grid.

output_gridGrid or None

The output grid.

wavelengthscalar or None

The wavelength.