Grating#

class esis.optics.Grating(serial_number: str = '', manufacturing_number: str = '', angle_input: astropy.units.quantity.Quantity = <Quantity 0. deg>, angle_output: astropy.units.quantity.Quantity = <Quantity 0. deg>, sag: None | optika.sags.AbstractSag = None, material: None | optika.materials._materials.AbstractMaterial = None, rulings: None | optika.rulings._rulings.AbstractRulings = None, num_folds: int = 0, halfwidth_inner: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, halfwidth_outer: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, width_border: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, width_border_inner: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, clearance: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, distance_radial: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. mm>, azimuth: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>, translation: astropy.units.quantity.Quantity | named_arrays._vectors.cartesian.vectors_cartesian_3d.AbstractCartesian3dVectorArray = <Quantity 0. mm>, pitch: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>, yaw: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>, roll: astropy.units.quantity.Quantity | named_arrays._scalars.scalars.AbstractScalar = <Quantity 0. deg>)#

Bases: AbstractGrating

Attributes

`angle_aperture`
`angle_input`
`angle_output`
`azimuth`
`clearance`
`distance_radial`
`halfwidth_inner`
`halfwidth_outer`
`manufacturing_number`
`material`
`num_folds`
`pitch`
`roll`
`rulings`
`sag`
`serial_number`
`surface`
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system
`translation`
`width_border`
`width_border_inner`
`yaw`

Methods

`__init__`([serial_number, ...])
`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:

serial_number (str)
manufacturing_number (str)
angle_input (Quantity)
angle_output (Quantity)
sag (None | AbstractSag)
material (None | AbstractMaterial)
rulings (None | AbstractRulings)
num_folds (int)
halfwidth_inner (Quantity | AbstractScalar)
halfwidth_outer (Quantity | AbstractScalar)
width_border (Quantity | AbstractScalar)
width_border_inner (Quantity | AbstractScalar)
clearance (Quantity | AbstractScalar)
distance_radial (Quantity | AbstractScalar)
azimuth (Quantity | AbstractScalar)
translation (Quantity | AbstractCartesian3dVectorArray)
pitch (Quantity | AbstractScalar)
yaw (Quantity | AbstractScalar)
roll (Quantity | AbstractScalar)

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#

angle_input: Quantity = <Quantity 0. deg>#

angle_output: Quantity = <Quantity 0. deg>#

azimuth: Quantity | AbstractScalar = <Quantity 0. deg>#

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

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

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

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

manufacturing_number: str = ''#

material: None | AbstractMaterial = None#

num_folds: int = 0#

pitch: Quantity | AbstractScalar = <Quantity 0. deg>#

roll: Quantity | AbstractScalar = <Quantity 0. deg>#

rulings: None | AbstractRulings = None#

sag: None | AbstractSag = None#

serial_number: str = ''#

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

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

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

yaw: Quantity | AbstractScalar = <Quantity 0. deg>#