ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel Interface Reference
Last update: 17.07.2025Volume Physics Model - Phosphors and Fluorescence. This interface can be accessed via the INCEVolumePhysicsData interface. More...
Inheritance diagram for ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel:
Public Member Functions | |
| string[] | GetAvailableAbsorptionFiles () |
| string[] | GetAvailableEmissionFiles () |
| string[] | GetAvailableExcitationFiles () |
| ExcitationFile parameter is no longer used - please use QuantumYield! | |
| string[] | GetAvailableQuantumYieldFiles () |
Properties | |
| bool | AreSettingsValid [get] |
| string | AbsorptionFile [get, set] |
| string | EmissionFile [get, set] |
| string | ExcitationFile [get, set] |
| ExcitationFile parameter is no longer used - please use QuantumYield! | |
| string | QuantumYield [get, set] |
| double | ParticleIndex [get, set] |
| double | ParticleDensity [get, set] |
| double | ParticleRadius [get, set] |
| double | Threshold [get, set] |
| bool | BasicAlgorithm [get, set] |
| double | PLMeanPath [get, set] |
| PLMeanPath parameter is no longer used - please use ExtinctionCoefficient, ExtinctionWavelength and PLDensity instead! | |
| bool | UseMieDensity [get, set] |
| double | MieMeanPath [get, set] |
| EfficiencySpectrumType | EfficiencySpectrum [get, set] |
| Obsolete. EfficiencySpectrum always returns QuantumYield. | |
| double | ExtinctionCoefficient [get, set] |
| double | ExtinctionWavelength [get, set] |
| double | PLDensity [get, set] |
| bool | ConsiderMieScattering [get, set] |
 Properties inherited from ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings | |
