physical_apertures.radial#

Radial Aperture Module

This module contains the RadialAperture class, which represents a radial aperture that clips rays based on their distance from the origin.

Kramer Harrison, 2025

Functions

configure_aperture(aperture)

Normalize a raw aperture spec (None, number, or BaseAperture).

Classes

RadialAperture(r_max[, r_min])

Represents a radial aperture that clips rays based on their distance from the origin.
class RadialAperture(r_max: float, r_min: float = 0)[source]#

Represents a radial aperture that clips rays based on their distance from the origin.

Variables:

  • r_max (float) – The maximum radius allowed for the rays.

  • r_min (float) – The minimum radius allowed for the rays. Defaults to 0.

clip(rays: RealRays)#

Clips the given rays based on the aperture’s shape.

Parameters:

rays (RealRays) – List of rays to be clipped.

Returns:

List of clipped rays.

Return type:

list

contains(x, y)[source]#

Checks if the given point is inside the aperture.

Parameters:

  • x (np.ndarray) – The x-coordinate of the point.

  • y (np.ndarray) – The y-coordinate of the point.

Returns:

Boolean array indicating if the point is inside the

aperture

Return type:

np.ndarray

property extent#

Returns the extent of the aperture.

Returns:

The extent of the aperture in the x and y directions.

Return type:

tuple

classmethod from_dict(data)[source]#

Create an aperture from a dictionary representation.

Parameters:

data (dict) – The dictionary representation of the aperture.

Returns:

The aperture object.

Return type:

RadialAperture

scale(scale_factor)[source]#

Scales the aperture by the given factor.

Parameters:

scale_factor (float) – The factor by which to scale the aperture.

to_dict()[source]#

Convert the aperture to a dictionary.

Returns:

The dictionary representation of the aperture.

Return type:

dict

view(nx: int = 256, ny: int = 256, ax: Axes | None = None, buffer: float = 1.1, **kwargs) → tuple[Figure, Axes]#

Visualize the aperture.

Parameters:

  • nx (int) – The number of points in the x-direction.

  • ny (int) – The number of points in the y-direction.

  • ax (Axes) – The axes to plot on.

  • buffer (float) – The buffer around the aperture.

  • **kwargs – Additional keyword arguments to pass to the plot function.

Returns:

A tuple containing the figure and axes objects.

Return type:

tuple

configure_aperture(aperture)[source]#

Normalize a raw aperture spec (None, number, or BaseAperture).