ToroidalSag#

class optika.sags.ToroidalSag(radius=<Quantity inf mm>, radius_of_rotation=<Quantity 0. mm>, *, transformation=None, parameters_slope_error=None, parameters_roughness=None, parameters_microroughness=None)[source]#

Bases: AbstractSag

A toroidal sag profile.

Attributes

`parameters_microroughness`	The microroughness parameters for this sag profile.
`parameters_roughness`	The roughness parameters for this sag profile.
`parameters_slope_error`	The slope error parameters for this sag profile.
`radius`	The minor radius of this toroidal surface.
`radius_of_rotation`	The major radius of this toroidal surface.
`shape`	The array shape of this object.
`transformation`	The transformation between the surface coordinate system and the sag coordinate system.

Methods

`__init__`([radius, radius_of_rotation, ...])
`intercept`(rays)	A set of new rays with the same direction as the input rays, but with the `optika.rays.RayVectorArray.position` updated to their interception point with this sag function.
`normal`(position)	The vector perpendicular to the surface at the given position.
`propagate_rays`(rays)	For the given input rays, calculate new rays based off of their interation with this object.
`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:

radius (Quantity | AbstractScalar)
radius_of_rotation (Quantity | AbstractScalar)
transformation (None | AbstractTransformation)
parameters_slope_error (None | SlopeErrorParameters)
parameters_roughness (None | RoughnessParameters)
parameters_microroughness (None | RoughnessParameters)

intercept(rays)#

A set of new rays with the same direction as the input rays, but with the optika.rays.RayVectorArray.position updated to their interception point with this sag function.

Parameters:: rays (AbstractRayVectorArray) – input rays that will intercept this sag function
Return type:: RayVectorArray

normal(position)[source]#

The vector perpendicular to the surface at the given position.

Parameters:: position (AbstractCartesian3dVectorArray) – The location on the surface to evaluate the normal vector
Return type:: AbstractCartesian3dVectorArray

propagate_rays(rays)#

For the given input rays, calculate new rays based off of their interation with this object.

Parameters:: rays (AbstractRayVectorArray) – a set of input rays that will interact with this object
Return type:: AbstractRayVectorArray

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

parameters_microroughness: None | RoughnessParameters = None#: The microroughness parameters for this sag profile.

parameters_roughness: None | RoughnessParameters = None#: The roughness parameters for this sag profile.

parameters_slope_error: None | SlopeErrorParameters = None#: The slope error parameters for this sag profile.

radius: Quantity | AbstractScalar = <Quantity inf mm>#: The minor radius of this toroidal surface.

radius_of_rotation: Quantity | AbstractScalar = <Quantity 0. mm>#: The major radius of this toroidal surface.

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

transformation: None | AbstractTransformation = None#: The transformation between the surface coordinate system and the sag coordinate system.