rayoptics.elem.surface module

Module for optical surface related classes

Surface
Container of profile, extent, position and orientation information of the surface

DecenterData
Maintains data and actions to support 4 types of position and orientation changes.

DEC: pos and orientation applied prior to surface

REV: pos and orientation applied following surface in reverse

DAR: pos and orientation applied prior to surface and then returned to initial frame

BEN: used for fold mirrors, orientation applied before and after surface

Aperture

Circular

Rectangular

Elliptical

class Surface(lbl: str = '', profile: SurfaceProfile | None = None, clear_apertures=None, edge_apertures=None, **kwargs)[source]

Bases: Interface

Container of profile, extent, position and orientation.

label: optional label

profile: SurfaceProfile

clear_apertures: list of Aperture

edge_apertures: list of Aperture

interface_type()[source]

listobj_str()[source]

update()[source]

sync_to_restore(opt_model)[source]

property profile_cv

property optical_power

set_optical_power(pwr, n_before, n_after)[source]

apply_scale_factor(scale_factor)[source]

from_first_order(nu_before, nu_after, y)[source]

update_following_reflection()[source]: Notification that incident light is following reflection.

z_sag(pt)[source]

set_z_sag(pt)[source]

calc_cv_from_zsag(pt)[source]

flip()[source]

get_ca_list()[source]: Filter obscurations out of the clear_aperture list.

get_ca_idx_list()[source]: Filter obscurations out of the clear_aperture list.

set_max_aperture(max_ap: float)[source]: max_ap is the max aperture radius

surface_od() → float[source]

point_inside(x: float, y: float, fuzz: float = 1e-05) → bool[source]

Returns True if the point (x, y) is inside the clear aperture.

Parameters:

x – x coodinate of the test point
y – y coodinate of the test point
fuzz – tolerance on test pt/aperture comparison, i.e. pt fuzzy <= surface_od

edge_pt_target(rel_dir: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]) → float[source]: Get a target for ray aiming to aperture boundaries.

get_y_aperture_extent()[source]: returns [y_min, y_max] for the union of apertures

full_profile(edge_extent, flat_id=None, dir=1, steps=6)[source]

intersect(p0, d, eps=1e-12, z_dir=1.0)[source]

Intersect an Interface, starting from an arbitrary point.

Parameters:

p0 – start point of the ray in the interface’s coordinate system
d – direction cosine of the ray in the interface’s coordinate system
z_dir – +1 if propagation positive direction, -1 if otherwise
eps – numeric tolerance for convergence of any iterative procedure

Returns:

distance to intersection point s1, intersection point p

Return type:

tuple

Raises:

TraceMissedSurfaceError –

normal(p)[source]: Returns the unit normal of the interface at point p.

class DecenterData(dtype, x=0.0, y=0.0, alpha=0.0, beta=0.0, gamma=0.0)[source]

Bases: object

Maintains data and actions for position and orientation changes.

‘decenter’: pos and orientation applied prior to surface
‘reverse’: pos and orientation applied following surface in reverse
‘dec and return’: pos and orientation applied prior to surface and then returned to initial frame
‘bend’: used for fold mirrors, orientation applied before and after surface