Methods and interfaces for opening, closing, and retrieving analyses. This interface can be accessed via the IOpticalSystem interface. More...

Public Member Functions
bool	CloseAnalysis (int index)
	Closes the specified analysis.

bool	CloseAnalysis (IA_ analysis)
	Closes the specified analysis.

IA_	Get_AnalysisAtIndex (int index)
	Retrieve the specified analysis.

IA_	New_Analysis (AnalysisIDM AnalysisType)
	Create a new analysis of the specified type.

IA_	New_Analysis_SettingsFirst (AnalysisIDM AnalysisType)
	Create a new analysis of the specified type, but does not run the analysis and wait for it to finish.

IA_	New_XXXTemplateXXX ()

IA_	New_RayFan ()
	Open a new Ray Fan window.

IA_	New_OpticalPathFan ()
	Open a new OPD Fan window.

IA_	New_PupilAberrationFan ()
	Open a new Pupil Aberration Fan window.

IA_	New_FieldCurvatureAndDistortion ()
	Open a new Field Curv/Dist window.

IA_	New_FocalShiftDiagram ()
	Open a new Focal Shift window.

IA_	New_GridDistortion ()
	Open a new Grid Distortion window.

IA_	New_LateralColor ()
	Open a new Lateral Color window.

IA_	New_LongitudinalAberration ()
	Open a new Longitudinal Aberration window.

IA_	New_RayTrace ()
	Open a new Single Ray Trace window.

IA_	New_SeidelCoefficients ()
	Open a new Seidel Coefficients window.

IA_	New_SeidelDiagram ()
	Open a new Seidel Diagram window.

IA_	New_ZernikeAnnularCoefficients ()
	Open a new Zernike Annular Coefficients window.

IA_	New_ZernikeCoefficientsVsField ()
	Open a new Zernike Coefficients vs. Field window.

IA_	New_ZernikeFringeCoefficients ()
	Open a new Zernike Fringe Coefficients window.

IA_	New_ZernikeStandardCoefficients ()
	Open a new Zernike Standard Coefficients window.

IA_	New_FullFieldAberration ()
	Open a new Full-Field Aberration window.

IA_	New_ContrastLossMap ()
	Open a new Contrast Loss Map window.

IA_	New_FftMtf ()
	Open a new FFT MTF window.

IA_	New_FftThroughFocusMtf ()
	Open a new FFT Through Focus MTF window.

IA_	New_GeometricThroughFocusMtf ()
	Open a new Through Focus Geometric MTF window.

IA_	New_GeometricMtf ()
	Open a new Geometric MTF window.

IA_	New_NSCGeometricMtf ()
	Open a new Non-Sequential Geometric MTF window.

IA_	New_FftMtfMap ()
	Open a new FFT MTF Map window.

IA_	New_GeometricMtfMap ()
	Open a new Geometric MTF Map window.

IA_	New_FftSurfaceMtf ()
	Open a new FFT Surface MTF window.

IA_	New_FftMtfvsField ()
	Open a new FFT MTF vs. Field window.

IA_	New_GeometricMtfvsField ()
	Open a new Geometric MTF vs. Field window.

IA_	New_HuygensMtfvsField ()
	Open a new Huygens MTF vs. Field window.

IA_	New_HuygensMtf ()
	Open a new Huygens MTF window.

IA_	New_HuygensSurfaceMtf ()
	Open a new Huygens Surface MTF window.

IA_	New_HuygensThroughFocusMtf ()
	Open a new Huygens Through Focus MTF window.

IA_	New_FftPsf ()
	Open a new FFT PSF window.

IA_	New_FftPsfCrossSection ()
	Open a new FFT PSF Cross Section window.

IA_	New_FftPsfLineEdgeSpread ()
	Open a new FFT Line/Edge Spread window.

IA_	New_HuygensPsfCrossSection ()
	Open a new Huygens PSF Cross Section window.

IA_	New_HuygensPsf ()
	Open a new Huygens PSF window.

IA_	New_DiffractionEncircledEnergy ()
	Open a new Diffraction Encircled Energy window.

IA_	New_GeometricEncircledEnergy ()
	Open a new Geometric Encircled Energy window.

IA_	New_GeometricLineEdgeSpread ()
	Open a new Line/Edge Spread window.

IA_	New_ExtendedSourceEncircledEnergy ()
	Open a new Extended Source Encircled Energy window.

IA_	New_SurfaceCurvatureCross ()
	Open a new Surface Curvature Cross Section window.

IA_	New_SurfacePhaseCross ()
	Open a new Surface Phase Cross Section window.

IA_	New_SurfaceSagCross ()
	Open a new Surface Sag Cross Section window.

IA_	New_SurfaceCurvature ()
	Open a new Surface Curvature window.

IA_	New_SurfacePhase ()
	Open a new Surface Phase window.

IA_	New_SurfaceSag ()
	Open a new Surface Sag window.

IA_	New_NSCSurfaceSag ()

IA_	New_StandardSpot ()
	Open a new Spot Diagram window.

IA_	New_ThroughFocusSpot ()
	Open a new Through Focus Spot Diagram window.

