FieldStop

class esis.optics.FieldStop(num_folds=0, radius_clear=<Quantity 0. mm>, radius_mechanical=<Quantity 0. mm>, translation=<Quantity 0. mm>)

Bases: AbstractFieldStop

A model of the field stop of the instrument.

This element restricts the field of view of the spectrograph to simplify the inversion process.

Attributes

num_folds	The order of the rotational symmetry of the optical system.
num_sides	The number of sides of the field stop's aperture.
radius_clear	The distance from the center to a vertex of the clear aperture.
radius_mechanical	The radius of the exterior edge of the field stop.
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.
width_clear	The width of the clear aperture from edge to edge.

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

The order of the rotational symmetry of the optical system.

property num_sides: int

The number of sides of the field stop’s aperture.

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

The distance from the center to a vertex of the clear aperture.

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

The radius of the exterior edge of the field stop.

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.

property width_clear: Quantity

The width of the clear aperture from edge to edge.