AbstractFrontAperture#

class esis.optics.abc.AbstractFrontAperture[source]#

Bases: Printable, Replaceable, Translatable

An interface describing the entrance aperture of the instrument.

Attributes

`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__`()
`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

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

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