AbstractGrating#

class esis.optics.abc.AbstractGrating#

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

Attributes

`angle_aperture`
`angle_input`	the nominal angle of incident light
`angle_output`	the nominal angle of reflected light
`azimuth`	angle of rotation about the axis of symmetry
`clearance`	minimum distance between adjacent physical gratings
`distance_radial`	distance from the axis of symmetry
`halfwidth_inner`	distance from the apex to the inner edge of the clear aperture
`halfwidth_outer`	distance from the apex to the outer edge of the clear aperture
`manufacturing_number`	additional number describing this diffraction grating
`material`	optical material of 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`	ruling pattern of this grating
`sag`	the sag function of this grating
`serial_number`	serial number of this diffraction grating
`surface`
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system
`translation`	translate the coordinate system
`width_border`	nominal width of the border around the clear aperture
`width_border_inner`	width of the border between the inner edge of the clear aperture and the substrate inner edge of the substrate.
`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#

abstract property angle_input: Quantity | AbstractScalar#: the nominal angle of incident light

abstract property angle_output: Quantity | AbstractScalar#: the nominal angle of reflected light

abstract property azimuth: Quantity | AbstractScalar#: angle of rotation about the axis of symmetry

abstract property clearance: Quantity | AbstractScalar#: minimum distance between adjacent physical gratings

abstract property distance_radial: Quantity | AbstractScalar#: distance from the axis of symmetry

abstract property halfwidth_inner: Quantity | AbstractScalar#: distance from the apex to the inner edge of the clear aperture

abstract property halfwidth_outer: Quantity | AbstractScalar#: distance from the apex to the outer edge of the clear aperture

abstract property manufacturing_number: str#: additional number describing this diffraction grating

abstract property material: None | AbstractMaterial#: optical material of 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#: ruling pattern of this grating

abstract property sag: None | AbstractSag#: the sag function of this grating

abstract property serial_number: str#: serial number of this diffraction grating

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

abstract property width_border: Quantity | AbstractScalar#: nominal width of the border around the clear aperture

abstract property width_border_inner: Quantity | AbstractScalar#: width of the border between the inner edge of the clear aperture and the substrate inner edge of the substrate.

abstract property yaw: Quantity | int | float | complex | ndarray | AbstractScalar#: yaw angle of this object