ZOSAPI.Analysis.Settings.Spot.IAS_Spot Interface Reference
Last update: 17.07.2025
Inheritance diagram for ZOSAPI.Analysis.Settings.Spot.IAS_Spot:
Properties | |
| IAS_Field | Field [get] |
| IAS_Surface | Surface [get] |
| IAS_Wavelength | Wavelength [get] |
| Patterns | Pattern [get, set] |
| Reference | ReferTo [get, set] |
| ShowScales | ShowScale [get, set] |
| ColorRaysBy | ColorRaysBy [get, set] |
| int | RayDensity [get, set] |
| int | Configuration [get, set] |
| bool | DirectionCosines [get, set] |
| bool | UseSymbols [get, set] |
| bool | UsePolarization [get, set] |
| bool | ScatterRays [get, set] |
| bool | ShowAiryDisk [get, set] |
| bool | IgnoreLateralColor [get, set] |
| double | PlotScale [get, set] |
| double | DeltaFocus [get, set] |
| double | Exaggerate [get, set] |
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
Usage (see Example 11 for a full sample)
C#
// Open Spot Diagram to See Result!
IA_ newSpot = TheSystem.Analyses.New_StandardSpot();
Console.WriteLine("Spot has analysis specific settings? " + newSpot.HasAnalysisSpecificSettings.ToString()); // True; no ModifySettings
spotSet.RayDensity = 15;
newSpot.ApplyAndWaitForCompletion();
Base interface for all analysis windows. This interface can be accessed via the I_Analyses interface.
Definition: IA_Base.cs:29
bool HasAnalysisSpecificSettings
Gets a value indicating whether this instance has a fully-implemented settings interface available....
Definition: IA_Base.cs:55
IMessage ApplyAndWaitForCompletion()
Re-runs the analysis with the current settings and waits for it to finish calculating.
Definition: IAS_Spot.cs:50
C++
// Open Spot Diagram to See Result!
IA_Ptr newSpot = TheSystem->Analyses->New_StandardSpot();
cout << "Spot has analysis specific settings? " << newSpot->HasAnalysisSpecificSettings << endl; // True; no ModifySettings
IAS_SpotPtr spotSet = newSpot->GetSettings();
spotSet->RayDensity = 15;
newSpot->ApplyAndWaitForCompletion();
Matlab
% Open Spot Diagram to See Result!
newSpot = TheSystem.Analyses.New_StandardSpot();
fprintf('Spot has analysis specific settings? %i\n', newSpot.HasAnalysisSpecificSettings); % True; no ModifySettings
%Console.WriteLine("Spot has analysis specific settings? " + newSpot.HasAnalysisSpecificSettings.ToString()); //
spotSet = newSpot.GetSettings();
spotSet.RayDensity = 15;
newSpot.ApplyAndWaitForCompletion();
Python
# Open Spot Diagram to See Result!
newSpot = TheSystem.Analyses.New_StandardSpot()
print("Spot has analysis specific settings? ", newSpot.HasAnalysisSpecificSettings) # True; no ModifySettings
newSettings = newSpot.GetSettings()
newSettings.RayDensity = 15
newSpot.ApplyAndWaitForCompletion()
Property Documentation
◆ ColorRaysBy
|
getset |
◆ Configuration
|
getset |
◆ DeltaFocus
|
getset |
◆ DirectionCosines
|
getset |
◆ Exaggerate
|
getset |
◆ Field
|
get |
◆ IgnoreLateralColor
|
getset |
◆ Pattern
|
getset |
◆ PlotScale
|
getset |
◆ RayDensity
|
getset |
◆ ReferTo
|
getset |
◆ ScatterRays
|
getset |
◆ ShowAiryDisk
|
getset |
◆ ShowScale
|
getset |
◆ Surface
|
get |
◆ UsePolarization
|
getset |
◆ UseSymbols
|
getset |
◆ Wavelength
|
get |
