Public Member Functions
double	Get_X_For (int fieldN, int waveN)

double	Get_Y_For (int fieldN, int waveN)

double	Get_Z_For (int fieldN, int waveN)

double	Get_L_For (int fieldN, int waveN)

double	Get_M_For (int fieldN, int waveN)

double	Get_N_For (int fieldN, int waveN)

double	GetDetector_X_For (int fieldN, int waveN)

double	GetDetector_Y_For (int fieldN, int waveN)

double	GetDetector_Z_For (int fieldN, int waveN)

double	GetGeoSpotSizeFor (int fieldN, int waveN)

double	GetRMSSpotSizeFor (int fieldN, int waveN)

double	GetRMSSpot_X_For (int fieldN, int waveN)

double	GetRMSSpot_Y_For (int fieldN, int waveN)

double	GetReferenceCoordinate_X_For (int fieldN, int waveN)

double	GetReferenceCoordinate_Y_For (int fieldN, int waveN)

Properties
double	HalfWidth_X `[get]`

double	HalfWidth_Y `[get]`

double	MaxRadius `[get]`

double	MeanRadius `[get]`

int	NumberOfFields `[get]`

int	NumberOfWavelengths `[get]`

Detailed Description

Usage (see Example 22 for a full sample)

C#

            // Extract RMS & Geo spot size for field points
            spot.ApplyAndWaitForCompletion();
            ZOSAPI.Analysis.Data.IAR_ spot_results = spot.GetResults();
            Console.WriteLine("RMS radius: {0:F3}  {1:F3}  {2:F3}", spot_results.SpotData.GetRMSSpotSizeFor(1, 1), spot_results.SpotData.GetRMSSpotSizeFor(2, 1), spot_results.SpotData.GetRMSSpotSizeFor(3, 1));
            Console.WriteLine("GEO radius: {0:F3}  {1:F3}  {2:F3}", spot_results.SpotData.GetGeoSpotSizeFor(1, 1), spot_results.SpotData.GetGeoSpotSizeFor(2, 1), spot_results.SpotData.GetGeoSpotSizeFor(3, 1));

C++

    // Extract RMS & Geo spot size for field points
    spot->ApplyAndWaitForCompletion();
    IAR_Ptr spot_results = spot->GetResults();
    cout.precision(3);
    cout << fixed << "RMS radius: \t" << spot_results->SpotData->GetRMSSpotSizeFor(1, 1) << "\t" << spot_results->SpotData->GetRMSSpotSizeFor(2, 1) << "\t" << spot_results->SpotData->GetRMSSpotSizeFor(3, 1) << endl;
    cout << fixed << "GEO radius: \t" << spot_results->SpotData->GetGeoSpotSizeFor(1, 1) << "\t" << spot_results->SpotData->GetGeoSpotSizeFor(2, 1) << "\t" << spot_results->SpotData->GetGeoSpotSizeFor(3, 1) << endl;

Matlab

    % extract RMS & Geo spot size for field points
    spot.ApplyAndWaitForCompletion();
    spot_results = spot.GetResults();
    fprintf('RMS radius: %6.3f  %6.3f  %6.3f\n',spot_results.SpotData.GetRMSSpotSizeFor(1,1),spot_results.SpotData.GetRMSSpotSizeFor(2,1),spot_results.SpotData.GetRMSSpotSizeFor(3,1))
    fprintf('GEO radius: %6.3f  %6.3f  %6.3f\n',spot_results.SpotData.GetGeoSpotSizeFor(1,1),spot_results.SpotData.GetGeoSpotSizeFor(2,1),spot_results.SpotData.GetGeoSpotSizeFor(3,1))

Python

    # extract RMS & Geo spot size for field points
    spot.ApplyAndWaitForCompletion()
    #spot_results = spot.GetResults()
    spot_results = spot.GetResults()
    print('RMS radius: %6.3f  %6.3f  %6.3f' % (spot_results.SpotData.GetRMSSpotSizeFor(1, 1), spot_results.SpotData.GetRMSSpotSizeFor(2, 1), spot_results.SpotData.GetRMSSpotSizeFor(3, 1)))
    print('GEO radius: %6.3f  %6.3f  %6.3f' % (spot_results.SpotData.GetGeoSpotSizeFor(1, 1), spot_results.SpotData.GetGeoSpotSizeFor(2, 1), spot_results.SpotData.GetGeoSpotSizeFor(3, 1)))

Member Function Documentation

◆ Get_L_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.Get_L_For	(	int	fieldN,
		int	waveN
	)

◆ Get_M_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.Get_M_For	(	int	fieldN,
		int	waveN
	)

◆ Get_N_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.Get_N_For	(	int	fieldN,
		int	waveN
	)

◆ Get_X_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.Get_X_For	(	int	fieldN,
		int	waveN
	)

◆ Get_Y_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.Get_Y_For	(	int	fieldN,
		int	waveN
	)

◆ Get_Z_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.Get_Z_For	(	int	fieldN,
		int	waveN
	)

◆ GetDetector_X_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetDetector_X_For	(	int	fieldN,
		int	waveN
	)

◆ GetDetector_Y_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetDetector_Y_For	(	int	fieldN,
		int	waveN
	)

◆ GetDetector_Z_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetDetector_Z_For	(	int	fieldN,
		int	waveN
	)

◆ GetGeoSpotSizeFor()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetGeoSpotSizeFor	(	int	fieldN,
		int	waveN
	)

Examples: CSharpStandalone_22_seq_spot_diagram.cs.

◆ GetReferenceCoordinate_X_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetReferenceCoordinate_X_For	(	int	fieldN,
		int	waveN
	)

◆ GetReferenceCoordinate_Y_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetReferenceCoordinate_Y_For	(	int	fieldN,
		int	waveN
	)

◆ GetRMSSpot_X_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetRMSSpot_X_For	(	int	fieldN,
		int	waveN
	)

◆ GetRMSSpot_Y_For()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetRMSSpot_Y_For	(	int	fieldN,
		int	waveN
	)

◆ GetRMSSpotSizeFor()

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.GetRMSSpotSizeFor	(	int	fieldN,
		int	waveN
	)

Examples: CSharpStandalone_22_seq_spot_diagram.cs.

Property Documentation

◆ HalfWidth_X

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.HalfWidth_X

get

◆ HalfWidth_Y

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.HalfWidth_Y

get

◆ MaxRadius

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.MaxRadius

get

◆ MeanRadius

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.MeanRadius

get

◆ NumberOfFields

int ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.NumberOfFields

get

◆ NumberOfWavelengths

int ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.NumberOfWavelengths

get

ZOS-API interface 2024 R1

ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix Interface Reference

Public Member Functions

Properties