RoughnessParameters#

class optika.metrology.RoughnessParameters(period_min=<Quantity 0. mm>, period_max=<Quantity 0. mm>)[source]#

Bases: Printable, Shaped

The parameters needed to compute the roughness of an optical surface.

Attributes

`period_max`	The maximum period to consider when calculating roughness.
`period_min`	The minimum period to consider when calculating roughness.
`shape`	The array shape of this object.

Methods

`__init__`([period_min, period_max])
`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:

period_min (int | float | complex | ndarray | Quantity | AbstractScalar)
period_max (int | float | complex | ndarray | Quantity | AbstractScalar)

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

period_max: int | float | complex | ndarray | Quantity | AbstractScalar = <Quantity 0. mm>#: The maximum period to consider when calculating roughness.

period_min: int | float | complex | ndarray | Quantity | AbstractScalar = <Quantity 0. mm>#: The minimum period to consider when calculating roughness.

property shape: dict[str, int]#: The array shape of this object.