Interface ZOSAPI::Analysis::Settings::IAS_CriticalRayTracer
Last update: 13.03.2026
Definition:
Settings to control the Critical Ray Trace analysis.
See also: ZOSAPI.Analysis.Settings.IAS_
Inherits from:
Members
- AngleTolerance
- DisplayActualEndData
- DisplayLMN
- DisplayStartData
- DisplayTargetEndData
- DisplayXYZ
- Filename
- Load
- LoadFrom
- ModifySettings
- PositionTolerance
- RaysToDisplay
- Reset
- Save
- SaveTo
- Verify
Properties
Property PositionTolerance
Definition:
double ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.PositionTolerance
Gets or sets the position tolerance.
The maximum allowed distance between the actual and target end point (lens units).
Return type: double
Property AngleTolerance
Definition:
double ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.AngleTolerance
Gets or sets the angle tolerance.
The maximum angle allowed between the actual and target ray cosines (degrees).
Return type: double
Property Filename
Definition:
String ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.Filename
Gets or sets the filename.
The input ray file (including path); this is generally produced using the Critical Rayset Generator tool (see ZOSAPI.Tools.ICriticalRaysetGenerator).
Return type: String
Property RaysToDisplay
Definition:
DisplayOption ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.RaysToDisplay
Gets or sets the types of rays to display.
The types of rays to display. Note that this only affects the text output; the results available in the API will always include all rays.
Return type: DisplayOption
Property DisplayXYZ
Definition:
bool ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.DisplayXYZ
Gets or sets a value indicating whether to display ray positions in the text output.
true to display ray positions; otherwise, false.
Return type: bool
Property DisplayLMN
Definition:
bool ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.DisplayLMN
Gets or sets a value indicating whether to display ray direction cosines in the text output.
true to display ray cosines; otherwise, false.
Return type: bool
Property DisplayActualEndData
Definition:
bool ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.DisplayActualEndData
Gets or sets a value indicating whether to display actual end data in the text output.
true to include actual end data; otherwise, false.
Return type: bool
Property DisplayTargetEndData
Definition:
bool ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.DisplayTargetEndData
Gets or sets a value indicating whether to display target end data in the text output.
true to include target end data; otherwise, false.
Return type: bool
Property DisplayStartData
Definition:
bool ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer.DisplayStartData
Gets or sets a value indicating whether to display start data in the text output.
true to include start data; otherwise, false.
Return type: bool