| VolumePhysicsModelType | Type [get] |
| bool | IsValid [get] |
| IVPMS_None | _S_None [get] |
| IVMPS_AngleScattering | _S_AngleScattering [get] |
| IVMPS_DLLDefinedScattering | _S_DLLDefinedScattering [get] |
| IVMPS_PhotoluminscenceModel | _S_PhotoluminescenceModel [get] |
Detailed Description
Volume Physics Model - Phosphors and Fluorescence. This interface can be accessed via the INCEVolumePhysicsData interface.
Usage (see Example 21 for a full sample)
C#
// Make object 3 a volume scattering material
// VolumePhysicsData includes all settings in Object Properties > VolumePhysics.
// Use Photoluminescence model
Object_3.VolumePhysicsData.Model = VolumePhysicsModelType.PhotoluminescenceModel;
IVMPS_PhotoluminscenceModel Photo_setting = Object_3.VolumePhysicsData.ModelSettings._S_PhotoluminescenceModel;
// Use Standard Model
Photo_setting.BasicAlgorithm = false;
// Set absorb, emission and quantum yield spectrum files
Photo_setting.AbsorptionFile = "_sample_3.ZAS";
Photo_setting.EmissionFile = "_sample_3.ZES";
Photo_setting.QuantumYield = "_sample_3.ZQE";
// Set efficiency spectrum to quantum yield
Photo_setting.EfficiencySpectrum = EfficiencySpectrumType.QuantumYield;
// Set photoluminescence parameters
Photo_setting.ExtinctionCoefficient = 1E+05;
Photo_setting.ExtinctionWavelength = 0.47;
Photo_setting.PLDensity = 3.1E+017;
// Set model to ignore mie scattering
Photo_setting.ConsiderMieScattering = false;
Volume Physics Model - Phosphors and Fluorescence. This interface can be accessed via the INCEVolumeP...
Definition: InterfacesNCE.cs:6699
string QuantumYield
Definition: InterfacesNCE.cs:6717
IVMPS_PhotoluminscenceModel _S_PhotoluminescenceModel
Definition: InterfacesNCE.cs:6593
C++
// Make object 3 a volume scattering material
// VolumePhysicsData includes all settings in Object Properties > VolumePhysics.
// Use Photoluminescence model
Object_3->VolumePhysicsData->Model = VolumePhysicsModelType_PhotoluminescenceModel;
IVMPS_PhotoluminscenceModelPtr Photo_setting = Object_3->VolumePhysicsData->ModelSettings->_S_PhotoluminescenceModel;
// Use standard algorithm
Photo_setting->BasicAlgorithm = false;
// Set absorb, emission and quantum yield files
Photo_setting->AbsorptionFile = "_sample_3.ZAS";
Photo_setting->EmissionFile = "_sample_3.ZES";
Photo_setting->QuantumYield = "_sample_3.ZQE";
// Set efficiency spectrum to quantum yield
Photo_setting->EfficiencySpectrum = EfficiencySpectrumType_QuantumYield;
// Set photoluminescence parameters
Photo_setting->ExtinctionCoefficient = 1e+05;
Photo_setting->ExtinctionWavelength = 0.47;
Photo_setting->PLDensity = 3.1e+017;
// Set model to ignore mie scattering
Photo_setting->ConsiderMieScattering = false;
Matlab
% Make object 3 a volume scattering material
% VolumePhysicsData includes all settings in Object Properties > VolumePhysics.
% Use Photoluminescence model
Object_3.VolumePhysicsData.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.PhotoluminescenceModel;
Photo_setting = Object_3.VolumePhysicsData.ModelSettings.S_PhotoluminescenceModel_;
% Use Standard algorithm
Photo_setting.BasicAlgorithm = false;
% Set absorption, emission and quantum yield files
Photo_setting.AbsorptionFile = '_sample_3.ZAS';
Photo_setting.EmissionFile = '_sample_3.ZES';
Photo_setting.QuantumYield = '_sample_3.ZQE';
% Set efficiency spectrum to quantum yield
% Set photoluminescence parameters
Photo_setting.ExtinctionCoefficient = 1E+05;
Photo_setting.ExtinctionWavelength = 0.47;
Photo_setting.PLDensity = 3.1E+17;
% Disable Mie Model
Photo_setting.ConsiderMieScattering = false;
Definition: InterfacesNCE.cs:19
Definition: InterfacesEditors.cs:12
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5
Python
# Make object 3 a volume scattering material
# VolumePhysicsData includes all settings in Object Properties > VolumePhysics.
# Use Photoluminescence model
Object_3.VolumePhysicsData.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.PhotoluminescenceModel
Photo_setting = Object_3.VolumePhysicsData.ModelSettings._S_PhotoluminescenceModel
# Use Standard Algorithm
Photo_setting.BasicAlgorithm = False
# Set absorption, emission and quantum yield files
Photo_setting.AbsorptionFile = '_sample_3.ZAS'
Photo_setting.EmissionFile = '_sample_3.ZES'
Photo_setting.QuantumYield = '_sample_3.ZQE'
# set efficiency spectrum to quantum yield
Photo_setting.EfficiencySpectrum = ZOSAPI.Editors.NCE.EfficiencySpectrumType.QuantumYield
# set photoluminescence parameters
Photo_setting.ExtinctionCoefficient = 1E+05
Photo_setting.ExtinctionWavelength = 0.47
Photo_setting.PLDensity = 3.1E+017
# Set Model to Ignore Mie Scattering
Photo_setting.ConsiderMieScattering = False
Member Function Documentation
◆ GetAvailableAbsorptionFiles()
| string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableAbsorptionFiles | ( | ) |
◆ GetAvailableEmissionFiles()
| string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableEmissionFiles | ( | ) |
◆ GetAvailableExcitationFiles()
| string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableExcitationFiles | ( | ) |
ExcitationFile parameter is no longer used - please use QuantumYield!
◆ GetAvailableQuantumYieldFiles()
| string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableQuantumYieldFiles | ( | ) |
Property Documentation
◆ AbsorptionFile
|
getset |
◆ AreSettingsValid
|
get |
◆ BasicAlgorithm
|
getset |
◆ ConsiderMieScattering
|
getset |
◆ EfficiencySpectrum
|
getset |
Obsolete. EfficiencySpectrum always returns QuantumYield.
◆ EmissionFile
|
getset |
◆ ExcitationFile
|
getset |
ExcitationFile parameter is no longer used - please use QuantumYield!
◆ ExtinctionCoefficient
|
getset |
◆ ExtinctionWavelength
|
getset |
◆ MieMeanPath
|
getset |
◆ ParticleDensity
|
getset |
◆ ParticleIndex
|
getset |
◆ ParticleRadius
|
getset |
◆ PLDensity
|
getset |
◆ PLMeanPath
|
getset |
PLMeanPath parameter is no longer used - please use ExtinctionCoefficient, ExtinctionWavelength and PLDensity instead!
◆ QuantumYield
|
getset |
◆ Threshold
|
getset |
◆ UseMieDensity
|
getset |
