AbstractOpticsModel#

class esis.optics.abc.AbstractOpticsModel#

Bases: Printable, Rollable, Yawable, Pitchable

Attributes

`angle_grating_input`
`angle_grating_output`	The angle between the grating normal vector and the exit arm, in the plane perpendicular to the rulings.
`central_obscuration`	model of the central obscuration, which holds the diffraction grating array
`detector`	model of the CCD sensors
`field_stop`	model of the field stop
`filter`	model of the thin-film filters
`front_aperture`	model of the front aperture plate
`grating`	model of the diffraction grating array
`grid_input_normalized`	Normalized wavelength, pupil, and field coordinates to sample the optical system with
`name`	human-readable name of the instrument
`pitch`	pitch angle of this object
`primary_mirror`	model of the primary mirror
`requirements`	The required optical performance of the instrument.
`roll`	roll angle of this object
`system`	Resolve this optics model into an instance of `optika.systems.SequentialSystem`.
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system
`wavelength_max`	the maximum wavelength permitted through the system
`wavelength_min`	the minimum wavelength permitted through the system
`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_grating_input: AbstractScalar#

property angle_grating_output: AbstractScalar#

The angle between the grating normal vector and the exit arm, in the plane perpendicular to the rulings.

This is an analogue to the diffracted angle in the diffraction grating equation.

abstract property central_obscuration: None | AbstractCentralObscuration#: model of the central obscuration, which holds the diffraction grating array

abstract property detector: None | AbstractDetector#: model of the CCD sensors

abstract property field_stop: None | AbstractFieldStop#: model of the field stop

abstract property filter: None | AbstractFilter#: model of the thin-film filters

abstract property front_aperture: None | AbstractFrontAperture#: model of the front aperture plate

abstract property grating: None | AbstractGrating#: model of the diffraction grating array

abstract property grid_input_normalized: None | ObjectVectorArray#: Normalized wavelength, pupil, and field coordinates to sample the optical system with

abstract property name: str#: human-readable name of the instrument

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

abstract property primary_mirror: None | AbstractPrimaryMirror#: model of the primary mirror

abstract property requirements: None | Requirements#: The required optical performance of the instrument.

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

property system: SequentialSystem#

Resolve this optics model into an instance of optika.systems.SequentialSystem.

This is a cached property that is only computed once.

property transformation: AbstractTransformation#: the coordinate transformation between the global coordinate system and this object’s local coordinate system

property wavelength_max: Quantity | AbstractScalar#: the maximum wavelength permitted through the system

property wavelength_min: Quantity | AbstractScalar#: the minimum wavelength permitted through the system

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