Rays

class kgpy.optics.rays.Rays(transform=<factory>, intensity=<Quantity 1.>, wavelength=<Quantity 0. nm>, position=<factory>, direction=<factory>, velocity_los=<Quantity 0. km / s>, surface_normal=<factory>, index_of_refraction=<Quantity 1.>, vignetted_mask=array([ True]), error_mask=array([ True]), input_grid=None, distortion_polynomial_degree=2, vignetting_polynomial_degree=1)

Bases: Transformable

Parameters

• transform (TransformList) –

• intensity (Quantity) –

• wavelength (Quantity) –

• position (Vector3D) –

• direction (Vector3D) –

• velocity_los (Quantity) –

• surface_normal (Vector3D) –

• index_of_refraction (Quantity) –

• vignetted_mask (ndarray) –

• error_mask (ndarray) –

• input_grid (Optional[RayGrid]) –

• distortion_polynomial_degree (int) –

• vignetting_polynomial_degree (int) –

__init__(transform=<factory>, intensity=<Quantity 1.>, wavelength=<Quantity 0. nm>, position=<factory>, direction=<factory>, velocity_los=<Quantity 0. km / s>, surface_normal=<factory>, index_of_refraction=<Quantity 1.>, vignetted_mask=array([ True]), error_mask=array([ True]), input_grid=None, distortion_polynomial_degree=2, vignetting_polynomial_degree=1)

Parameters

• transform (TransformList) –

• intensity (Quantity) –

• wavelength (Quantity) –

• position (Vector3D) –

• direction (Vector3D) –

• velocity_los (Quantity) –

• surface_normal (Vector3D) –

• index_of_refraction (Quantity) –

• vignetted_mask (ndarray) –

• error_mask (ndarray) –

• input_grid (Optional[RayGrid]) –

• distortion_polynomial_degree (int) –

• vignetting_polynomial_degree (int) –

Return type

None

Attributes

aberration
axis
base_shape
distortion
distortion_polynomial_degree
energy
error_mask
field_angles
grid_shape
index_of_refraction
input_grid
intensity
mask
ndim
num_wavlength
position_apparent
position_avg_pupil
position_relative_pupil
shape
size
spot_size_rms
tol_iter
transformed
velocity_los
vignetted_mask
vignetting
vignetting_polynomial_degree
wavelength
position
direction
surface_normal

Methods

__init__([transform, intensity, wavelength, ...])
apply_transform_list(transform_list)	rtype kgpy.optics.rays.Rays
calc_labels(name, grid)
calc_mtf(psf, limit_min, limit_max)	rtype typing.Tuple[astropy.units.Quantity, kgpy.vector.Vector2D]
colorgrid(axis)	rtype numpy.ndarray
colormesh(axis)	rtype numpy.ndarray
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
from_field_angles(input_grid, position)	rtype kgpy.optics.rays.Rays
from_field_positions(input_grid, direction)	rtype kgpy.optics.rays.Rays
grid_labels(axis)	rtype numpy.ndarray
mtf([bins, frequency_min, use_vignetted])	rtype typing.Tuple[astropy.units.Quantity, kgpy.vector.Vector2D]
plot_attribute(attr_x, attr_y[, ax, ...])	rtype matplotlib.axes.Axes
plot_direction([ax, color_axis, plot_vignetted])	rtype matplotlib.axes.Axes
plot_position([ax, color_axis, plot_vignetted])	rtype matplotlib.axes.Axes
plot_pupil_hist2d_vs_field([config_index, ...])	rtype typing.Tuple[matplotlib.figure.Figure, numpy.ndarray]
plot_spot_size_vs_field([axs, config_index, ...])	rtype typing.MutableSequence[matplotlib.axes.Axes]
pupil_hist2d([bins, limit_min, limit_max, ...])	rtype typing.Tuple[numpy.ndarray, astropy.units.Quantity, astropy.units.Quantity]

Inheritance Diagram

apply_transform_list(transform_list)

Return type

kgpy.optics.rays.Rays

Parameters

transform_list (TransformList) –

classmethod calc_labels(name, grid)

Parameters

• name (str) –

• grid (Quantity) –

classmethod calc_mtf(psf, limit_min, limit_max)

Return type

typing.Tuple[astropy.units.Quantity, kgpy.vector.Vector2D]

Parameters

• psf (Quantity) –

• limit_min (Vector2D) –

• limit_max (Vector2D) –

colorgrid(axis)

Return type

numpy.ndarray

Parameters

axis (int) –

colormesh(axis)

Return type

numpy.ndarray

Parameters

axis (int) –

copy()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

