ZOS-API interface 2024 R1

ZOSAPI.SystemData.ISDApertureData Interface Reference

Last update: 17.07.2025

System Explorer - Aperture Data. This interface can be accessed via the ISystemData interface. More...

Properties

ZemaxApertureType ApertureType [get, set]
 
double ApertureValue [get, set]
 
ZemaxApodizationType ApodizationType [get, set]
 
double ApodizationFactor [get, set]
 
bool ApodizationFactorIsUsed [get]
 
double SemiDiameterMargin [get, set]
 
double SemiDiameterMarginPct [get, set]
 
ISurfaceSelection GCRS [get]
 
bool TelecentricObjectSpace [get, set]
 
bool AFocalImageSpace [get, set]
 
bool IterateSolvesWhenUpdating [get, set]
 
bool FastSemiDiameters [get, set]
 
bool CheckGRINApertures [get, set]
 

Detailed Description

System Explorer - Aperture Data. This interface can be accessed via the ISystemData interface.

Usage (see Example 15 for a full sample)

C#

//Define System Explorer
//Define Aperture
ISystemData SystExplorer = TheSystem.SystemData;
SystExplorer.Aperture.ApertureType = ZOSAPI.SystemData.ZemaxApertureType.EntrancePupilDiameter;
SystExplorer.Aperture.ApertureValue = 20;
ZOSAPI.SystemData.ISystemData
Interfaces and methods for changing all System Explorer data. This interface can be accessed via the ...
Definition: InterfacesSE.cs:275
ZOSAPI.SystemData
Definition: InterfacesSE.cs:11
ZOSAPI
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

C++

// Define System Explorer
// Define Aperture
ISystemDataPtr SystExplorer = TheSystem->SystemData;
SystExplorer->Aperture->ApertureType = ZemaxApertureType::ZemaxApertureType_EntrancePupilDiameter;
SystExplorer->Aperture->ApertureValue = 20;

Matlab

%Define System Explorer
%Define Aperture
SystExplorer = TheSystem.SystemData;
SystExplorer.Aperture.ApertureType = ZOSAPI.SystemData.ZemaxApertureType.EntrancePupilDiameter;
SystExplorer.Aperture.ApertureValue = 20;

Python

# Define System Explorer
# Define Aperture
SystExplorer = TheSystem.SystemData
SystExplorer.Aperture.ApertureType = ZOSAPI.SystemData.ZemaxApertureType.EntrancePupilDiameter
SystExplorer.Aperture.ApertureValue = 20

Property Documentation

◆ AFocalImageSpace

bool ZOSAPI.SystemData.ISDApertureData.AFocalImageSpace
getset

Usage (see Example 19 for a full sample)

C#

// ISystemData represents the System Explorer in GUI.
// We access options in System Explorer through ISystemData in ZOS-API
ISystemData TheSystemData = TheSystem.SystemData;
TheSystemData.Aperture.ApertureValue = 10;
TheSystemData.Aperture.AFocalImageSpace = true;
TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55;
ZOSAPI.SystemData.ISystemData.Wavelengths
IWavelengths Wavelengths
Definition: InterfacesSE.cs:277
ZOSAPI.SystemData.IWavelength.Wavelength
double Wavelength
Definition: InterfacesSE.cs:766
ZOSAPI.SystemData.IWavelengths.GetWavelength
IWavelength GetWavelength(int position)
Gets the specified wavelength."/>.

C++

// ISystemData represents the System Explorer in GUI.
// We access options in System Explorer through ISystemData in ZOS-API
ISystemDataPtr TheSystemData = TheSystem->SystemData;
TheSystemData->Aperture->ApertureValue = 10;
TheSystemData->Aperture->AFocalImageSpace = true;
TheSystemData->Wavelengths->GetWavelength(1)->Wavelength = 0.55;

Matlab

% ISystemData represents the System Explorer in GUI.
% We access options in System Explorer through ISystemData in ZOS-API
TheSystemData = TheSystem.SystemData;
TheSystemData.Aperture.ApertureValue = 10;
TheSystemData.Aperture.AFocalImageSpace = true;
TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55;

