Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::SystemData::ISDRayAimingData

Last update: 13.03.2026

Definition:

System Explorer - Ray Aiming Data. This interface can be accessed via the ISystemData interface.

Members

Properties

Property RayAiming

Definition:

RayAimingMethod ZOSAPI.SystemData.ISDRayAimingData.RayAiming

Return type: RayAimingMethod

Property Method

Definition:

RayAimingType ZOSAPI.SystemData.ISDRayAimingData.Method

Return type: RayAimingType

Property UseRayAimingCache

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.UseRayAimingCache

Return type: bool

Property UseRobustRayAiming

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.UseRobustRayAiming

Return type: bool

Property ScalePupilShiftFactorsByField

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.ScalePupilShiftFactorsByField

Return type: bool

Property AutomaticallyCalculatePupilShiftsIsChecked

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.AutomaticallyCalculatePupilShiftsIsChecked

Return type: bool

Property UseEnhancedRayAiming

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.UseEnhancedRayAiming

Return type: bool

Property UseAdvancedConvergence

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.UseAdvancedConvergence

Return type: bool

Property UseFallBackSearchDuringCacheSetup

Definition:

bool ZOSAPI.SystemData.ISDRayAimingData.UseFallBackSearchDuringCacheSetup

Return type: bool

Property PupilShiftX

Definition:

double ZOSAPI.SystemData.ISDRayAimingData.PupilShiftX

Return type: double

Property PupilShiftY

Definition:

double ZOSAPI.SystemData.ISDRayAimingData.PupilShiftY

Return type: double

Property PupilShiftZ

Definition:

double ZOSAPI.SystemData.ISDRayAimingData.PupilShiftZ

Return type: double

Property PupilCompressX

Definition:

double ZOSAPI.SystemData.ISDRayAimingData.PupilCompressX

Return type: double

Property PupilCompressY

Definition:

double ZOSAPI.SystemData.ISDRayAimingData.PupilCompressY

Return type: double

Property NumStepsCacheSetup

Definition:

int ZOSAPI.SystemData.ISDRayAimingData.NumStepsCacheSetup

Return type: int

Connect with Ansys