ConstantRulingSpacing

class optika.rulings.ConstantRulingSpacing(constant, normal)

Bases: AbstractRulingSpacing

The simplest type of ruling spacing, a constant distance between each ruling.

Attributes

shape	The array shape of this object.
transformation	the coordinate transformation between the global coordinate system and this object's local coordinate system
constant	The constant describing the ruling spacing.
normal	The unit vector normal to the planes of the rulings.

Methods

__init__(constant, normal)
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:

• constant (Quantity | AbstractScalar)

• normal (AbstractCartesian3dVectorArray)

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

constant: Quantity | AbstractScalar

The constant describing the ruling spacing.

normal: AbstractCartesian3dVectorArray

The unit vector normal to the planes of the rulings.

property shape: dict[str, int]

The array shape of this object.

property transformation: None

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