AbstractFilter#

class esis.optics.abc.AbstractFilter#

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

Attributes

`azimuth`	angle of rotation about the axis of symmetry
`distance_radial`	distance from the axis of symmetry
`material`	A model of the filter material including the mesh and oxide.
`pitch`	pitch angle of this object
`radius_clear`	radius of the circular clear aperture
`roll`	roll angle of this object
`surface`
`transformation`	the coordinate transformation between the global coordinate system and this object's local coordinate system
`translation`	translate the coordinate system
`width_border`	width of the frame around the clear aperture
`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

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

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

abstract property material: AbstractThinFilmFilter#: A model of the filter material including the mesh and oxide.

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

abstract property radius_clear: Quantity | AbstractScalar#: radius of the circular clear aperture

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

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#: width of the frame around the clear aperture

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