optimization.variable.thickness

Thickness Variable Module

This module contains the ThicknessVariable class, which represents a variable for the thickness of an optic surface. The class inherits from the VariableBehavior class.

Kramer Harrison, 2024

Classes

ThicknessVariable(optic, surface_number[, ...])

Represents a variable for the thickness of an optic surface.

class ThicknessVariable(optic, surface_number, scaler=None, **kwargs)[source]

Represents a variable for the thickness of an optic surface.

Parameters:
  • optic (Optic) – The optic object to which the surface belongs.

  • surface_number (int) – The number of the surface.

  • scaler (Scaler) – The scaler to use for the variable. Defaults to a linear scaler with factor=1/10.0 and offset=-1.0.

  • **kwargs – Additional keyword arguments.

optic

The optic object to which the surface belongs.

Type:

Optic

surface_number

The number of the surface.

Type:

int

get_value()[source]

Returns the current thickness value of the surface.

update_value(new_value)[source]

Updates the thickness value of the surface.

get_value()[source]

Returns the current thickness value of the surface.

Returns:

The current thickness value.

Return type:

float

inverse_scale(scaled_value)

Inverse scale the value of the variable.

Parameters:

scaled_value – The scaled value to inverse scale

scale(value)

Scale the value of the variable for improved optimization performance.

Parameters:

value – The value to scale

update_value(new_value)[source]

Updates the thickness value of the surface.

Parameters:

new_value (float) – The new thickness value.