SlopeErrorParameters#

class optika.metrology.SlopeErrorParameters(step_size=<Quantity 0. mm>, kernel_size=<Quantity 0. mm>)[source]#

Bases: Printable, Shaped

The parameters needed to compute the slope error.

Attributes

`kernel_size`	The size of the boxcar kernel that is convolved with the wavefront error.
`shape`	The array shape of this object.
`step_size`	The horizontal distance to use when measuring the slope

Methods

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

step_size (int | float | complex | ndarray | Quantity | AbstractScalar)
kernel_size (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

kernel_size: int | float | complex | ndarray | Quantity | AbstractScalar = <Quantity 0. mm>#: The size of the boxcar kernel that is convolved with the wavefront error.

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

step_size: int | float | complex | ndarray | Quantity | AbstractScalar = <Quantity 0. mm>#: The horizontal distance to use when measuring the slope