AbstractComponent#

class furst.abc.AbstractComponent[source]#

Bases: Printable, Transformable

A base class representing a single component of the optical system.

Attributes

surface

Convert this object into an instance of optika.surfaces.AbstractSurface.

transformation

the coordinate transformation between the global coordinate system and this object's local coordinate system

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

Inheritance diagram of furst.abc.AbstractComponent
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 surface#

Convert this object into an instance of optika.surfaces.AbstractSurface.

abstract property transformation: None | AbstractTransformation#

the coordinate transformation between the global coordinate system and this object’s local coordinate system