ZOS-API interface 2024 R1

ZOSAPI.Editors.NCE.INCESourcesData Interface Reference

Last update: 17.07.2025

Object properties Sources tab. This interface can be accessed via the INCERow interface. More...

Properties

bool IsSourcesAvailable [get]
 
bool RandomPolarization [get, set]
 
double InitialPhaseDeg [get, set]
 
double CoherenceLength [get, set]
 
double Jx [get, set]
 
double Jy [get, set]
 
double XPhase [get, set]
 
double YPhase [get, set]
 
bool ReverseRays [get, set]
 
double PrePropagation [get, set]
 
SourceBulkScatterMode BulkScatter [get, set]
 
SourceSamplingMethod SamplingMethod [get, set]
 
ArrayMode ArrayType [get, set]
 
int ArrayNumberX [get, set]
 
int ArrayNumberY [get, set]
 
double ArraySpacingX [get, set]
 
double ArraySpacingY [get, set]
 
int ArrayNumber [get, set]
 
double ArrayRadius [get, set]
 
int ArrayRings [get, set]
 
double ArraySpacing [get, set]
 
SourceColorMode SourceColor [get, set]
 
ISourceColorSettings SourceColorSettings [get]
 

Detailed Description

Object properties Sources tab. This interface can be accessed via the INCERow interface.

Usage (see Example 21 for a full sample)

C#

// Edit source data of object 1
// SourcesData includes all the settings in Object Properties > Sources
Object_1.SourcesData.PrePropagation = -0.2;
Object_1.SourcesData.ArrayType = ArrayMode.Rectangular;
Object_1.SourcesData.ArrayNumberX = 5;
Object_1.SourcesData.ArrayNumberY = 5;
ZOSAPI.Editors.NCE.ArrayMode
ArrayMode
Definition: InterfacesNCE.cs:5827

C++

// Edit source data of object 1
// SourcesData includes all the settings in Object Properties > Sources
Object_1->SourcesData->PrePropagation = -0.2;
Object_1->SourcesData->ArrayType = ArrayMode_Rectangular;
Object_1->SourcesData->ArrayNumberX = 5;
Object_1->SourcesData->ArrayNumberY = 5;

Matlab

% Edit source data of object 1
% SourcesData includes all the settings in Object Properties > Sources
Object_1.SourcesData.PrePropagation = -0.2;
Object_1.SourcesData.ArrayType = ZOSAPI.Editors.NCE.ArrayMode.Rectangular;
Object_1.SourcesData.ArrayNumberX = 5;
Object_1.SourcesData.ArrayNumberY = 5;
ZOSAPI.Editors.NCE
Definition: InterfacesNCE.cs:19
ZOSAPI.Editors
Definition: InterfacesEditors.cs:12
ZOSAPI
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

Python

# Edit source data of object 1
# SourcesData includes all the settings in Object Properties > Sources
Object_1.SourcesData.PrePropagation = -0.2
Object_1.SourcesData.ArrayType = ZOSAPI.Editors.NCE.ArrayMode.Rectangular
Object_1.SourcesData.ArrayNumberX = 5
Object_1.SourcesData.ArrayNumberY = 5

Property Documentation

◆ ArrayNumber

int ZOSAPI.Editors.NCE.INCESourcesData.ArrayNumber
getset

◆ ArrayNumberX

int ZOSAPI.Editors.NCE.INCESourcesData.ArrayNumberX
getset

◆ ArrayNumberY

int ZOSAPI.Editors.NCE.INCESourcesData.ArrayNumberY
getset

◆ ArrayRadius

double ZOSAPI.Editors.NCE.INCESourcesData.ArrayRadius
getset

◆ ArrayRings

int ZOSAPI.Editors.NCE.INCESourcesData.ArrayRings
getset

◆ ArraySpacing

double ZOSAPI.Editors.NCE.INCESourcesData.ArraySpacing
getset

◆ ArraySpacingX

double ZOSAPI.Editors.NCE.INCESourcesData.ArraySpacingX
getset

◆ ArraySpacingY

double ZOSAPI.Editors.NCE.INCESourcesData.ArraySpacingY
getset

◆ ArrayType

ArrayMode ZOSAPI.Editors.NCE.INCESourcesData.ArrayType
getset

◆ BulkScatter

SourceBulkScatterMode ZOSAPI.Editors.NCE.INCESourcesData.BulkScatter
getset

◆ CoherenceLength

double ZOSAPI.Editors.NCE.INCESourcesData.CoherenceLength
getset

◆ InitialPhaseDeg

double ZOSAPI.Editors.NCE.INCESourcesData.InitialPhaseDeg
getset