IA_	New_FullFieldSpot ()
	Open a new Full Field Spot Diagram window.

IA_	New_MatrixSpot ()
	Open a new Matrix Spot Diagram window.

IA_	New_ConfigurationMatrixSpot ()
	Open a new Configuration Matrix Spot Diagram window.

IA_	New_RMSField ()
	Open a new RMS vs. Field window.

IA_	New_RMSFieldMap ()
	Open a new RMS Field Map window.

IA_	New_RMSLambdaDiagram ()
	Open a new RMS vs. Wavelength window.

IA_	New_RMSFocus ()
	Open a new RMS vs. Focus window.

IA_	New_Foucault ()
	Open a new Foucault Analysis window.

IA_	New_Interferogram ()
	Open a new Interferogram window.

IA_	New_WavefrontMap ()
	Open a new Wavefront Map window.

IA_	New_DetectorViewer ()
	Open a new Detector Viewer window.

IA_	New_CriticalRayTracer ()
	Open a new Critical Ray Tracer window.

IA_	New_PathAnalysis ()
	Open a new Path Analysis window.

IA_	New_NSCSingleRayTrace ()
	Open a new Full-Field Aberration window.

IA_	New_FileComparator ()
	Open a new File Comparator window.

IA_	New_GrinProfile ()
	Opens a new Grin Profile window.

IA_	New_GeometricImageAnalysis ()
	Opens a new Geometric Image Analysis window.

IColorTranslator	CreateColorTranslatorAuto (ColorPaletteType palette, bool inversePalette, int numberOfShades=256)

IColorTranslator	CreateLogColorTranslatorAuto (ColorPaletteType palette, bool inversePalette, double logBase=10.0, int numberOfShades=256)

IColorTranslator	CreateColorTranslatorFixed (double minValue, double maxValue, ColorPaletteType palette, bool inversePalette, int numberOfShades=256)

IColorTranslator	CreateLogColorTranslatorFixed (double minValue, double maxValue, ColorPaletteType palette, bool inversePalette, double logBase=10.0, int numberOfShades=256)

IMessage	RunHighSamplingPOP (string configFile, POPSampling xSampling, POPSampling ySampling, string outputTextFile, string outputBeamFileName, bool saveBeamAtAllSurfaces)
	Generates output from a POP analysis at higher sampling than normally allowed.

IA_	New_QuickYield ()
	Opens a new Quick Yield window.

IA_	New_SurfaceSlope ()
	Opens a new Surface Slope window.

IA_	New_SurfaceSlopeCross ()
	Opens a new Surface Slope Cross Section window.

IA_	New_SurfacePhaseSlope ()
	Opens a new Surface Phase Slope window.

IA_	New_SurfacePhaseSlopeCross ()
	Opens a new Surface Phase Slope Cross Section window.

IA_	New_ReflectionVsAngle ()
	Opens a new Reflection Vs. Angle window.

IA_	New_TransmissionVsAngle ()
	Opens a new Transmission Vs. Angle window.

IA_	New_AbsorptionVsAngle ()
	Opens a new Absorption Vs. Angle window.

IA_	New_DiattenuationVsAngle ()
	Opens a new Diattenuation Vs. Angle window.

IA_	New_PhaseVsAngle ()
	Opens a new Phase Vs. Angle window.

IA_	New_RetardanceVsAngle ()
	Opens a new Retardance Vs. Angle window.

IA_	New_ReflectionVsWavelength ()
	Opens a new Reflection Vs. Wavelength window.

IA_	New_TransmissionVsWavelength ()
	Opens a new Transmission Vs. Wavelength window.

IA_	New_AbsorptionVsWavelength ()
	Opens a new Absorption Vs. Wavelength window.

IA_	New_DiattenuationVsWavelength ()
	Opens a new Diattenuation Vs. Wavelength window.

IA_	New_PhaseVsWavelength ()
	Opens a new Phase Vs. Wavelength window.

IA_	New_RetardanceVsWavelength ()
	Opens a new Retardance Vs. Wavelength window.

IA_	New_ImageSimulation ()
	Opens a new Image Simulation window.

IA_	New_RelativeIllumination ()
	Opens a new Relative Illumination window.

IA_	New_TolerancingYield ()
	Opens a new Tolerancing Yield window.

IA_	New_TolerancingHistogram ()
	Opens a new Tolerancing Histogram window.

IA_	New_InternalTransmissionvsWavelength ()
	Opens a new Internal Transmission vs Wavelength window.

Properties
int	NumberOfAnalyses `[get]`
	Gets the number of analyses open in the current system.

Detailed Description

Methods and interfaces for opening, closing, and retrieving analyses. This interface can be accessed via the IOpticalSystem interface.

Examples: CSharpStandalone_21_White_LED_Phosphor.cs.

Member Function Documentation

◆ CloseAnalysis() [1/2]

bool ZOSAPI.Analysis.I_Analyses.CloseAnalysis ( IA_ analysis )

Closes the specified analysis.

Parameters

analysis The analysis to close.

Returns: true

if the analysis is valid and open; otherwise,
false

.

◆ CloseAnalysis() [2/2]

