Interface ZOSAPI::Analysis::Data::IAR_SpotDataResultMatrix

Definition:

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

Members

• Get_L_For
• Get_M_For
• Get_N_For
• Get_X_For
• Get_Y_For
• Get_Z_For
• GetDetector_X_For
• GetDetector_Y_For
• GetDetector_Z_For
• GetGeoSpotSizeFor
• GetReferenceCoordinate_X_For
• GetReferenceCoordinate_Y_For
• GetRMSSpot_X_For
• GetRMSSpot_Y_For
• GetRMSSpotSizeFor
• HalfWidth_X
• HalfWidth_Y
• MaxRadius
• MeanRadius
• NumberOfFields
• NumberOfWavelengths

Properties

Property HalfWidth_X

Definition:

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.HalfWidth_X

Return type: double

Property HalfWidth_Y

Definition:

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.HalfWidth_Y

Return type: double

Property MaxRadius

Definition:

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.MaxRadius

Return type: double

Property MeanRadius

Definition:

double ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.MeanRadius

Return type: double

Property NumberOfFields

Definition:

int ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.NumberOfFields

Return type: int

Property NumberOfWavelengths

Definition:

int ZOSAPI.Analysis.Data.IAR_SpotDataResultMatrix.NumberOfWavelengths

Return type: int

Public functions

Function Get_X_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function Get_Y_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function Get_Z_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function Get_L_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function Get_M_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function Get_N_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetDetector_X_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetDetector_Y_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetDetector_Z_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetGeoSpotSizeFor

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetRMSSpotSizeFor

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetRMSSpot_X_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetRMSSpot_Y_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetReferenceCoordinate_X_For

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

Parameters:

• int fieldN
• int waveN

Return type: double

Function GetReferenceCoordinate_Y_For

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

Parameters:

• int fieldN
• int waveN

Return type: double