Python

# ISystemData represents the System Explorer in GUI.
# We access options in System Explorer through ISystemData in ZOS-API
TheSystemData = TheSystem.SystemData
TheSystemData.Aperture.ApertureValue = 10
TheSystemData.Aperture.AFocalImageSpace = True
TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55

◆ ApertureType

ZemaxApertureType ZOSAPI.SystemData.ISDApertureData.ApertureType
getset

Usage (see Example 15 for a full sample)

C#

//Define System Explorer
//Define Aperture
ISystemData SystExplorer = TheSystem.SystemData;
SystExplorer.Aperture.ApertureType = ZOSAPI.SystemData.ZemaxApertureType.EntrancePupilDiameter;
SystExplorer.Aperture.ApertureValue = 20;

C++

// Define System Explorer
// Define Aperture
ISystemDataPtr SystExplorer = TheSystem->SystemData;
SystExplorer->Aperture->ApertureType = ZemaxApertureType::ZemaxApertureType_EntrancePupilDiameter;
SystExplorer->Aperture->ApertureValue = 20;

Matlab

%Define System Explorer
%Define Aperture
SystExplorer = TheSystem.SystemData;
SystExplorer.Aperture.ApertureType = ZOSAPI.SystemData.ZemaxApertureType.EntrancePupilDiameter;
SystExplorer.Aperture.ApertureValue = 20;

Python

# Define System Explorer
# Define Aperture
SystExplorer = TheSystem.SystemData
SystExplorer.Aperture.ApertureType = ZOSAPI.SystemData.ZemaxApertureType.EntrancePupilDiameter
SystExplorer.Aperture.ApertureValue = 20

◆ ApertureValue

double ZOSAPI.SystemData.ISDApertureData.ApertureValue
getset

Usage (see Example 19 for a full sample)

C#

// ISystemData represents the System Explorer in GUI.
// We access options in System Explorer through ISystemData in ZOS-API
ISystemData TheSystemData = TheSystem.SystemData;
TheSystemData.Aperture.ApertureValue = 10;
TheSystemData.Aperture.AFocalImageSpace = true;
TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55;

C++

// ISystemData represents the System Explorer in GUI.
// We access options in System Explorer through ISystemData in ZOS-API
ISystemDataPtr TheSystemData = TheSystem->SystemData;
TheSystemData->Aperture->ApertureValue = 10;
TheSystemData->Aperture->AFocalImageSpace = true;
TheSystemData->Wavelengths->GetWavelength(1)->Wavelength = 0.55;

Matlab

% ISystemData represents the System Explorer in GUI.
% We access options in System Explorer through ISystemData in ZOS-API
TheSystemData = TheSystem.SystemData;
TheSystemData.Aperture.ApertureValue = 10;
TheSystemData.Aperture.AFocalImageSpace = true;
TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55;

Python

# ISystemData represents the System Explorer in GUI.
# We access options in System Explorer through ISystemData in ZOS-API
TheSystemData = TheSystem.SystemData
TheSystemData.Aperture.ApertureValue = 10
TheSystemData.Aperture.AFocalImageSpace = True
TheSystemData.Wavelengths.GetWavelength(1).Wavelength = 0.55

◆ ApodizationFactor

double ZOSAPI.SystemData.ISDApertureData.ApodizationFactor
getset

◆ ApodizationFactorIsUsed

bool ZOSAPI.SystemData.ISDApertureData.ApodizationFactorIsUsed
get

◆ ApodizationType

ZemaxApodizationType ZOSAPI.SystemData.ISDApertureData.ApodizationType
getset

Usage (see Example 11 for a full sample)

C#