bool ZOSAPI.Analysis.I_Analyses.CloseAnalysis ( int index )

Closes the specified analysis.

Parameters

index The index of the analysis (1 to NumberOfAnalyses).

Returns: true

if the specified analysis number is valid; otherwise,
false

.

◆ CreateColorTranslatorAuto()

IColorTranslator ZOSAPI.Analysis.I_Analyses.CreateColorTranslatorAuto	(	ColorPaletteType	palette,
		bool	inversePalette,
		int	numberOfShades = `256`
	)

◆ CreateColorTranslatorFixed()

IColorTranslator ZOSAPI.Analysis.I_Analyses.CreateColorTranslatorFixed	(	double	minValue,
		double	maxValue,
		ColorPaletteType	palette,
		bool	inversePalette,
		int	numberOfShades = `256`
	)

◆ CreateLogColorTranslatorAuto()

IColorTranslator ZOSAPI.Analysis.I_Analyses.CreateLogColorTranslatorAuto	(	ColorPaletteType	palette,
		bool	inversePalette,
		double	logBase = `10.0`,
		int	numberOfShades = `256`
	)

◆ CreateLogColorTranslatorFixed()

IColorTranslator ZOSAPI.Analysis.I_Analyses.CreateLogColorTranslatorFixed	(	double	minValue,
		double	maxValue,
		ColorPaletteType	palette,
		bool	inversePalette,
		double	logBase = `10.0`,
		int	numberOfShades = `256`
	)

◆ Get_AnalysisAtIndex()

IA_ ZOSAPI.Analysis.I_Analyses.Get_AnalysisAtIndex ( int index )

Retrieve the specified analysis.

Parameters

index The index of the analysis (1 to NumberOfAnalyses).

Returns: The specified analysis if it exists; otherwise,
null

.

◆ New_AbsorptionVsAngle()

IA_ ZOSAPI.Analysis.I_Analyses.New_AbsorptionVsAngle ( )

Opens a new Absorption Vs. Angle window.

Returns

◆ New_AbsorptionVsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_AbsorptionVsWavelength ( )

Opens a new Absorption Vs. Wavelength window.

Returns

◆ New_Analysis()

IA_ ZOSAPI.Analysis.I_Analyses.New_Analysis ( AnalysisIDM AnalysisType )

Create a new analysis of the specified type.

Usage (see Example 15 for a full sample)

C#

            //Open a shaded model
            IA_ analysis = TheSystem.Analyses.New_Analysis(AnalysisIDM.ShadedModel);
            analysis.Terminate();
            analysis.WaitForCompletion();
            IAS_ analysisSettings = analysis.GetSettings();
            string cfgFile = System.IO.Path.GetTempFileName();
            // Save the current settings to the temp file
            analysisSettings.SaveTo(cfgFile);
            // make your modifications to it
            //MODIFYSETTINGS are defined in the ZPL help files: The Programming Tab > About the ZPL > Keywords
            analysisSettings.ModifySettings(cfgFile, "SHA_ROTX", "90");
            analysisSettings.ModifySettings(cfgFile, "SHA_ROTY", "0");
            analysisSettings.ModifySettings(cfgFile, "SHA_ROTZ", "0");
            // now load in the modified settings
            analysisSettings.LoadFrom(cfgFile);
            // If you want to overwrite your default CFG, copy it after you are done modifying the settings:
            //string CFG_fullname = System.Environment.GetEnvironmentVariable("USERPROFILE") + "\\Documents\\Zemax\\Configs\\Configs\\POP.CFG";
            //System.IO.File.Copy(cfgFile, CFG_fullname, true);
            // We don't need the temp file any more, so delete it
            System.IO.File.Delete(cfgFile);
            // Run the analysis with the new settings
            analysis.ApplyAndWaitForCompletion();

C++

    // Open a shaded model
    IA_Ptr analysis = TheSystem->Analyses->New_Analysis(AnalysisIDM::AnalysisIDM_ShadedModel);
    analysis->Terminate();
    analysis->WaitForCompletion();
    IAS_Ptr settings = analysis->GetSettings();
    //need to use - #pragma warning(disable:4996)
    char* pUserprofile = getenv("Temp");
    _bstr_t cfgFile = _bstr_t(pUserprofile) + "\\sha.cfg";
    // Save the current settings to the temp file
    settings->SaveTo(cfgFile);
    // make your modifications to it
    // MODIFYSETTINGS are defined in the ZPL help files : The Programming Tab > About the ZPL > Keywords
    settings->ModifySettings(cfgFile, "SHA_ROTX", "90");
    settings->ModifySettings(cfgFile, "SHA_ROTY", "0");
    settings->ModifySettings(cfgFile, "SHA_ROTZ", "0");
    // now load in the modified settings
    settings->LoadFrom(cfgFile);
    // If you want to overwrite your default CFG, copy it after you are done modifying the settings :
    //_bstr_t CFG_fullname = _bstr_t(getenv("USERPROFILE")) + "\\Documents\\Zemax\\Configs\\POP.CFG";
    // copyfile(cfgFile, CFG_fullname) // generic psuedo code
    // We don't need the temp file any more, so delete it
    std::remove(cfgFile);
    // Run the analysis with the new settings
    analysis->ApplyAndWaitForCompletion();

