Vignetting

class kgpy.optics.aberration.Vignetting(wavelength, spatial_mesh, unvignetted_percent, mask, polynomial_degree=1)

Bases: object

Parameters

• wavelength (Quantity) –

• spatial_mesh (Vector2D) –

• unvignetted_percent (Quantity) –

• mask (ndarray) –

• polynomial_degree (int) –

__init__(wavelength, spatial_mesh, unvignetted_percent, mask, polynomial_degree=1)

Parameters

• wavelength (Quantity) –

• spatial_mesh (Vector2D) –

• unvignetted_percent (Quantity) –

• mask (ndarray) –

• polynomial_degree (int) –

Return type

None

Attributes

mesh
polynomial_degree
wavelength
spatial_mesh
unvignetted_percent
mask

Methods

__init__(wavelength, spatial_mesh, ...[, ...])
apply_model(model, cube, wavelength, ...)
model([inverse])	rtype kgpy.polynomial.Polynomial3D
plot(wavelength, spatial_mesh, data[, axs, ...])	rtype typing.MutableSequence[matplotlib.axes.Axes]
plot_residual([axs, config_index, other, ...])	rtype typing.MutableSequence[matplotlib.axes.Axes]
plot_unvignetted([axs, config_index, other, ...])	rtype typing.MutableSequence[matplotlib.axes.Axes]
residual([other, inverse])	rtype astropy.units.Quantity

Inheritance Diagram

static apply_model(model, cube, wavelength, spatial_min, spatial_max)

Parameters

• model (Polynomial3D) –

• cube (ndarray) –

• wavelength (Quantity) –

• spatial_min (Vector2D) –

• spatial_max (Vector2D) –

model(inverse=False)

Return type

kgpy.polynomial.Polynomial3D

Parameters

inverse (bool) –

static plot(wavelength, spatial_mesh, data, axs=None, config_index=None, data_name='', use_titles=True, use_xlabels=True, wavelength_name=None)

Return type

typing.MutableSequence[matplotlib.axes.Axes]

Parameters

• wavelength (Quantity) –

• spatial_mesh (Vector2D) –

• data (Quantity) –

• axs (Optional[MutableSequence[Axes]]) –

• config_index (Optional[Union[int, Tuple[int, ...]]]) –

• data_name (str) –

• use_titles (bool) –

• use_xlabels (bool) –

• wavelength_name (Optional[ndarray]) –

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[Vignetting]) –

• inverse (bool) –

• use_titles (bool) –

• use_xlabels (bool) –

• wavelength_name (Optional[ndarray]) –

plot_unvignetted(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[Vignetting]) –

• inverse (bool) –

• use_titles (bool) –

• use_xlabels (bool) –

• wavelength_name (Optional[ndarray]) –

residual(other=None, inverse=False)

Return type

astropy.units.Quantity

Parameters

• other (Optional[Vignetting]) –

• inverse (bool) –

mask: numpy.ndarray

property mesh: Vector3D

polynomial_degree: int = 1

spatial_mesh: kgpy.vector.Vector2D

unvignetted_percent: astropy.units.Quantity

wavelength: astropy.units.Quantity