CentralObscuration#

class esis.optics.CentralObscuration(num_folds=0, halfwidth=<Quantity 0. mm>, remove_last_vertex=False, translation=<Quantity 0. mm>)[source]#

Bases: AbstractCentralObscuration

A model of the central obscuration, also known as the Tuffet.

This obscures the central portion of the primary mirror to hold the diffraction gratings.

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`	A transformation which can arbitrarily translate this object.

Methods

`__init__`([num_folds, halfwidth, ...])
`replace`(**changes)	A copy of this object with the given fields replaced.
`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)

replace(**changes)#

A copy of this object with the given fields replaced.

A method version of dataclasses.replace(), matching named_arrays.AbstractArray.replace(), so that a nested change reads the same at every level:

system.replace(
    surface=system.surface.replace(
        sag=system.surface.sag.replace(radius=r),
    ),
)

The copy is shallow, as dataclasses.replace() is: every field which is not named is shared with the original, and mutating one through the copy is mutating it in both. Take copy.deepcopy() of the result where that matters.

Parameters:: changes – The fields to overwrite in the copy.
Return type:: Self

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>#: The distance from the center to the edge of the obscuration.

num_folds: int = 0#: 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.

remove_last_vertex: bool = False#: 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

translation: Quantity | AbstractCartesian3dVectorArray = <Quantity 0. mm>#: A transformation which can arbitrarily translate this object.