Matlab

    %Open a shaded model
    analysis = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.ShadedModel);
    analysis.Terminate();
    analysis.WaitForCompletion();
    analysisSettings = analysis.GetSettings();
    cfgFile = System.IO.Path.GetTempFileName();
    % Save the current settings to the temp file
    analysisSettings.SaveTo(cfgFile);
    % make your modifications to it
    %MODIFYSETTINGS are defined in the ZPL help files: The Programming Tab > About the ZPL > Keywords
    analysisSettings.ModifySettings(cfgFile, 'SHA_ROTX', '90');
    analysisSettings.ModifySettings(cfgFile, 'SHA_ROTY', '0');
    analysisSettings.ModifySettings(cfgFile, 'SHA_ROTZ', '0');
    % now load in the modified settings
    analysisSettings.LoadFrom(cfgFile);
    % If you want to overwrite your default CFG, copy it after you are done modifying the settings:
    %string CFG_fullname = System.Environment.GetEnvironmentVariable("USERPROFILE") + "\\Configs\\POP.CFG";
    %System.IO.File.Copy(cfgFile, CFG_fullname, true);
    % We don't need the temp file any more, so delete it
    System.IO.File.Delete(cfgFile);
    % Run the analysis with the new settings
    analysis.ApplyAndWaitForCompletion();

Python

    # Open a shaded model
    analysis = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.ShadedModel)
    analysis.Terminate()
    analysis.WaitForCompletion()
    analysisSettings = analysis.GetSettings()
    cfgFile = os.environ.get('Temp') + '\\sha.cfg'
    # Save the current settings to the temp file
    analysisSettings.SaveTo(cfgFile)
    # make your modifications to it
    # MODIFYSETTINGS are defined in the ZPL help files: The Programming Tab > About the ZPL > Keywords
    analysisSettings.ModifySettings(cfgFile, 'SHA_ROTX', '90')
    analysisSettings.ModifySettings(cfgFile, 'SHA_ROTY', '0')
    analysisSettings.ModifySettings(cfgFile, 'SHA_ROTZ', '0')
    # now load in the modified settings
    analysisSettings.LoadFrom(cfgFile)
    # If you want to overwrite your default CFG, copy it after you are done modifying the settings:
    # CFG_fullname = os.environ.get('USERPROFILE') + '\\Documents\\Zemax\\Configs\\POP.CFG'
    # copyfile(cfgFile, CFG_fullname)
    # We don't need the temp file any more, so delete it
    if os.path.exists(cfgFile):
        os.remove(cfgFile)
    # Run the analysis with the new settings
    analysis.ApplyAndWaitForCompletion()

Parameters

AnalysisType The type of analysis to open. See AnalysisIDM for the available options.

Returns: The newly opened analysis if successful; otherwise
null

.

◆ New_Analysis_SettingsFirst()

IA_ ZOSAPI.Analysis.I_Analyses.New_Analysis_SettingsFirst ( AnalysisIDM AnalysisType )

Create a new analysis of the specified type, but does not run the analysis and wait for it to finish.

Parameters

AnalysisType The type of analysis to open. See AnalysisIDM for the available options.

Returns: The newly opened analysis if successful; otherwise
null

.

◆ New_ConfigurationMatrixSpot()

IA_ ZOSAPI.Analysis.I_Analyses.New_ConfigurationMatrixSpot ( )

Open a new Configuration Matrix Spot Diagram window.

Returns

◆ New_ContrastLossMap()

IA_ ZOSAPI.Analysis.I_Analyses.New_ContrastLossMap ( )

Open a new Contrast Loss Map window.

Usage (see Example 04 for a full sample)

C#

// Create analysis

IA_ newWin = TheSystem.Analyses.New_FftMtf();

C++

    // Create analysis
    I_AnalysesPtr TheAnalyses = TheSystem->Analyses;
    IA_Ptr newWin = TheAnalyses->New_FftMtf();

Matlab

% Create analysis

newWin = TheSystem.Analyses.New_FftMtf();

Python

    # Create analysis
    TheAnalyses = TheSystem.Analyses
    newWin = TheAnalyses.New_FftMtf()

Returns

◆ New_CriticalRayTracer()

IA_ ZOSAPI.Analysis.I_Analyses.New_CriticalRayTracer ( )

Open a new Critical Ray Tracer window.

Returns

◆ New_DetectorViewer()

IA_ ZOSAPI.Analysis.I_Analyses.New_DetectorViewer ( )

Open a new Detector Viewer window.

Usage (see Example 10 for a full sample)

C#

            // Open Detector Viewer, view previously saved .zrd file
            IA_ DetectorView = TheSystem.Analyses.New_DetectorViewer();
            IAS_DetectorViewer DetectorView_Settings = DetectorView.GetSettings() as IAS_DetectorViewer;
            DetectorView_Settings.RayDatabaseFilename = "e10_API_RayTrace.ZRD";
            DetectorView_Settings.ShowAs = DetectorViewerShowAsTypes.FalseColor;
            DetectorView_Settings.Filter = "X_HIT(2, 4)";  // Detector will only display rays which hit object 2 exactly 4 times
 
            DetectorView.ApplyAndWaitForCompletion();  // Apply Settings to Detector Viewer

