AbstractSequentialSystem#

class optika.systems.AbstractSequentialSystem[source]#

Bases: AbstractSystem

An interface describing a sequential optical system.

A sequential optical system is a system where the ordering of the optical surfaces is known in advance.

Attributes

`axis_surface`	The name of the logical axis representing the sequence of surfaces.
`field_max`	The upper right corner of this optical system's field of view.
`field_min`	The lower left corner of this optical system's field of view.
`field_stop`	The field stop surface.
`grid_input`	The input grid to sample with rays.
`index_field_stop`	The index of the field stop in `surfaces_all`.
`index_pupil_stop`	The index of the pupil stop in `surfaces_all`.
`kwargs_plot`	Extra keyword arguments that will be used in the call to `named_arrays.plt.plot()` within the `plot()` method.
`object`	The external object being imaged or illuminated by this system.
`object_is_at_infinity`	A boolean flag indicating if the object is at infinity.
`pupil_max`	The upper right corner of this optical system's entrance pupil in physical units.
`pupil_min`	The lower left corner of this optical system's entrance pupil in physical units.
`pupil_stop`	The pupil stop surface.
`rayfunction_default`	Computes the rays in local coordinates at the last surface in the system as a function of input wavelength and position using `grid_input`.
`rayfunction_stops`	A rayfunction defined on the input surface of the optical system, which is designed to exactly strike the borders of both the field stop and the pupil stop.
`sensor`	The imaging sensor that measures the light captured by this system.
`shape`	The array shape of this object.
`surfaces`	A sequence of surfaces representing this optical system.
`surfaces_all`	Concatenate `object` with `surfaces` into a single list of surfaces.
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system

Methods

`__init__`()
`image`(scene[, wavelength, pupil, ...])	Forward model of the optical system.
`plot`([ax, transformation, components, ...])	Plot the surfaces of the system and the default raytrace.
`rayfunction`([intensity, wavelength, field, ...])	Given the wavelength, field position, and pupil position of some input rays, trace those rays through the system and return the resulting rays in local coordinates at the last surface.
`raytrace`([intensity, wavelength, field, ...])	Given the wavelength, field position, and pupil position of some input rays, trace those rays through the system and return the result in global coordinates, including all intermediate rays.
`spot_diagram`([figsize, s, cmap])	Create a spot diagram of the rays at each field point to inspect the performance of this optical system.
`to_dxf`(file, unit[, transformation])
`to_string`([prefix])	Public-facing version of the `__repr__` method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Inheritance Diagram

image(scene, wavelength=None, pupil=None, axis_wavelength=None, axis_field=None, axis_pupil=None, noise=True, **kwargs)[source]#

Forward model of the optical system. Maps the given spectral radiance of a scene to detector counts.

Parameters:

scene (FunctionArray[SpectralPositionalVectorArray, AbstractScalar]) – The spectral radiance of the scene as a function of wavelength and field position. The inputs must be cell vertices.
wavelength (None | AbstractScalar) – The vertices of the final wavelength grid on the image plane. If None (the default), scene.inputs.wavelength is used.
pupil (None | AbstractCartesian2dVectorArray) – The vertices of the pupil grid in either normalized or physical coordinates. If None, self.grid_input.pupil is used.
axis_wavelength (None | str) – The logical axis corresponding to changing wavelength coordinate. If None, set(scene.inputs.wavelength.shape) - set(self.shape), should have only one element.
axis_field (None | tuple[str, str]) – The two logical axes corresponding to changing field coordinate. If None, set(scene.inputs.position.shape) - set(self.shape) - {axis_wavelength}, should have exactly two elements.
axis_pupil (None | tuple[str, str]) – The two logical axes corresponding to changing pupil coordinate. If None, set(pupil.shape) - set(self.shape) - {axis_wavelength,} - set(axis_field), should have exactly two elements.
noise (bool) – Whether to add noise to the result.
kwargs – Additional keyword arguments used by subclass implementations of this method.

Return type:

FunctionArray[SpectralPositionalVectorArray, AbstractScalar]

plot(ax=None, transformation=None, components=None, plot_rays=True, plot_rays_vignetted=False, kwargs_rays=None, **kwargs)[source]#

Plot the surfaces of the system and the default raytrace.

Parameters:

ax (None | Axes | ScalarArray[ndarray[tuple[Any, ...], dtype[_ScalarT]]]) – The matplotlib axes on which to plot the system
transformation (None | AbstractTransformation) – Any additional transformation to apply to the system before plotting.
components (None | tuple[str, ...]) – The vector components to plot if ax is 2-dimensional.
plot_rays (bool) – Boolean flag indicating whether to plot the rays.
plot_rays_vignetted (bool) – Boolean flag indicating whether to plot the vignetted rays.
kwargs_rays (None | dict[str, Any]) – Any additional keyword arguments to use when plotting the rays.
kwargs – Any additional keyword arguments to use when plotting the surfaces.

Return type:

AbstractScalar | dict[str, AbstractScalar]

rayfunction(intensity=None, wavelength=None, field=None, pupil=None, normalized_field=True, normalized_pupil=True)[source]#

Given the wavelength, field position, and pupil position of some input rays, trace those rays through the system and return the resulting rays in local coordinates at the last surface.

Parameters:

intensity (None | float | Quantity | AbstractScalar) – The energy density of the input rays.
wavelength (None | Quantity | AbstractScalar) – The wavelengths of the input rays. If None (the default), self.grid_input.wavelength will be used.
field (None | AbstractCartesian2dVectorArray) – The field positions of the input rays, in either normalized or physical units. If None (the default), self.grid_input.field will be used.
pupil (None | AbstractCartesian2dVectorArray) – The pupil positions of the input rays, in either normalized or physical units. If None (the default), self.grid_input.pupil will be used.
normalized_field (bool) – A boolean flag indicating whether the field parameter is given in normalized or physical units.
normalized_pupil (bool) – A boolean flag indicating whether the pupil parameter is given in normalized or physical units.

Return type:

RayFunctionArray