AbstractCentralObscuration

class esis.optics.abc.AbstractCentralObscuration

Bases: Printable, Translatable

An interface defining the central obscuration of the instrument.

Attributes

halfwidth	The distance from the center to the edge of the obscuration.
num_folds	The order of the rotational symmetry of the optical system.
radius	The distance from the center to a vertex of the obscuration.
remove_last_vertex	A flag controlling whether the last vertex should be removed.
surface	Represent this object as an optika 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

The 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

The distance from the center to a vertex of the obscuration.

abstract property remove_last_vertex: bool

A flag controlling whether the last vertex should be removed.

property surface: Surface

Represent this object as an optika 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