C++

    // Open Detector Viewer, view previously saved .zrd file
    IA_Ptr DetectorView = TheSystem->Analyses->New_DetectorViewer();
    IAS_DetectorViewerPtr DetectorView_Settings = DetectorView->GetSettings();
    DetectorView_Settings->RayDatabaseFilename = "e10_API_Raytrace.ZRD";
    DetectorView_Settings->ShowAs = DetectorViewerShowAsTypes_FalseColor;
    // Detector will only display rays which hit object 2 exactly 4 times
    DetectorView_Settings->Filter = "X_HIT(2, 4)";
    // Apply Settings to Detector Viewer
    DetectorView->ApplyAndWaitForCompletion();  

Matlab

    % Open Detector Viewer, view previously saved .zrd file
    DetectorView = TheSystem.Analyses.New_DetectorViewer();
    DetectorView_Settings = DetectorView.GetSettings();
    DetectorView_Settings.RayDatabaseFilename = 'e10_API_Raytrace.ZRD';
    DetectorView_Settings.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.FalseColor;
    DetectorView_Settings.Filter = 'X_HIT(2, 4)';  % Detector will only display rays which hit object 2 exactly 4 times
 
    DetectorView.ApplyAndWaitForCompletion(); % Apply Settings to Detector Viewer

Python

    # Open Detector Viewer, view previously saved .zrd file
    DetectorView = TheSystem.Analyses.New_DetectorViewer()
    DetectorView_Settings = DetectorView.GetSettings()
    DetectorView_Settings.RayDatabaseFilename = "e10_API_Raytrace.ZRD"
    DetectorView_Settings.ShowAs = ZOSAPI.Analysis.DetectorViewerShowAsTypes.FalseColor
    DetectorView_Settings.Filter = "X_HIT(2, 4)"  # Detector will only display rays which hit object 2 exactly 4 times
    DetectorView.ApplyAndWaitForCompletion()  # Apply Settings to Detector Viewer

Returns

Examples: CSharpStandalone_21_White_LED_Phosphor.cs.

◆ New_DiattenuationVsAngle()

IA_ ZOSAPI.Analysis.I_Analyses.New_DiattenuationVsAngle ( )

Opens a new Diattenuation Vs. Angle window.

Returns

◆ New_DiattenuationVsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_DiattenuationVsWavelength ( )

Opens a new Diattenuation Vs. Wavelength window.

Returns

◆ New_DiffractionEncircledEnergy()

IA_ ZOSAPI.Analysis.I_Analyses.New_DiffractionEncircledEnergy ( )

Open a new Diffraction Encircled Energy window.

Returns

◆ New_ExtendedSourceEncircledEnergy()

IA_ ZOSAPI.Analysis.I_Analyses.New_ExtendedSourceEncircledEnergy ( )

Open a new Extended Source Encircled Energy window.

Returns

◆ New_FftMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftMtf ( )

Open a new FFT MTF window.

Returns

◆ New_FftMtfMap()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftMtfMap ( )

Open a new FFT MTF Map window.

Returns

◆ New_FftMtfvsField()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftMtfvsField ( )

Open a new FFT MTF vs. Field window.

Returns

◆ New_FftPsf()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftPsf ( )

Open a new FFT PSF window.

Returns

◆ New_FftPsfCrossSection()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftPsfCrossSection ( )

Open a new FFT PSF Cross Section window.

Returns

◆ New_FftPsfLineEdgeSpread()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftPsfLineEdgeSpread ( )

Open a new FFT Line/Edge Spread window.

Returns

◆ New_FftSurfaceMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftSurfaceMtf ( )

Open a new FFT Surface MTF window.

Returns

◆ New_FftThroughFocusMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_FftThroughFocusMtf ( )

Open a new FFT Through Focus MTF window.

Returns

◆ New_FieldCurvatureAndDistortion()

IA_ ZOSAPI.Analysis.I_Analyses.New_FieldCurvatureAndDistortion ( )

Open a new Field Curv/Dist window.

Returns

◆ New_FileComparator()

IA_ ZOSAPI.Analysis.I_Analyses.New_FileComparator ( )

Open a new File Comparator window.

Returns

◆ New_FocalShiftDiagram()

IA_ ZOSAPI.Analysis.I_Analyses.New_FocalShiftDiagram ( )

Open a new Focal Shift window.

Returns

◆ New_Foucault()

IA_ ZOSAPI.Analysis.I_Analyses.New_Foucault ( )

Open a new Foucault Analysis window.

Returns

◆ New_FullFieldAberration()

IA_ ZOSAPI.Analysis.I_Analyses.New_FullFieldAberration ( )

Open a new Full-Field Aberration window.

Returns

◆ New_FullFieldSpot()

IA_ ZOSAPI.Analysis.I_Analyses.New_FullFieldSpot ( )

