Interface ZOSAPI::Editors::NCE::IVMPS_PhotoluminscenceModel

Definition:

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;

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
    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+17;
    % Disable Mie Model
    Photo_setting.ConsiderMieScattering = false;

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

Inherits from:

• ZOSAPI.Editors.NCE.IVolumePhysicsModelSettings

Members

• _S_AngleScattering
• _S_DLLDefinedScattering
• _S_None
• _S_PhotoluminescenceModel
• AbsorptionFile
• AreSettingsValid
• BasicAlgorithm
• ConsiderMieScattering
• EfficiencySpectrum
• EmissionFile
• ExcitationFile
• ExtinctionCoefficient
• ExtinctionWavelength
• GetAvailableAbsorptionFiles
• GetAvailableEmissionFiles
• GetAvailableExcitationFiles
• GetAvailableQuantumYieldFiles
• IsValid
• MieMeanPath
• ParticleDensity
• ParticleIndex
• ParticleRadius
• PLDensity
• PLMeanPath
• QuantumYield
• Threshold
• Type
• UseMieDensity

Properties

Property AreSettingsValid

Definition:

bool ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.AreSettingsValid

Return type: bool

Property AbsorptionFile

Definition:

string ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.AbsorptionFile

Return type: string

Property EmissionFile

Definition:

string ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.EmissionFile

Return type: string

Property ExcitationFile

Definition:

string ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ExcitationFile

ExcitationFile parameter is no longer used - please use QuantumYield!

Return type: string

Property QuantumYield

Definition:

string ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.QuantumYield

Return type: string

Property ParticleIndex

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ParticleIndex

Return type: double

Property ParticleDensity

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ParticleDensity

Return type: double

Property ParticleRadius

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ParticleRadius

Return type: double

Property Threshold

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.Threshold

Return type: double

Property BasicAlgorithm

Definition:

bool ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.BasicAlgorithm

Return type: bool

Property PLMeanPath

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.PLMeanPath

PLMeanPath parameter is no longer used - please use ExtinctionCoefficient, ExtinctionWavelength and PLDensity instead!

Return type: double

Property UseMieDensity

Definition:

bool ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.UseMieDensity

Return type: bool

Property MieMeanPath

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.MieMeanPath

Return type: double

Property EfficiencySpectrum

Definition:

EfficiencySpectrumType ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.EfficiencySpectrum

Obsolete. EfficiencySpectrum always returns QuantumYield.

Return type: EfficiencySpectrumType

Property ExtinctionCoefficient

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ExtinctionCoefficient

Return type: double

Property ExtinctionWavelength

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ExtinctionWavelength

Return type: double

Property PLDensity

Definition:

double ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.PLDensity

Return type: double

Property ConsiderMieScattering

Definition:

bool ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.ConsiderMieScattering

Return type: bool

Public functions

Function GetAvailableAbsorptionFiles

string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableAbsorptionFiles()

Return type: string[]

Function GetAvailableEmissionFiles

string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableEmissionFiles()

Return type: string[]

Function GetAvailableExcitationFiles

string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableExcitationFiles()

ExcitationFile parameter is no longer used - please use QuantumYield!

Return type: string[]

Function GetAvailableQuantumYieldFiles

string[] ZOSAPI.Editors.NCE.IVMPS_PhotoluminscenceModel.GetAvailableQuantumYieldFiles()

Return type: string[]