ZOSAPI.Tools.General Namespace Reference
Last update: 17.07.2025Classes | |
| interface | IComputeRMSSpotSize |
| interface | ICovarianceData |
| interface | ICreateArchive |
| Interfaces and methods for creating a ZAR file. This interface can be accessed via the IOpticalSystemTools interface. More... | |
| interface | ICreateProject |
| interface | IDataDictionary |
| interface | IDataEntry |
| interface | IExportCAD |
| Interfaces and methods for exporting the current system to various CAD formats. This interface can be accessed via the IOpticalSystemTools interface. More... | |
| interface | IHullTools |
| interface | ILensCatalogLens |
| interface | ILensCatalogs |
| Interfaces and methods for searching the available Lens Catalogs. This interface can be accessed via the IOpticalSystemTools interface. More... | |
| interface | IPoint3D |
| interface | IPointList3D |
| interface | IPointTools |
| interface | IQuickAdjust |
| Interfaces and methods for running the Quick Adjust tool. This interface can be accessed via the IOpticalSystemTools interface. More... | |
| interface | IQuickFocus |
| Interfaces and methods for running the Quick Focus tool. This interface can be accessed via the IOpticalSystemTools interface. More... | |
| interface | IRayAimingWizard |
| interface | IRestoreArchive |
| Interfaces and methods for restoring a ZAR file. This interface can be accessed via the IOpticalSystemTools interface. More... | |
| interface | IRestoreProject |
| interface | IScale |
| Interfaces and methods for Scaling the Currently active Lens System. This interface can be accessed via the IOpticalSystemTools interface. More... | |
Enumeration Type Documentation
◆ ACISExportVersion
◆ ArchiveFileStatus
◆ CADAngularToleranceType
◆ CADFileType
◆ CADToleranceType
◆ DataTypes
| enum ZOSAPI.Tools.General.DataTypes : short |
◆ EntryCompressionModes
◆ LensShape
◆ LensType
◆ QuickAdjustCriterion
◆ QuickAdjustType
◆ QuickFocusCriterion
Usage (see Example 15 for a full sample)
C#
//change BFL & run quick focus
Surface_Last.Thickness = 40.0;
IQuickFocus QFocus = tools.OpenQuickFocus();
QFocus.Criterion = QuickFocusCriterion.SpotSizeRadial;
QFocus.UseCentroid = true;
QFocus.RunAndWaitForCompletion();
QFocus.Close();
SampleFile = System.IO.Path.Combine(TheApplication.SamplesDir, @"API\CS\e15_Seq_Optimization\OptimizedFile2.zos");
TheSystem.SaveAs(SampleFile);
Interfaces and methods for running the Quick Focus tool. This interface can be accessed via the IOpti...
Definition: Tools.cs:793
bool RunAndWaitForCompletion()
Sames as calling Run followed by WaitForCompletion.
C++
// change BFL & run quick focus
Surface_Last->Thickness = 40.0;
IQuickFocusPtr QFocus = tools->OpenQuickFocus();
QFocus->Criterion = QuickFocusCriterion::QuickFocusCriterion_SpotSizeRadial;
QFocus->UseCentroid = true;
ISystemToolPtr baseTool = QFocus;
baseTool->RunAndWaitForCompletion();
baseTool->Close();
SampleFile = _bstr_t(TheApplication->SamplesDir) + "\\API\\CPP\\e15_Seq_Optimization\\OptimizedFile2.zos";
TheSystem->SaveAs(SampleFile);
Matlab
%change BFL & run quick focus
Surface_Last.Thickness = 40.0;
QFocus = tools.OpenQuickFocus();
QFocus.UseCentroid = true;
QFocus.RunAndWaitForCompletion();
QFocus.Close();
SampleFile = System.String.Concat(TheApplication.SamplesDir, '\API\Matlab\e15_Seq_Optimization\OptimizedFile2.zos');
TheSystem.SaveAs(SampleFile);
Definition: Tools.cs:697
Definition: FileSource.cs:4
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5
Python
# change BFL & run quick focus
Surface_Last.Thickness = 40.0
QFocus = tools.OpenQuickFocus()
QFocus.Criterion = ZOSAPI.Tools.General.QuickAdjustCriterion.SpotSizeRadial
QFocus.UseCentroid = True
QFocus.RunAndWaitForCompletion()
QFocus.Close()
SampleFile = TheApplication.SamplesDir + '\\API\\Python\\e15_Seq_Optimization\\OptimizedFile2.zos'
TheSystem.SaveAs(SampleFile)
| Enumerator | |
|---|---|
| SpotSizeRadial | |
| SpotSizeXOnly | |
| SpotSizeYOnly | |
| RMSWavefront | |