Open a new Full Field Spot Diagram window.

Returns

◆ New_GeometricEncircledEnergy()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricEncircledEnergy ( )

Open a new Geometric Encircled Energy window.

Returns

◆ New_GeometricImageAnalysis()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricImageAnalysis ( )

Opens a new Geometric Image Analysis window.

Returns

◆ New_GeometricLineEdgeSpread()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricLineEdgeSpread ( )

Open a new Line/Edge Spread window.

Returns

◆ New_GeometricMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricMtf ( )

Open a new Geometric MTF window.

Returns

◆ New_GeometricMtfMap()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricMtfMap ( )

Open a new Geometric MTF Map window.

Returns

◆ New_GeometricMtfvsField()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricMtfvsField ( )

Open a new Geometric MTF vs. Field window.

Returns

◆ New_GeometricThroughFocusMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_GeometricThroughFocusMtf ( )

Open a new Through Focus Geometric MTF window.

Returns

◆ New_GridDistortion()

IA_ ZOSAPI.Analysis.I_Analyses.New_GridDistortion ( )

Open a new Grid Distortion window.

Returns

◆ New_GrinProfile()

IA_ ZOSAPI.Analysis.I_Analyses.New_GrinProfile ( )

Opens a new Grin Profile window.

Returns

◆ New_HuygensMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_HuygensMtf ( )

Open a new Huygens MTF window.

Returns

◆ New_HuygensMtfvsField()

IA_ ZOSAPI.Analysis.I_Analyses.New_HuygensMtfvsField ( )

Open a new Huygens MTF vs. Field window.

Returns

◆ New_HuygensPsf()

IA_ ZOSAPI.Analysis.I_Analyses.New_HuygensPsf ( )

Open a new Huygens PSF window.

Returns

◆ New_HuygensPsfCrossSection()

IA_ ZOSAPI.Analysis.I_Analyses.New_HuygensPsfCrossSection ( )

Open a new Huygens PSF Cross Section window.

Returns

◆ New_HuygensSurfaceMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_HuygensSurfaceMtf ( )

Open a new Huygens Surface MTF window.

Returns

◆ New_HuygensThroughFocusMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_HuygensThroughFocusMtf ( )

Open a new Huygens Through Focus MTF window.

Returns

◆ New_ImageSimulation()

IA_ ZOSAPI.Analysis.I_Analyses.New_ImageSimulation ( )

Opens a new Image Simulation window.

Returns

◆ New_Interferogram()

IA_ ZOSAPI.Analysis.I_Analyses.New_Interferogram ( )

Open a new Interferogram window.

Returns

◆ New_InternalTransmissionvsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_InternalTransmissionvsWavelength ( )

Opens a new Internal Transmission vs Wavelength window.

Returns

◆ New_LateralColor()

IA_ ZOSAPI.Analysis.I_Analyses.New_LateralColor ( )

Open a new Lateral Color window.

Returns

◆ New_LongitudinalAberration()

IA_ ZOSAPI.Analysis.I_Analyses.New_LongitudinalAberration ( )

Open a new Longitudinal Aberration window.

Returns

◆ New_MatrixSpot()

IA_ ZOSAPI.Analysis.I_Analyses.New_MatrixSpot ( )

Open a new Matrix Spot Diagram window.

Returns

◆ New_NSCGeometricMtf()

IA_ ZOSAPI.Analysis.I_Analyses.New_NSCGeometricMtf ( )

Open a new Non-Sequential Geometric MTF window.

Returns

◆ New_NSCSingleRayTrace()

IA_ ZOSAPI.Analysis.I_Analyses.New_NSCSingleRayTrace ( )

Open a new Full-Field Aberration window.

Returns

◆ New_NSCSurfaceSag()

IA_ ZOSAPI.Analysis.I_Analyses.New_NSCSurfaceSag ( )

◆ New_OpticalPathFan()

IA_ ZOSAPI.Analysis.I_Analyses.New_OpticalPathFan ( )

Open a new OPD Fan window.

Returns

◆ New_PathAnalysis()

IA_ ZOSAPI.Analysis.I_Analyses.New_PathAnalysis ( )

Open a new Path Analysis window.

Returns

◆ New_PhaseVsAngle()

IA_ ZOSAPI.Analysis.I_Analyses.New_PhaseVsAngle ( )

Opens a new Phase Vs. Angle window.

Returns

◆ New_PhaseVsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_PhaseVsWavelength ( )

Opens a new Phase Vs. Wavelength window.

Returns

◆ New_PupilAberrationFan()

IA_ ZOSAPI.Analysis.I_Analyses.New_PupilAberrationFan ( )

Open a new Pupil Aberration Fan window.

Returns

◆ New_QuickYield()

IA_ ZOSAPI.Analysis.I_Analyses.New_QuickYield ( )

Opens a new Quick Yield window.

Returns

◆ New_RayFan()

IA_ ZOSAPI.Analysis.I_Analyses.New_RayFan ( )

Open a new Ray Fan window.

Returns

◆ New_RayTrace()

IA_ ZOSAPI.Analysis.I_Analyses.New_RayTrace ( )

