CircularHole

class marxs.math.geometry.CircularHole(kwargs)

Bases: PlaneWithHole

Base class for geometrically flat optical elements.

Methods Summary

inner_display(display)
inner_shape(display)
intersect(dir, pos)	Calculate the intersection point between a ray and the element
outer_display(display)	Return values in Euclidean space.
outer_shape(display)

Methods Documentation

inner_display(display)

inner_shape(display)

intersect(dir, pos)

Calculate the intersection point between a ray and the element

Parameters

dirnumpy.ndarray of shape (N, 4)

homogeneous coordinates of the direction of the ray

posnumpy.ndarray of shape (N, 4)

homogeneous coordinates of a point on the ray

Returns

intersectboolean array of length N

True if an intersection point is found.

interposnumpy.ndarray of shape (N, 4)

homogeneous coordinates of the intersection point. Values are set to np.nan if no intersection point is found.

interpos_localnumpy.ndarray of shape (N, 2)

y and z coordinates in the coordinate system of the active plane (not normalized to the dimensions of the element in question, but in absolute units).

outer_display(display)

Return values in Euclidean space.

outer_shape(display)