AbstractRowlandComponent#

class furst.abc.AbstractRowlandComponent[source]#

Bases: AbstractComponent

A base class representing an optical component on the Rowland circle.

Attributes

rowland_azimuth

The azimuth of the optical component on the Rowland circle.

rowland_radius

The radius of the Rowland circle.

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.AbstractRowlandComponent
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 rowland_azimuth: Quantity | AbstractScalar#

The azimuth of the optical component on the Rowland circle.

abstract property rowland_radius: Quantity | AbstractScalar#

The radius of the Rowland circle.

abstract property surface#

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

property transformation: None | AbstractTransformation#

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