Open a new Single Ray Trace window.

Returns

◆ New_ReflectionVsAngle()

IA_ ZOSAPI.Analysis.I_Analyses.New_ReflectionVsAngle ( )

Opens a new Reflection Vs. Angle window.

Returns

◆ New_ReflectionVsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_ReflectionVsWavelength ( )

Opens a new Reflection Vs. Wavelength window.

Returns

◆ New_RelativeIllumination()

IA_ ZOSAPI.Analysis.I_Analyses.New_RelativeIllumination ( )

Opens a new Relative Illumination window.

Returns

◆ New_RetardanceVsAngle()

IA_ ZOSAPI.Analysis.I_Analyses.New_RetardanceVsAngle ( )

Opens a new Retardance Vs. Angle window.

Returns

◆ New_RetardanceVsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_RetardanceVsWavelength ( )

Opens a new Retardance Vs. Wavelength window.

Returns

◆ New_RMSField()

IA_ ZOSAPI.Analysis.I_Analyses.New_RMSField ( )

Open a new RMS vs. Field window.

Returns

◆ New_RMSFieldMap()

IA_ ZOSAPI.Analysis.I_Analyses.New_RMSFieldMap ( )

Open a new RMS Field Map window.

Returns

◆ New_RMSFocus()

IA_ ZOSAPI.Analysis.I_Analyses.New_RMSFocus ( )

Open a new RMS vs. Focus window.

Returns

◆ New_RMSLambdaDiagram()

IA_ ZOSAPI.Analysis.I_Analyses.New_RMSLambdaDiagram ( )

Open a new RMS vs. Wavelength window.

Returns

◆ New_SeidelCoefficients()

IA_ ZOSAPI.Analysis.I_Analyses.New_SeidelCoefficients ( )

Open a new Seidel Coefficients window.

Returns

◆ New_SeidelDiagram()

IA_ ZOSAPI.Analysis.I_Analyses.New_SeidelDiagram ( )

Open a new Seidel Diagram window.

Returns

◆ New_StandardSpot()

IA_ ZOSAPI.Analysis.I_Analyses.New_StandardSpot ( )

Open a new Spot Diagram window.

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
            IAS_Spot spotSet = newSpot.GetSettings() as IAS_Spot;
            spotSet.RayDensity = 15;
            newSpot.ApplyAndWaitForCompletion();

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()

Returns

◆ New_SurfaceCurvature()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfaceCurvature ( )

Open a new Surface Curvature window.

Returns

◆ New_SurfaceCurvatureCross()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfaceCurvatureCross ( )

Open a new Surface Curvature Cross Section window.

Returns

◆ New_SurfacePhase()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfacePhase ( )

Open a new Surface Phase window.

Returns

◆ New_SurfacePhaseCross()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfacePhaseCross ( )

Open a new Surface Phase Cross Section window.

Returns

◆ New_SurfacePhaseSlope()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfacePhaseSlope ( )

Opens a new Surface Phase Slope window.

Returns

◆ New_SurfacePhaseSlopeCross()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfacePhaseSlopeCross ( )

Opens a new Surface Phase Slope Cross Section window.

Returns

◆ New_SurfaceSag()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfaceSag ( )

Open a new Surface Sag window.

Returns

◆ New_SurfaceSagCross()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfaceSagCross ( )

Open a new Surface Sag Cross Section window.

Returns

◆ New_SurfaceSlope()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfaceSlope ( )

Opens a new Surface Slope window.

Returns

◆ New_SurfaceSlopeCross()

IA_ ZOSAPI.Analysis.I_Analyses.New_SurfaceSlopeCross ( )

Opens a new Surface Slope Cross Section window.

Returns

◆ New_ThroughFocusSpot()

IA_ ZOSAPI.Analysis.I_Analyses.New_ThroughFocusSpot ( )

Open a new Through Focus Spot Diagram window.

Returns

◆ New_TolerancingHistogram()

IA_ ZOSAPI.Analysis.I_Analyses.New_TolerancingHistogram ( )

Opens a new Tolerancing Histogram window.

Returns

◆ New_TolerancingYield()

IA_ ZOSAPI.Analysis.I_Analyses.New_TolerancingYield ( )

Opens a new Tolerancing Yield window.

Returns

◆ New_TransmissionVsAngle()

IA_ ZOSAPI.Analysis.I_Analyses.New_TransmissionVsAngle ( )

Opens a new Transmission Vs. Angle window.

Returns

◆ New_TransmissionVsWavelength()

IA_ ZOSAPI.Analysis.I_Analyses.New_TransmissionVsWavelength ( )

Opens a new Transmission Vs. Wavelength window.

Returns

◆ New_WavefrontMap()

IA_ ZOSAPI.Analysis.I_Analyses.New_WavefrontMap ( )

Open a new Wavefront Map window.

Returns

◆ New_XXXTemplateXXX()

IA_ ZOSAPI.Analysis.I_Analyses.New_XXXTemplateXXX ( )

◆ New_ZernikeAnnularCoefficients()

IA_ ZOSAPI.Analysis.I_Analyses.New_ZernikeAnnularCoefficients ( )

