Interface ZOSAPI::Tools::IConvertToNSCGroup

Definition:

Interfaces and methods for converting the sequential surfaces to a non-sequential group. This interface can be accessed via the IOpticalSystemTools interface.

Usage (see Example 14 for a full sample)

C#

            // Convert file to Non-sequential mode
            ZOSAPI.Tools.IConvertToNSCGroup convertNSmode = TheSystem.Tools.OpenConvertToNSCGroup();
            convertNSmode.ConvertFileToNSC = true;
            convertNSmode.RunAndWaitForCompletion();
            convertNSmode.Close();
            // Save the Non-sequential file to the Double Gauss folder
            string fileNameNS = System.IO.Path.Combine(dirLoc, "Double Gauss (NS).zos");
            TheSystem.SaveAs(fileNameNS);

C++

    // Convert file to Non-sequential mode
    ZOSAPI_Interfaces::IConvertToNSCGroupPtr convertNSmode = TheSystem->Tools->OpenConvertToNSCGroup();
    convertNSmode->ConvertFileToNSC = true;
    ZOSAPI_Interfaces::ISystemToolPtr baseTool2 = convertNSmode;
    baseTool2->RunAndWaitForCompletion();
    baseTool2->Close();
    // Save the Non-sequential file to the Double Gauss folder
    _bstr_t fileNameNS = dirLoc + (_bstr_t)"\\Double_Gauss_(NS).zos";
    TheSystem->SaveAs(fileNameNS);

Matlab

    % Convert file to Non-sequential mode
    convertNSmode = TheSystem.Tools.OpenConvertToNSCGroup();
    convertNSmode.ConvertFileToNSC = true;
    convertNSmode.RunAndWaitForCompletion();
    convertNSmode.Close();
    % Save the Non-sequential file to the Double Gauss folder
    fileNameNS = System.String.Concat(dirLoc, '\Double Gauss (NS).zos');
    TheSystem.SaveAs(fileNameNS);

Python

    # Convert file to Non-sequential mode
    convertNSmode = TheSystem.Tools.OpenConvertToNSCGroup()
    convertNSmode.ConvertFileToNSC = True
    convertNSmode.RunAndWaitForCompletion()
    convertNSmode.Close();
    # Save the Non-sequential file to the Double Gauss folder
    fileNameNS = dirLoc + "\\Double Gauss (NS).zos"
    TheSystem.SaveAs(fileNameNS)

Inherits from:

• ZOSAPI.Tools.ISystemTool

Members

• CanCancel
• Cancel
• Close
• ConvertFileToNSC
• ConvertStopToNSCAperture
• ConvertToGlobalCoordinates
• CreateSourcesAndDetectors
• ErrorMessage
• FirstSurface
• HighFidelityConversion
• HighFidelityResolution
• IgnoreErrors
• IsAsynchronous
• IsFiniteDuration
• IsRunning
• IsValid
• LastSurface
• OverfillFactor
• Progress
• Run
• RunAndWaitForCompletion
• RunAndWaitWithTimeout
• Status
• StopMechanicalHalfWidth
• StopObjectFace
• StopObjectNumber
• Succeeded
• WaitForCompletion
• WaitWithTimeout

Properties

Property FirstSurface

Definition:

int ZOSAPI.Tools.IConvertToNSCGroup.FirstSurface

Return type: int

Property LastSurface

Definition:

int ZOSAPI.Tools.IConvertToNSCGroup.LastSurface

Return type: int

Property IgnoreErrors

Definition:

bool ZOSAPI.Tools.IConvertToNSCGroup.IgnoreErrors

Return type: bool

Property ConvertFileToNSC

Definition:

bool ZOSAPI.Tools.IConvertToNSCGroup.ConvertFileToNSC

Return type: bool

Property CreateSourcesAndDetectors

Definition:

bool ZOSAPI.Tools.IConvertToNSCGroup.CreateSourcesAndDetectors

Return type: bool

Property ConvertToGlobalCoordinates

Definition:

bool ZOSAPI.Tools.IConvertToNSCGroup.ConvertToGlobalCoordinates

Return type: bool

Property ConvertStopToNSCAperture

Definition:

bool ZOSAPI.Tools.IConvertToNSCGroup.ConvertStopToNSCAperture

Return type: bool

Property StopMechanicalHalfWidth

Definition:

double ZOSAPI.Tools.IConvertToNSCGroup.StopMechanicalHalfWidth

Return type: double

Property OverfillFactor

Definition:

double ZOSAPI.Tools.IConvertToNSCGroup.OverfillFactor

Return type: double

Property StopObjectNumber

Definition:

int ZOSAPI.Tools.IConvertToNSCGroup.StopObjectNumber

Return type: int

Property StopObjectFace

Definition:

int ZOSAPI.Tools.IConvertToNSCGroup.StopObjectFace

Return type: int

Property HighFidelityConversion

Definition:

bool ZOSAPI.Tools.IConvertToNSCGroup.HighFidelityConversion

If true, any sequential surfaces that convert to grid sag representations will use bicubic interpolation instead of linear and the resolution will be set to the value specified in HighFidelityResolution.

Return type: bool

Property HighFidelityResolution

Definition:

SampleSizes_Pow2Plus1_X ZOSAPI.Tools.IConvertToNSCGroup.HighFidelityResolution

IF HighFidelityConversion is set to true, this sets the resolution used in the Grid Sag surface after conversion (up to 4097x4097).

Return type: SampleSizes_Pow2Plus1_X