zospy.analyses.reports.cardinal_points.CardinalPointsSettings

zospy.analyses.reports.cardinal_points.CardinalPointsSettings#

class zospy.analyses.reports.cardinal_points.CardinalPointsSettings#

Bases: object

Settings for the Cardinal Points analysis.

Attributes:
surface_1int

The surface number corresponding to the first surface of the analyzed system. Defaults to 1.

surface_2int

The surface number corresponding to the last surface of the analyzed system, or “Image”. Defaults to “Image”.

wavelengthint

The wavelength number. Defaults to 1.

orientationLiteral[“Y-Z”, “X-Z”]

The orientation along which the cardinal points are calculated. Must be one of “X-Z”, “Y-Z”. Defaults to “Y-Z”.

Methods

validate_surfaces()

Validate that surface_1 is less than surface_2.

__init__(*args: Any, **kwargs: Any) None#
validate_surfaces()#

Validate that surface_1 is less than surface_2.