visisipy.analysis.cardinal_points

Calculate the cardinal points of an eye model.

Classes

CardinalPoints	The cardinal points of a system in object and image space.
CardinalPointsResult	The cardinal points of a system.

Functions

cardinal_points(…)

Get the cardinal points of the system between surface_1 and surface_2.

Module Contents

class visisipy.analysis.cardinal_points.CardinalPoints

Bases: NamedTuple

The cardinal points of a system in object and image space.

class visisipy.analysis.cardinal_points.CardinalPointsResult

The cardinal points of a system.

Attributes:

focal_lengthsCardinalPoints

The focal lengths of the system.

focal_pointsCardinalPoints

The focal points of the system.

principal_pointsCardinalPoints

The principal points of the system.

anti_principal_pointsCardinalPoints

The anti-principal points of the system.

nodal_pointsCardinalPoints

The nodal points of the system.

anti_nodal_pointsCardinalPoints

The anti-nodal points of the system.

visisipy.analysis.cardinal_points.cardinal_points(model: visisipy.EyeModel | None = None, surface_1: int | None = None, surface_2: int | None = None, *, return_raw_result: Literal[False] = False, backend: visisipy.backend.BaseBackend = _AUTOMATIC_BACKEND) → CardinalPointsResult

visisipy.analysis.cardinal_points.cardinal_points(model: visisipy.EyeModel | None = None, surface_1: int | None = None, surface_2: int | None = None, *, return_raw_result: Literal[True] = True, backend: visisipy.backend.BaseBackend = _AUTOMATIC_BACKEND) → tuple[CardinalPointsResult, Any]

Get the cardinal points of the system between surface_1 and surface_2.

Parameters:

modelEyeModel | None

The eye model to be used in the ray trace. If None, the current eye model will be used.

surface_1int | None, optional

The first surface to be used in the analysis. If None, the first surface in the system will be used. Defaults to None.

surface_2int | None, optional

The second surface to be used in the analysis. If None, the last surface in the system will be used. Defaults to None.

return_raw_resultbool, optional

Return the raw analysis result from the backend. Defaults to False.

backendBaseBackend

The backend to be used for the analysis. If not provided, the default backend is used.

Returns:

CardinalPointsResult

The cardinal points of the system.

Any

The raw analysis result from the backend.