ZOS-API interface 2024 R2 SP02

ZOSAPI.Tools.IExportToSpeosLensSystem Interface Reference

Last update: 17.07.2025

Interface to access the "Export to Speos Lens System" tool. This interface can be accessed via the IOpticalSystemTools interface. More...

Inheritance diagram for ZOSAPI.Tools.IExportToSpeosLensSystem:
Inheritance graph
[legend]

Properties

double SensorWidth [get, set]
 Controls the sensor width in Lens Units.
 
double SensorHeight [get, set]
 Controls the sensor height in Lens Units.
 
bool SkipSystemReversal [get, set]
 If true, the tool will not attempt to reverse the system.
 
int SamplePoints [get, set]
 Controls the number of points used to sample the sensor.
 
int XSampling [get, set]
 Controls the number of points used to sample the sensor along X.
 
int YSampling [get, set]
 Controls the number of points used to sample the sensor along Y.
 
SampleSizes SampleSize [get, set]
 Controls the number of rays used to sample the pupil.
 
int Configuration [get, set]
 Controls which configuration is used by the tool. 0 identifies the current configuration.
 
int FileFormatVersion [get]
 Controls which version of the file format is used for output. Valid values are
  • 2: Uses v2 of the OPTDistortion file format
  • 3: Uses v3 of the OPTDistortion file format

Note that v2 is only allowed for axially symmetric systems.

 
bool AssumeRadialSymmetry [get, set]
 Controls if the sensor is sampled radially for radially symmetric systems.
 
string OPTDistortionFilename [get, set]
 Controls the name of the output file, including the full path.
 
- Properties inherited from ZOSAPI.Tools.ISystemTool
int Progress [get]
 Gets the progress of the current tool, if supported.
 
string Status [get]
 Gets the status of the current tool, if supporoted.
 
bool IsRunning [get]
 Gets a value indicating whether the tool is currently running asynchronously.
 
bool CanCancel [get]
 Gets a value indicating whether the tool can be cancelled.
 
bool IsAsynchronous [get]
 Gets a value indicating whether the tool runs asynchronously (i.e. on a thread).
 
bool IsFiniteDuration [get]
 Gets a value indicating whether this tool will complete on its own.
 
bool IsValid [get]
 Gets a value indicating whether the input settings are valid.
 
bool Succeeded [get]
 Gets a value indicating whether the tool execution succeeded.
 
string ErrorMessage [get]
 If Succeeded is false, get the error messages; otherwise, null.
 

Additional Inherited Members

- Public Member Functions inherited from ZOSAPI.Tools.ISystemTool
bool Run ()
 Start the tool. Note that for synchronous tools (see IsAsynchronous), this call will block until completion. If it is asynchronous it will start running but return immediately.
 
bool RunAndWaitForCompletion ()
 Sames as calling Run followed by WaitForCompletion.
 
bool WaitForCompletion ()
 Waits for the asynchronous tool to complete.
 
bool Cancel ()
 Cancels the currently running asynchronous tool.
 
bool Close ()
 Closes this tool and frees up and associated resources.
 
RunStatus WaitWithTimeout (double timeOutSeconds)
 Waits for the currently running tool to complete, with a specified time out value. Note that if the timeout is exceeded this method will return, however the tool will continue to run. Also note that this method will not start the tool running if it is not already.
 
RunStatus RunAndWaitWithTimeout (double timeOutSeconds)
 Starts the tool running, and waits for it to complete with the specified timeout value. Note that if the timeout is exceeded this method will return, however the tool will continue to run.
 

Detailed Description

Interface to access the "Export to Speos Lens System" tool. This interface can be accessed via the IOpticalSystemTools interface.

Property Documentation

◆ AssumeRadialSymmetry

bool ZOSAPI.Tools.IExportToSpeosLensSystem.AssumeRadialSymmetry
getset

Controls if the sensor is sampled radially for radially symmetric systems.

◆ Configuration

int ZOSAPI.Tools.IExportToSpeosLensSystem.Configuration
getset

Controls which configuration is used by the tool. 0 identifies the current configuration.

◆ FileFormatVersion

int ZOSAPI.Tools.IExportToSpeosLensSystem.FileFormatVersion
get

Controls which version of the file format is used for output. Valid values are

  • 2: Uses v2 of the OPTDistortion file format
  • 3: Uses v3 of the OPTDistortion file format

Note that v2 is only allowed for axially symmetric systems.

◆ OPTDistortionFilename

string ZOSAPI.Tools.IExportToSpeosLensSystem.OPTDistortionFilename
getset

Controls the name of the output file, including the full path.

◆ SamplePoints

int ZOSAPI.Tools.IExportToSpeosLensSystem.SamplePoints
getset

Controls the number of points used to sample the sensor.

◆ SampleSize

SampleSizes ZOSAPI.Tools.IExportToSpeosLensSystem.SampleSize
getset

Controls the number of rays used to sample the pupil.

◆ SensorHeight

double ZOSAPI.Tools.IExportToSpeosLensSystem.SensorHeight
getset

Controls the sensor height in Lens Units.

◆ SensorWidth

double ZOSAPI.Tools.IExportToSpeosLensSystem.SensorWidth
getset

Controls the sensor width in Lens Units.

◆ SkipSystemReversal

bool ZOSAPI.Tools.IExportToSpeosLensSystem.SkipSystemReversal
getset

If true, the tool will not attempt to reverse the system.

◆ XSampling

int ZOSAPI.Tools.IExportToSpeosLensSystem.XSampling
getset

Controls the number of points used to sample the sensor along X.

◆ YSampling

int ZOSAPI.Tools.IExportToSpeosLensSystem.YSampling
getset

Controls the number of points used to sample the sensor along Y.

Connect with Ansys