optimization.variable.conic#

Conic Constant Variable Module

This module contains the class for a conic constant variable in an optic system. The ConicVariable class is a subclass of the VariableBehavior class that represents a variable for the conic constant of a surface in an optic system. It is used in the optimization process for conic surfaces.

Kramer Harrison, 2024

Classes

ConicVariable(optic, surface_number[, scaler])

Represents a variable for the conic constant of a surface in an optic.
class ConicVariable(optic, surface_number, scaler=None, **kwargs)[source]#

Represents a variable for the conic constant of a surface in an optic.

Parameters:

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

  • surface_number (int) – The index of the surface in the optic.

  • scaler (Scaler) – The scaler to use for the variable. Defaults to IdentityScaler().

  • **kwargs – Additional keyword arguments.

Variables:

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

  • surface_number (int) – The index of the surface in the optic.

Methods:

  • get_value – Returns the current conic constant of the surface.

  • update_value – Updates the conic value of the surface.

get_value()[source]#

Returns the current conic constant of the surface.

Returns:

The conic constant of the surface.

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 conic value of the surface.

Parameters:

new_value (float) – The new conic constant to set.