Polynomial1dRulingSpacing

class optika.rulings.Polynomial1dRulingSpacing(coefficients, normal, transformation=None)

Bases: AbstractRulingSpacing

Ruling spacing specified by a 1-dimensional polynomial.

Attributes

shape	The array shape of this object.
transformation	An arbitrary coordinate system transformation applied to the argument of the polynomial.
coefficients	The coefficients of the polynomial represented as a dictionary where the values are the coefficients and the keys are the power associated with each coefficient.
normal	The unit vector normal to the planes of the rulings.

Methods

__init__(coefficients, normal[, transformation])
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

Parameters:

• coefficients (dict[int, Quantity | AbstractScalar])

• normal (AbstractCartesian3dVectorArray)

• transformation (None | AbstractTransformation)

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

coefficients: dict[int, Quantity | AbstractScalar]

The coefficients of the polynomial represented as a dictionary where the values are the coefficients and the keys are the power associated with each coefficient.

normal: AbstractCartesian3dVectorArray

The unit vector normal to the planes of the rulings.

property shape: dict[str, int]

The array shape of this object.

transformation: None | AbstractTransformation = None

An arbitrary coordinate system transformation applied to the argument of the polynomial.