ZOSAPI.Analysis.Settings.IAS_CriticalRayTracer Interface Reference
Last update: 17.07.2025Settings to control the Critical Ray Trace analysis. More...
Properties | |
| double | PositionTolerance [get, set] |
| Gets or sets the position tolerance. | |
| double | AngleTolerance [get, set] |
| Gets or sets the angle tolerance. | |
| String | Filename [get, set] |
| Gets or sets the filename. | |
| DisplayOption | RaysToDisplay [get, set] |
| Gets or sets the types of rays to display. | |
| bool | DisplayXYZ [get, set] |
| Gets or sets a value indicating whether to display ray positions in the text output. | |
| bool | DisplayLMN [get, set] |
| Gets or sets a value indicating whether to display ray direction cosines in the text output. | |
| bool | DisplayActualEndData [get, set] |
| Gets or sets a value indicating whether to display actual end data in the text output. | |
| bool | DisplayTargetEndData [get, set] |
| Gets or sets a value indicating whether to display target end data in the text output. | |
| bool | DisplayStartData [get, set] |
| Gets or sets a value indicating whether to display start data in the text output. | |
Additional Inherited Members | |
 Public Member Functions inherited from ZOSAPI.Analysis.Settings.IAS_ | |
| IMessages | Verify () |
| void | Save () |
| Saves the current settings to the default CFG file. | |
| void | Load () |
| Loads settings from the default CFG file. | |
| void | Reset () |
| Resets the settings back to the defaults for the current analysis. | |
| bool | SaveTo (string settingsFile) |
| Saves the current settings to the specified file. | |
| bool | LoadFrom (string settingsFile) |
| Replaces the current settings with settings read from the specified file. | |
| bool | ModifySettings (string settingsFile, string typeCode, string newValue) |
| Changes a single setting in the specified file. See the MODIFYSETTINGS DDE command help documentation for more information. | |
Detailed Description
Settings to control the Critical Ray Trace analysis.
- See also
- ZOSAPI.Analysis.Settings.IAS_
Property Documentation
◆ AngleTolerance
|
getset |
Gets or sets the angle tolerance.
The maximum angle allowed between the actual and target ray cosines (degrees).
◆ DisplayActualEndData
|
getset |
Gets or sets a value indicating whether to display actual end data in the text output.
true to include actual end data; otherwise, false.
◆ DisplayLMN
|
getset |
Gets or sets a value indicating whether to display ray direction cosines in the text output.
true to display ray cosines; otherwise, false.
◆ DisplayStartData
|
getset |
Gets or sets a value indicating whether to display start data in the text output.
true to include start data; otherwise, false.
◆ DisplayTargetEndData
|
getset |
Gets or sets a value indicating whether to display target end data in the text output.
true to include target end data; otherwise, false.
◆ DisplayXYZ
|
getset |
Gets or sets a value indicating whether to display ray positions in the text output.
true to display ray positions; otherwise, false.
◆ Filename
|
getset |
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).
◆ PositionTolerance
|
getset |
Gets or sets the position tolerance.
The maximum allowed distance between the actual and target end point (lens units).
◆ RaysToDisplay
|
getset |
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.
