Navigation: Scripting Reference Manual > Functions & Subroutines > GetSampledMaterial

 

GetSampledMaterial

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves a specified Sampled Material from the Materials list.

 

Syntax

GetSampledMaterial id, material, waves, reals, imags

 

Parameters

id As Long

Identifier for the Sampled Material.

 

material As T_SAMPLEDMATERIAL

Structure containing basic information for the sampled material.

 

waves() As Double

Array containing the wavelengths (in microns) of the sample points.

 

reals() As Double

Array containing the real refractive indicies of the sample points.

 

imags() As Double

Array containing the imaginary refractive indicies of the sample points.

 

Remarks

This subroutine retrieves a specific Sampled Material from the Materials list. If there is a problem, the subroutine posts an error and returns without modifying any of the parameters.

 

The imaginary component of the refractive index is directly proportional to the absorption (or gain) coefficient at the associated wavelength via the following formula: 

a = ( 4pk /l ) where  a is the absorption coefficient, l is the wavelength and k is the imaginary part of the refractive index at that wavelength. Absorption is specified with a positive value, no absorption is specified with a value of zero, and gain may be specified with a negative value.

 

 

See Also

T_SAMPLEDMATERIAL

AddSampledMaterial

SetSampledMaterial

Examples

Materials

 

 

 

 

 

 

Copyright © Photon Engineering, LLC