◆ IsSourcesAvailable

bool ZOSAPI.Editors.NCE.INCESourcesData.IsSourcesAvailable
get

◆ Jx

double ZOSAPI.Editors.NCE.INCESourcesData.Jx
getset

◆ Jy

double ZOSAPI.Editors.NCE.INCESourcesData.Jy
getset

◆ PrePropagation

double ZOSAPI.Editors.NCE.INCESourcesData.PrePropagation
getset

◆ RandomPolarization

bool ZOSAPI.Editors.NCE.INCESourcesData.RandomPolarization
getset

◆ ReverseRays

bool ZOSAPI.Editors.NCE.INCESourcesData.ReverseRays
getset

◆ SamplingMethod

SourceSamplingMethod ZOSAPI.Editors.NCE.INCESourcesData.SamplingMethod
getset

◆ SourceColor

SourceColorMode ZOSAPI.Editors.NCE.INCESourcesData.SourceColor
getset

Usage (see Example 25 for a full sample)

C#

// Changes sourcecolor to Blackbody, sets temperature, min/ max wavelength
o1.SourcesData.SourceColor = ZOSAPI.Editors.NCE.SourceColorMode.BlackBodySpectrum;
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.TemperatureK = 6000;
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthFrom = 0.45;
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthTo = 0.65;

C++

// Changes sourcecolor to Blackbody, sets temperature, min / max wavelength
o1->SourcesData->SourceColor = SourceColorMode_BlackBodySpectrum;
o1->SourcesData->SourceColorSettings->_S_BlackBodySpectrum->TemperatureK = 6000;
o1->SourcesData->SourceColorSettings->_S_BlackBodySpectrum->WavelengthFrom = 0.45;
o1->SourcesData->SourceColorSettings->_S_BlackBodySpectrum->WavelengthTo = 0.65;

Matlab

% Changes sourcecolor to Blackbody, sets temperature, min/max wavelength
o1.SourcesData.SourceColor = ZOSAPI.Editors.NCE.SourceColorMode.BlackBodySpectrum;
o1.SourcesData.SourceColorSettings.TemperatureK = 6000;
o1.SourcesData.SourceColorSettings.WavelengthFrom = 0.45;
o1.SourcesData.SourceColorSettings.WavelengthTo = 0.65;

Python

# Changes sourcecolor to Blackbody, sets temperature, min/max wavelength
o1.SourcesData.SourceColor = ZOSAPI.Editors.NCE.SourceColorMode.BlackBodySpectrum
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.TemperatureK = 6000
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthFrom = 0.45
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthTo = 0.65

◆ SourceColorSettings

ISourceColorSettings ZOSAPI.Editors.NCE.INCESourcesData.SourceColorSettings
get

Usage (see Example 25 for a full sample)

C#

// Changes sourcecolor to Blackbody, sets temperature, min/ max wavelength
o1.SourcesData.SourceColor = ZOSAPI.Editors.NCE.SourceColorMode.BlackBodySpectrum;
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.TemperatureK = 6000;
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthFrom = 0.45;
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthTo = 0.65;

C++

// Changes sourcecolor to Blackbody, sets temperature, min / max wavelength
o1->SourcesData->SourceColor = SourceColorMode_BlackBodySpectrum;
o1->SourcesData->SourceColorSettings->_S_BlackBodySpectrum->TemperatureK = 6000;
o1->SourcesData->SourceColorSettings->_S_BlackBodySpectrum->WavelengthFrom = 0.45;
o1->SourcesData->SourceColorSettings->_S_BlackBodySpectrum->WavelengthTo = 0.65;

Matlab

% Changes sourcecolor to Blackbody, sets temperature, min/max wavelength
o1.SourcesData.SourceColor = ZOSAPI.Editors.NCE.SourceColorMode.BlackBodySpectrum;
o1.SourcesData.SourceColorSettings.TemperatureK = 6000;
o1.SourcesData.SourceColorSettings.WavelengthFrom = 0.45;
o1.SourcesData.SourceColorSettings.WavelengthTo = 0.65;

Python

# Changes sourcecolor to Blackbody, sets temperature, min/max wavelength
o1.SourcesData.SourceColor = ZOSAPI.Editors.NCE.SourceColorMode.BlackBodySpectrum
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.TemperatureK = 6000
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthFrom = 0.45
o1.SourcesData.SourceColorSettings._S_BlackBodySpectrum.WavelengthTo = 0.65

◆ XPhase

double ZOSAPI.Editors.NCE.INCESourcesData.XPhase
getset

◆ YPhase

double ZOSAPI.Editors.NCE.INCESourcesData.YPhase
getset

Connect with Ansys