Open a new Zernike Annular Coefficients window.

Returns

◆ New_ZernikeCoefficientsVsField()

IA_ ZOSAPI.Analysis.I_Analyses.New_ZernikeCoefficientsVsField ( )

Open a new Zernike Coefficients vs. Field window.

Returns

◆ New_ZernikeFringeCoefficients()

IA_ ZOSAPI.Analysis.I_Analyses.New_ZernikeFringeCoefficients ( )

Open a new Zernike Fringe Coefficients window.

Returns

◆ New_ZernikeStandardCoefficients()

IA_ ZOSAPI.Analysis.I_Analyses.New_ZernikeStandardCoefficients ( )

Open a new Zernike Standard Coefficients window.

Returns

◆ RunHighSamplingPOP()

IMessage ZOSAPI.Analysis.I_Analyses.RunHighSamplingPOP	(	string	configFile,
		POPSampling	xSampling,
		POPSampling	ySampling,
		string	outputTextFile,
		string	outputBeamFileName,
		bool	saveBeamAtAllSurfaces
	)

Generates output from a POP analysis at higher sampling than normally allowed.

Parameters

configFile	Full path to a CFG file to use for the POP settings; if no configuration file is specified default settings will be used. Note that it is recommended to save the CFG file from a text window, as not all graphic window settings are meaningful for text output.
xSampling	Sampling override in the X-direction.
ySampling	Sampling override in the Y-direction.
outputTextFile	Full path to save the text output file; if ommitted no output file will be saved.
outputBeamFileName	File name only for the output beam file; the file will be saved in the POP\BEAMFILES directory.
saveBeamAtAllSurfaces	Flag to save the output beam for all surfaces; if outputBeamFileName is omitted, this flag will be ignored.

Returns

Property Documentation

◆ NumberOfAnalyses

int ZOSAPI.Analysis.I_Analyses.NumberOfAnalyses

get

Gets the number of analyses open in the current system.

The number of analyses.

ZOSAPI.Analysis.I_Analyses Interface Reference

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CloseAnalysis() [1/2]

◆ CloseAnalysis() [2/2]

◆ CreateColorTranslatorAuto()

◆ CreateColorTranslatorFixed()

◆ CreateLogColorTranslatorAuto()

◆ CreateLogColorTranslatorFixed()

◆ Get_AnalysisAtIndex()

◆ New_AbsorptionVsAngle()

◆ New_AbsorptionVsWavelength()

◆ New_Analysis()

◆ New_Analysis_SettingsFirst()

◆ New_ConfigurationMatrixSpot()

◆ New_ContrastLossMap()

◆ New_CriticalRayTracer()

◆ New_DetectorViewer()

◆ New_DiattenuationVsAngle()

◆ New_DiattenuationVsWavelength()

◆ New_DiffractionEncircledEnergy()

◆ New_ExtendedSourceEncircledEnergy()

◆ New_FftMtf()

◆ New_FftMtfMap()

◆ New_FftMtfvsField()

◆ New_FftPsf()

◆ New_FftPsfCrossSection()

◆ New_FftPsfLineEdgeSpread()

◆ New_FftSurfaceMtf()

◆ New_FftThroughFocusMtf()

◆ New_FieldCurvatureAndDistortion()

◆ New_FileComparator()

◆ New_FocalShiftDiagram()

◆ New_Foucault()

◆ New_FullFieldAberration()

◆ New_FullFieldSpot()

◆ New_GeometricEncircledEnergy()

◆ New_GeometricImageAnalysis()

◆ New_GeometricLineEdgeSpread()

◆ New_GeometricMtf()

◆ New_GeometricMtfMap()

◆ New_GeometricMtfvsField()

◆ New_GeometricThroughFocusMtf()

◆ New_GridDistortion()

◆ New_GrinProfile()

◆ New_HuygensMtf()

◆ New_HuygensMtfvsField()

◆ New_HuygensPsf()

◆ New_HuygensPsfCrossSection()

◆ New_HuygensSurfaceMtf()

◆ New_HuygensThroughFocusMtf()

◆ New_ImageSimulation()

◆ New_Interferogram()

◆ New_InternalTransmissionvsWavelength()

◆ New_LateralColor()

◆ New_LongitudinalAberration()

◆ New_MatrixSpot()

◆ New_NSCGeometricMtf()

◆ New_NSCSingleRayTrace()

◆ New_NSCSurfaceSag()

◆ New_OpticalPathFan()

◆ New_PathAnalysis()

◆ New_PhaseVsAngle()

◆ New_PhaseVsWavelength()

◆ New_PupilAberrationFan()

◆ New_QuickYield()

◆ New_RayFan()

◆ New_RayTrace()

◆ New_ReflectionVsAngle()

◆ New_ReflectionVsWavelength()

◆ New_RelativeIllumination()

◆ New_RetardanceVsAngle()

◆ New_RetardanceVsWavelength()

◆ New_RMSField()

◆ New_RMSFieldMap()

◆ New_RMSFocus()

◆ New_RMSLambdaDiagram()

◆ New_SeidelCoefficients()