AbstractGrating

class esis.optics.abc.AbstractGrating

Bases: Printable, Rollable, Yawable, Pitchable, Translatable, CylindricallyTransformable

An interface describing the diffraction gratings of the instrument.

Attributes

angle_aperture	The angle of the grating's aperture.
angle_input	The nominal angle of the incident light from the field stop.
angle_output	The nominal angle of reflected light to the detectors.
azimuth	The angle of rotation about the axis of symmetry.
clearance	The minimum distance between adjacent physical gratings.
distance_radial	The distance of this object from the axis of symmetry.
halfwidth_inner	The distance from the apex to the inner edge of the clear aperture.
halfwidth_outer	The distance from the apex to the outer edge of the clear aperture.
manufacturing_number	An additional number describing this diffraction grating.
material	The optical material composing this grating.
num_folds	The order of the rotational symmetry of the optical system.
pitch	pitch angle of this object
roll	roll angle of this object
rulings	The ruling pattern of this grating.
sag	The sag function of this grating.
serial_number	The serial number of this diffraction grating.
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
width_border	The nominal width of the border around the clear aperture.
width_border_inner	The width of the border on the narrow edge of the grating.
yaw	yaw angle of this object

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

property angle_aperture: Quantity | AbstractScalar

The angle of the grating’s aperture.

This is equal to \(2 \pi / n\) radians, where \(n\) is the order of the rotational symmetry of the optical system.

abstract property angle_input: Quantity | AbstractScalar

The nominal angle of the incident light from the field stop.

abstract property angle_output: Quantity | AbstractScalar

The nominal angle of reflected light to the detectors.

abstract property azimuth: Quantity | AbstractScalar

The angle of rotation about the axis of symmetry.

abstract property clearance: Quantity | AbstractScalar

The minimum distance between adjacent physical gratings.

abstract property distance_radial: Quantity | AbstractScalar

The distance of this object from the axis of symmetry.

abstract property halfwidth_inner: Quantity | AbstractScalar

The distance from the apex to the inner edge of the clear aperture.

abstract property halfwidth_outer: Quantity | AbstractScalar

The distance from the apex to the outer edge of the clear aperture.

abstract property manufacturing_number: str

An additional number describing this diffraction grating.

abstract property material: None | AbstractMaterial

The optical material composing this grating.

abstract property num_folds: int

The order of the rotational symmetry of the optical system.

This determines the aperture wedge angle of this grating.

abstract property pitch: Quantity | int | float | complex | ndarray | AbstractScalar

pitch angle of this object

abstract property roll: Quantity | int | float | complex | ndarray | AbstractScalar

roll angle of this object

abstract property rulings: None | AbstractRulings

The ruling pattern of this grating.

abstract property sag: None | AbstractSag

The sag function of this grating.

abstract property serial_number: str

The serial number of this diffraction grating.

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

abstract property width_border: Quantity | AbstractScalar

The nominal width of the border around the clear aperture.

abstract property width_border_inner: Quantity | AbstractScalar

The width of the border on the narrow edge of the grating.

abstract property yaw: Quantity | int | float | complex | ndarray | AbstractScalar

yaw angle of this object