CentralObscuration

class esis.optics.CentralObscuration(num_folds: int = 0, halfwidth: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, remove_last_vertex: bool = False, translation: astropy.units.quantity.Quantity | named_arrays._vectors.cartesian.vectors_cartesian_3d.AbstractCartesian3dVectorArray = <Quantity 0. mm>)

Bases: AbstractCentralObscuration

Attributes

halfwidth
num_folds
radius	distance from the center to a vertex of the obscuration
remove_last_vertex
surface
transformation	the coordinate transformation between the global coordinate system and this object's local coordinate system
translation

Methods

__init__([num_folds, halfwidth, ...])
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

Parameters:

• num_folds (int)

• halfwidth (Quantity | AbstractScalar)

• remove_last_vertex (bool)

• translation (Quantity | AbstractCartesian3dVectorArray)

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

halfwidth: Quantity | AbstractScalar = <Quantity 0. mm>

num_folds: int = 0

property radius: Quantity | AbstractScalar

distance from the center to a vertex of the obscuration

remove_last_vertex: bool = False

property surface: Surface

property transformation: AbstractTransformation

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

translation: Quantity | AbstractCartesian3dVectorArray = <Quantity 0. mm>