AbstractFilter#

class esis.optics.abc.AbstractFilter[source]#

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

An interface describing the visible-light filters of the instrument.

Attributes

`azimuth`	The angle of rotation about the axis of symmetry.
`distance_radial`	The distance of this object 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`	The radius of the filter's circular clear aperture.
`roll`	roll angle of this object
`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 width of the frame around the clear aperture.
`yaw`	yaw angle of this object

Methods

`__init__`()
`replace`(**changes)	A copy of this object with the given fields replaced.
`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

replace(**changes)#

A copy of this object with the given fields replaced.

A method version of dataclasses.replace(), matching named_arrays.AbstractArray.replace(), so that a nested change reads the same at every level:

system.replace(
    surface=system.surface.replace(
        sag=system.surface.sag.replace(radius=r),
    ),
)

The copy is shallow, as dataclasses.replace() is: every field which is not named is shared with the original, and mutating one through the copy is mutating it in both. Take copy.deepcopy() of the result where that matters.

Parameters:: changes – The fields to overwrite in the copy.
Return type:: Self

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#: The angle of rotation about the axis of symmetry.

abstract property distance_radial: Quantity | AbstractScalar#: The distance of this object 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#: The radius of the filter’s circular clear aperture.

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

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

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