xicsrt_aperture
xicsrt.tools.xicsrt_aperture
A set of apertures for ray filtering.
- aperture_mask(X_local, m, aperture_info)[source]
Generate a mask array for the given aperture (or array of apertures).
- aperture_selector(X_local, m, aperture, _internal=False)[source]
Will call the appropriate aperture function for the given aperture name.
Note
This selector and all the individual function will modify the mask array in place.
- aperture_circle(X_local, m, aperture)[source]
A circular Aperture.
name: ‘circle’
- size: [radius]
Contains the radius of the aperture.
- aperture_square(X_local, m, aperture)[source]
A square Aperture.
name: ‘square’
- size: [x, y]
Contains the x and y size (full width) of the aperture.
- aperture_rectangle(X_local, m, aperture)[source]
A rectangular Aperture.
name: ‘rectangle’
- size: [x, y]
Contains the x and y size (full width) of the aperture.
- aperture_ellipse(X_local, m, aperture)[source]
An elliptical Aperture.
name: ‘ellipse’
- size: [x, y]
Contains the x and y size (full width) of the aperture.
- aperture_triangle(X_local, m, aperture)[source]
An triangular aperture defined by three vertices.
name: ‘ellipse’
- vertices: [[x0, y0], [x1,y1], [x2,y2]]
Contains the three vertices of the aperture.
Private Members
- _aperture_defaults(aperture)[source]