AbstractFieldStop#

class esis.optics.abc.AbstractFieldStop#

Bases: Printable, Translatable

Attributes

`num_folds`	order of the rotational symmetry of the optical system
`num_sides`	number of sides of the field stop's aperture
`radius_clear`	distance from the center to a vertex of the clear aperture
`radius_mechanical`	radius of the exterior edge of the field stop
`surface`
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system
`translation`	translate the coordinate system
`width_clear`

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 num_folds: int#: order of the rotational symmetry of the optical system

property num_sides: int#: number of sides of the field stop’s aperture

abstract property radius_clear: Quantity | AbstractScalar#: distance from the center to a vertex of the clear aperture

abstract property radius_mechanical: Quantity | AbstractScalar#: radius of the exterior edge of the field stop

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

property width_clear: Quantity#