AbstractPrimaryMirror

class esis.optics.abc.AbstractPrimaryMirror

Bases: Printable, Rollable, Yawable, Pitchable, Translatable

Attributes

material	optical material of this component
num_folds	The order of the rotational symmetry of the optical system.
pitch	pitch angle of this object
radius_clear	clear radius of the aperture from center to vertex
radius_mechanical	radius of the mechanical aperture from center to vertex
roll	roll angle of this object
sag	the sag function of this primary mirror
surface
transformation	the coordinate transformation between the global coordinate system and this object's local coordinate system
translation	translate the coordinate system
width_border	width of the border around the clear aperture
width_clear	width of the clear aperture from edge to edge
yaw	yaw angle of this object

Methods

__init__()
to_string([prefix])	Public-facing version of the __repr__ method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Inheritance Diagram

to_string(prefix=None)

Public-facing version of the __repr__ method that allows for defining a prefix string, which can be used to calculate how much whitespace to add to the beginning of each line of the result.

Parameters:

prefix (None | str) – an optional string, the length of which is used to calculate how much whitespace to add to the result.

Return type:

str

abstract property material: None | AbstractMaterial

optical material of this component

abstract property num_folds: Quantity | AbstractScalar

The order of the rotational symmetry of the optical system. This is also the number of sides of the regular polygonal aperture.

abstract property pitch: Quantity | int | float | complex | ndarray | AbstractScalar

pitch angle of this object

property radius_clear: Quantity | AbstractScalar

clear radius of the aperture from center to vertex

property radius_mechanical: Quantity | AbstractScalar

radius of the mechanical aperture from center to vertex

abstract property roll: Quantity | int | float | complex | ndarray | AbstractScalar

roll angle of this object

abstract property sag: None | AbstractSag

the sag function of this primary mirror

property surface: Surface

property transformation: AbstractTransformation

the coordinate transformation between the global coordinate system and this object’s local coordinate system

abstract property translation: Quantity | AbstractScalar | AbstractVectorArray

translate the coordinate system

abstract property width_border: Quantity | AbstractScalar

width of the border around the clear aperture

abstract property width_clear: Quantity | AbstractScalar

width of the clear aperture from edge to edge

abstract property yaw: Quantity | int | float | complex | ndarray | AbstractScalar

yaw angle of this object