ZOSAPI.Wizards.ISEQOptimizationWizard Interface Reference
Last update: 17.07.2025Interface for the Merit Function, Sequential Optimization Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface. Note that this wizard is obsolete and you should use ISEQOptimizationWizard2 instead. More...
Inheritance diagram for ZOSAPI.Wizards.ISEQOptimizationWizard:
Public Member Functions | |
| string | GetTypeAt (int idx) |
| string | GetDataTypeAt (int idx) |
| string | GetReferenceAt (int idx) |
| string | GetPupilIntegrationMethodAt (int idx) |
| string | GetRingAt (int idx) |
| string | GetArmAt (int idx) |
| string | GetGridAt (int idx) |
| string | GetConfigurationAt (int idx) |
 Public Member Functions inherited from ZOSAPI.Wizards.IWizard | |
| void | OK () |
| Settings are set, perform the wizardry. | |
| void | Apply () |
| Settings are set, perform the wizardry. | |
| void | SaveSettings () |
| Save the Settings. | |
| void | LoadSettings () |
| Load the Settings. | |
| void | ResetSettings () |
| Reset the settings. | |
| void | Initialize () |
Properties | |
| IWizard | CommonSettings [get] |
| bool | IsSEQOptimizationWizard [get] |
| bool | IsDeleteVignetteUsed [get, set] |
| bool | IsGlassUsed [get, set] |
| bool | IsAirUsed [get, set] |
| bool | IsAssumeAxialSymmetryUsed [get, set] |
| bool | IsIgnoreLateralColorUsed [get, set] |
| bool | IsAddFavoriteOperandsUsed [get, set] |
| bool | IsRelativeXWeightUsed [get, set] |
| int | Type [get, set] |
| int | Data [get, set] |
| int | Reference [get, set] |
| int | PupilIntegrationMethod [get, set] |
| int | Ring [get, set] |
| int | Arm [get, set] |
| int | Grid [get, set] |
| int | Configuration [get, set] |
| int | StartAt [get, set] |
| double | Obscuration [get, set] |
| double | GlassMin [get, set] |
| double | GlassMax [get, set] |
| double | GlassEdge [get, set] |
| double | AirMin [get, set] |
| double | AirMax [get, set] |
| double | AirEdge [get, set] |
| double | RelativeXWeight [get, set] |
| double | OverallWeight [get, set] |
| int | NumberOfTypes [get] |
| int | NumberOfDataTypes [get] |
| int | NumberOfReferences [get] |
| int | NumberOfPupilIntegrationMethods [get] |
| int | NumberOfRings [get] |
| int | NumberOfArms [get] |
| int | NumberOfGrids [get] |
| int | NumberOfConfigurations [get] |
| Properties inherited from ZOSAPI.Wizards.IWizard | |
| WizardType | Wizard [get] |
| Gets the type of this wizard instance. | |
Detailed Description
Interface for the Merit Function, Sequential Optimization Wizard These settings can be retrieved from the ZOSAPI.Editors.MFE.IMeritFunctionEditor interface. Note that this wizard is obsolete and you should use ISEQOptimizationWizard2 instead.
Usage (see Example 15 for a full sample)
C#
//define merit function
//load merit function
IMeritFunctionEditor TheMFE = TheSystem.MFE;
ISEQOptimizationWizard OptWizard = TheMFE.SEQOptimizationWizard;
//Optimize for smallest RMS Spot, which is "Data" = 1
OptWizard.Data = 1;
OptWizard.OverallWeight = 1;
//Gaussian Quadrature with 3 rings (refers to index number = 2)
OptWizard.Ring = 2;
//Set air & glass boundaries
OptWizard.IsGlassUsed = true;
OptWizard.GlassMin = 3.0;
OptWizard.GlassMax = 15.0;
OptWizard.GlassEdge = 3.0;
OptWizard.IsAirUsed = true;
OptWizard.AirMin = 0.5;
OptWizard.AirMax = 1000.0;
OptWizard.AirEdge = 0.5;
//And click OK!
OptWizard.Apply();
string mf_filename = System.IO.Path.Combine(TheApplication.SamplesDir, @"API\CS\e15_Seq_Optimization\RMS_Spot_Radius.mf");
TheMFE.SaveMeritFunction(mf_filename);
TheMFE.LoadMeritFunction(mf_filename);
SampleFile = System.IO.Path.Combine(TheApplication.SamplesDir, @"API\CS\e15_Seq_Optimization\OptimizedFile4.zos");
Interface for the Merit Function, Sequential Optimization Wizard These settings can be retrieved from...
Definition: InterfacesWizards.cs:293
C++
// define merit function
// load merit function
IMeritFunctionEditorPtr TheMFE = TheSystem->MFE;
// need to ensure that you have the Platform set as x64 and not Win32
ISEQOptimizationWizardPtr OptWizard = TheMFE->SEQOptimizationWizard;
// Optimize for smallest RMS Spot, which is "Data" = 1
OptWizard->Data = 1;
OptWizard->OverallWeight = 1;
// Gaussian Quadrature with 3 rings(refers to index number = 2)
OptWizard->Ring = 2;
// Set air & glass boundaries
OptWizard->IsGlassUsed = true;
OptWizard->GlassMin = 3.0;
OptWizard->GlassMax = 15.0;
OptWizard->GlassEdge = 3.0;
OptWizard->IsAirUsed = true;
OptWizard->AirMin = 0.5;
OptWizard->AirMax = 1000.0;
OptWizard->AirEdge = 0.5;
// And click OK!
IWizardPtr baseToolWiz = OptWizard;
baseToolWiz->Apply();
_bstr_t mf_filename = _bstr_t(TheApplication->SamplesDir + "\\API\\CPP\\e15_Seq_Optimization\\RMS_Spot_Radius.mf");
TheMFE->SaveMeritFunction(mf_filename);
TheMFE->LoadMeritFunction(mf_filename);
SampleFile = _bstr_t(TheApplication->SamplesDir + "\\API\\CPP\\e15_Seq_Optimization\\OptimizedFile4.zos");
TheSystem->SaveAs(SampleFile);
Matlab
%define merit function
%load merit function
TheMFE = TheSystem.MFE;
OptWizard = TheMFE.SEQOptimizationWizard;
OptWizard.Data = 1;
OptWizard.OverallWeight = 1;
%Gaussian Quadrature with 3 rings (refers to index number = 2)
OptWizard.Ring = 2;
%Set air & glass boundaries
OptWizard.IsGlassUsed = true;
OptWizard.GlassMin = 3.0;
OptWizard.GlassMax = 15.0;
OptWizard.GlassEdge = 3.0;
OptWizard.IsAirUsed = true;
OptWizard.AirMin = 0.5;
OptWizard.AirMax = 1000.0;
OptWizard.AirEdge = 0.5;
%And click OK!
OptWizard.Apply();
mf_filename = System.String.Concat(TheApplication.SamplesDir, '\API\Matlab\e15_Seq_Optimization\RMS_Spot_Radius.mf');
TheMFE.SaveMeritFunction(mf_filename);
TheMFE.LoadMeritFunction(mf_filename);
SampleFile = System.String.Concat(TheApplication.SamplesDir, '\API\Matlab\e15_Seq_Optimization\OptimizedFile4.zos');
Python
# define merit function
# load merit function
# you need to have 64-bit pywin32 to use the SEQOptimizationWizard with an error
TheMFE = TheSystem.MFE
OptWizard = TheMFE.SEQOptimizationWizard
# Optimize for smallest RMS Spot, which is "Data" = 1
OptWizard.Data = 1
OptWizard.OverallWeight = 1
# Gaussian Quadrature with 3 rings (refers to index number = 2)
OptWizard.Ring = 2
# Set air & glass boundaries
OptWizard.IsGlassUsed = True
OptWizard.GlassMin = 3.0
OptWizard.GlassMax = 15.0
OptWizard.GlassEdge = 3.0
OptWizard.IsAirUsed = True
OptWizard.AirMin = 0.5
OptWizard.AirMax = 1000.0
OptWizard.AirEdge = 0.5
# And click OK!
OptWizard.Apply()
mf_filename = TheApplication.SamplesDir + '\\API\\Python\\e15_Seq_Optimization\\RMS_Spot_Radius.mf'
TheMFE.SaveMeritFunction(mf_filename)
TheMFE.LoadMeritFunction(mf_filename)
SampleFile = TheApplication.SamplesDir + '\\API\\Python\\e15_Seq_Optimization\\OptimizedFile4.zos'
TheSystem.SaveAs(SampleFile)
Member Function Documentation
◆ GetArmAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetArmAt | ( | int | idx | ) |
◆ GetConfigurationAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetConfigurationAt | ( | int | idx | ) |
◆ GetDataTypeAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetDataTypeAt | ( | int | idx | ) |
◆ GetGridAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetGridAt | ( | int | idx | ) |
◆ GetPupilIntegrationMethodAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetPupilIntegrationMethodAt | ( | int | idx | ) |
◆ GetReferenceAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetReferenceAt | ( | int | idx | ) |
◆ GetRingAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetRingAt | ( | int | idx | ) |
◆ GetTypeAt()
| string ZOSAPI.Wizards.ISEQOptimizationWizard.GetTypeAt | ( | int | idx | ) |
Property Documentation
◆ AirEdge
|
getset |
◆ AirMax
|
getset |
◆ AirMin
|
getset |
◆ Arm
|
getset |
◆ CommonSettings
|
get |
◆ Configuration
|
getset |
◆ Data
|
getset |
◆ GlassEdge
|
getset |
◆ GlassMax
|
getset |
◆ GlassMin
|
getset |
◆ Grid
|
getset |
◆ IsAddFavoriteOperandsUsed
|
getset |
◆ IsAirUsed
|
getset |
◆ IsAssumeAxialSymmetryUsed
|
getset |
◆ IsDeleteVignetteUsed
|
getset |
◆ IsGlassUsed
|
getset |
◆ IsIgnoreLateralColorUsed
|
getset |
◆ IsRelativeXWeightUsed
|
getset |
◆ IsSEQOptimizationWizard
|
get |
◆ NumberOfArms
|
get |
◆ NumberOfConfigurations
|
get |
◆ NumberOfDataTypes
|
get |
◆ NumberOfGrids
|
get |
◆ NumberOfPupilIntegrationMethods
|
get |
◆ NumberOfReferences
|
get |
◆ NumberOfRings
|
get |
◆ NumberOfTypes
|
get |
◆ Obscuration
|
getset |
◆ OverallWeight
|
getset |
◆ PupilIntegrationMethod
|
getset |
◆ Reference
|
getset |
◆ RelativeXWeight
|
getset |
◆ Ring
|
getset |
◆ StartAt
|
getset |
◆ Type
|
getset |