// Changing System Explorer Settings
// Set Aperture
ISystemData TheSystemData = TheSystem.SystemData;
TheSystemData.Aperture.ApertureValue = 20;
TheSystem.SystemData.MaterialCatalogs.AddCatalog("SCHOTT");
// Set Apodization Type to Gaussian, and set apodization factor to 1
TheSystemData.Aperture.ApodizationType = ZemaxApodizationType.Gaussian;
TheSystemData.Aperture.ApodizationFactor = 1;
// Set Wavelength
TheSystemData.Wavelengths.SelectWavelengthPreset(WavelengthPreset.FdC_Visible);
ZOSAPI.SystemData.ISDMaterialCatalogData.AddCatalog
bool AddCatalog(string catalog)
Adds the specified material to the system.
ZOSAPI.SystemData.ISystemData.MaterialCatalogs
ISDMaterialCatalogData MaterialCatalogs
Definition: InterfacesSE.cs:283
ZOSAPI.SystemData.IWavelengths.SelectWavelengthPreset
bool SelectWavelengthPreset(WavelengthPreset preset)
Replaces all system wavelengths with a preset definition.
ZOSAPI.SystemData.WavelengthPreset
WavelengthPreset
Definition: InterfacesSE.cs:138
ZOSAPI.SystemData.ZemaxApodizationType
ZemaxApodizationType
Definition: InterfacesSE.cs:117

C++

// Changing System Explorer Settings
// Set Aperture
ISystemDataPtr TheSystemData = TheSystem->SystemData;
TheSystemData->Aperture->ApertureValue = 20;
ISDMaterialCatalogDataPtr(TheSystem->SystemData->MaterialCatalogs)->AddCatalog("SCHOTT");
// Set Apodization Type to Gaussian, and set apodization factor to 1
TheSystemData->Aperture->ApodizationType = ZemaxApodizationType_Gaussian;
TheSystemData->Aperture->ApodizationFactor = 1;
// Set Wavelength
TheSystemData->Wavelengths->SelectWavelengthPreset(WavelengthPreset_FdC_Visible);

Matlab

% Changing System Explorer Settings
% Set Aperture
TheSystemData = TheSystem.SystemData;
TheSystemData.Aperture.ApertureValue = 20;
TheSystem.SystemData.MaterialCatalogs.AddCatalog('SCHOTT');
% Set Apodization Type to Gaussian, and set apodization factor to 1
TheSystemData.Aperture.ApodizationType = ZOSAPI.SystemData.ZemaxApodizationType.Gaussian;
TheSystemData.Aperture.ApodizationFactor = 1;
% Set Wavelength
TheSystemData.Wavelengths.SelectWavelengthPreset(ZOSAPI.SystemData.WavelengthPreset.FdC_Visible);

Python

# Changing System Explorer Settings
# Set Aperture
TheSystemData = TheSystem.SystemData
TheSystemData.Aperture.ApertureValue = 20
TheSystem.SystemData.MaterialCatalogs.AddCatalog('SCHOTT')
# Set Apodization Type to Gaussian, and set apodization factor to 1
TheSystemData.Aperture.ApodizationType = 1 # ApodizationType 0 = uniform; 1 = gaussian; 2 = Cosine Cubed
TheSystemData.Aperture.ApodizationFactor = 1
# Set Wavelength
TheSystemData.Wavelengths.SelectWavelengthPreset(ZOSAPI.SystemData.WavelengthPreset.FdC_Visible)

◆ CheckGRINApertures

bool ZOSAPI.SystemData.ISDApertureData.CheckGRINApertures
getset

◆ FastSemiDiameters

bool ZOSAPI.SystemData.ISDApertureData.FastSemiDiameters
getset

◆ GCRS

ISurfaceSelection ZOSAPI.SystemData.ISDApertureData.GCRS
get

◆ IterateSolvesWhenUpdating

bool ZOSAPI.SystemData.ISDApertureData.IterateSolvesWhenUpdating
getset

◆ SemiDiameterMargin

double ZOSAPI.SystemData.ISDApertureData.SemiDiameterMargin
getset

◆ SemiDiameterMarginPct

double ZOSAPI.SystemData.ISDApertureData.SemiDiameterMarginPct
getset

◆ TelecentricObjectSpace

bool ZOSAPI.SystemData.ISDApertureData.TelecentricObjectSpace
getset

Connect with Ansys