AbstractCentralObscuration

class esis.optics.abc.AbstractCentralObscuration

Bases: Printable, Translatable

Attributes

halfwidth	distance from the center to the edge of the obscuration
num_folds	the order of the rotational symmetry of the optical system
radius	distance from the center to a vertex of the obscuration
remove_last_vertex	flag controlling whether the last vertex should be removed
surface
transformation	the coordinate transformation between the global coordinate system and this object's local coordinate system
translation	translate the coordinate system

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 halfwidth: Quantity | AbstractScalar

distance from the center to the edge of the obscuration

abstract property num_folds: int

the order of the rotational symmetry of the optical system

property radius: Quantity | AbstractScalar

distance from the center to a vertex of the obscuration

abstract property remove_last_vertex: bool

flag controlling whether the last vertex should be removed

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