copy_shallow()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

classmethod from_field_angles(input_grid, position)

Return type

kgpy.optics.rays.Rays

Parameters

• input_grid (RayGrid) –

• position (Vector3D) –

classmethod from_field_positions(input_grid, direction)

Return type

kgpy.optics.rays.Rays

Parameters

• input_grid (RayGrid) –

• direction (Vector3D) –

grid_labels(axis)

Return type

numpy.ndarray

Parameters

axis (int) –

mtf(bins=10, frequency_min=None, use_vignetted=False)

Return type

typing.Tuple[astropy.units.Quantity, kgpy.vector.Vector2D]

Parameters

• bins (Union[int, Vector2D]) –

• frequency_min (Optional[Union[Quantity, Vector2D]]) –

• use_vignetted (bool) –

plot_attribute(attr_x, attr_y, ax=None, color_axis=-2, plot_vignetted=False)

Return type

matplotlib.axes.Axes

Parameters

• attr_x (Quantity) –

• attr_y (Quantity) –

• ax (Optional[Axes]) –

• color_axis (int) –

• plot_vignetted (bool) –

plot_direction(ax=None, color_axis=-2, plot_vignetted=False)

Return type

matplotlib.axes.Axes

Parameters

• ax (Optional[Axes]) –

• color_axis (int) –

• plot_vignetted (bool) –

plot_position(ax=None, color_axis=-2, plot_vignetted=False)

Return type

matplotlib.axes.Axes

Parameters

• ax (Optional[Axes]) –

• color_axis (int) –

• plot_vignetted (bool) –

plot_pupil_hist2d_vs_field(config_index=0, wavlen_index=0, velocity_los_index=0, bins=10, limit_min=None, limit_max=None, use_vignetted=False, relative_to_centroid=(True, True), norm=None, cmap='viridis', kwargs_colorbar=None)

Return type

typing.Tuple[matplotlib.figure.Figure, numpy.ndarray]

Parameters

• config_index (int) –

• wavlen_index (int) –

• velocity_los_index (int) –

• bins (Union[int, Tuple[int, int]]) –

• limit_min (Optional[Vector2D]) –

• limit_max (Optional[Vector2D]) –

• use_vignetted (bool) –

• relative_to_centroid (Tuple[bool, bool]) –

• norm (Optional[Normalize]) –

• cmap (str) –

• kwargs_colorbar (Optional[Dict[str, Any]]) –

plot_spot_size_vs_field(axs=None, config_index=None, velocity_los_index=0, kwargs_colorbar=None, digits_after_decimal=3)

Return type

typing.MutableSequence[matplotlib.axes.Axes]

Parameters

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

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

• velocity_los_index (int) –

• kwargs_colorbar (Optional[Dict[str, Any]]) –

• digits_after_decimal (int) –

pupil_hist2d(bins=10, limit_min=None, limit_max=None, use_vignetted=False, relative_to_centroid=(False, False), use_position_apparent=False)

Return type

typing.Tuple[numpy.ndarray, astropy.units.Quantity, astropy.units.Quantity]

Parameters

• bins (Union[int, Tuple[int, int]]) –

• limit_min (Optional[Vector2D]) –

• limit_max (Optional[Vector2D]) –

• use_vignetted (bool) –

• relative_to_centroid (Tuple[bool, bool]) –

• use_position_apparent (bool) –

property aberration: Aberration

axis = <kgpy.optics.rays.Axis object>

property base_shape

direction: kgpy.vector.Vector3D

property distortion: Distortion

distortion_polynomial_degree: int = 2

property energy: Quantity

error_mask: numpy.ndarray = array([ True])

property field_angles: Vector2D

property grid_shape: Tuple[int, ...]

index_of_refraction: astropy.units.Quantity = <Quantity 1.>

input_grid: typing.Optional[kgpy.optics.rays.RayGrid] = None

intensity: astropy.units.Quantity = <Quantity 1.>

property mask: ndarray

property ndim

property num_wavlength

position: kgpy.vector.Vector3D

property position_apparent

property position_avg_pupil: Vector3D

property position_relative_pupil: Vector3D

property shape: Tuple[int, ...]

property size: int

property spot_size_rms

surface_normal: kgpy.vector.Vector3D

property tol_iter: Iterator[Transformable]

transform: TransformList

property transformed: Rays

velocity_los: astropy.units.Quantity = <Quantity 0. km / s>

vignetted_mask: numpy.ndarray = array([ True])

property vignetting: Vignetting

vignetting_polynomial_degree: int = 1

wavelength: astropy.units.Quantity = <Quantity 0. nm>