Distortion¶

class kgpy.optics.aberration.Distortion(wavelength, spatial_mesh_input, spatial_mesh_output, mask, polynomial_degree=1)¶

Bases: object

Parameters

wavelength (Quantity) –
spatial_mesh_input (Vector2D) –
spatial_mesh_output (Vector2D) –
mask (ndarray) –
polynomial_degree (int) –

__init__(wavelength, spatial_mesh_input, spatial_mesh_output, mask, polynomial_degree=1)¶

Parameters

wavelength (Quantity) –
spatial_mesh_input (Vector2D) –
spatial_mesh_output (Vector2D) –
mask (ndarray) –
polynomial_degree (int) –

Return type

None

Attributes

`dispersion`
`plate_scale`
`polynomial_degree`
`wavelength`
`spatial_mesh_input`
`spatial_mesh_output`
`mask`

Methods

`__init__`(wavelength, spatial_mesh_input, ...)
`model`([inverse])	rtype `kgpy.polynomial.Vector2DValuedPolynomial3D`
`plot_residual`([axs, config_index, other, ...])	rtype `typing.MutableSequence`[`matplotlib.axes.Axes`]
`residual`([other, inverse])	rtype `kgpy.vector.Vector2D`

Inheritance Diagram

model(inverse=False)¶

Return type: kgpy.polynomial.Vector2DValuedPolynomial3D
Parameters: inverse (bool) –

plot_residual(axs=None, config_index=None, other=None, inverse=False, use_titles=True, use_xlabels=True, wavelength_name=None)¶

Return type

typing.MutableSequence[matplotlib.axes.Axes]

Parameters

axs (Optional[MutableSequence[Axes]]) –
config_index (Optional[Union[int, Tuple[int, ...]]]) –
other (Optional[Distortion]) –
inverse (bool) –
use_titles (bool) –
use_xlabels (bool) –
wavelength_name (Optional[ndarray]) –

residual(other=None, inverse=False)¶

Return type

kgpy.vector.Vector2D

Parameters

other (Optional[Distortion]) –
inverse (bool) –

property dispersion: Quantity¶

mask: numpy.ndarray¶

property plate_scale: Vector2D¶

polynomial_degree: int = 1¶

spatial_mesh_input: kgpy.vector.Vector2D¶

spatial_mesh_output: kgpy.vector.Vector2D¶

wavelength: astropy.units.Quantity¶