FieldStop#

class esis.optics.FieldStop(num_folds: int = 0, radius_clear: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, radius_mechanical: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, translation: astropy.units.quantity.Quantity | named_arrays._vectors.cartesian.vectors_cartesian_3d.AbstractCartesian3dVectorArray = <Quantity 0. mm>)#

Bases: AbstractFieldStop

Attributes

`num_folds`
`num_sides`	number of sides of the field stop's aperture
`radius_clear`
`radius_mechanical`
`surface`
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system
`translation`
`width_clear`

Methods

`__init__`([num_folds, radius_clear, ...])
`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)
radius_clear (Quantity | AbstractScalar)
radius_mechanical (Quantity | AbstractScalar)
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

num_folds: int = 0#

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

radius_clear: Quantity | AbstractScalar = <Quantity 0. mm>#

radius_mechanical: Quantity | AbstractScalar = <Quantity 0. mm>#

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>#

property width_clear: Quantity#