Navigation: Scripting Reference Manual > Functions & Subroutines > SetSampledMaterial

 

SetSampledMaterial

 

Contact Us: fredsupport@photonengr.com

 

Description

Sets the parameters of a specified glass Sampled Material in the associated FRED document.

 

Syntax

SetSampledMaterial id, material, waves, reals, imags

 

Parameters

id As Long

Identifier for the material.

 

material As T_SAMPLEDMATERIAL

Structure containing the new data for the Sampled Material.

 

waves() As Double

1D Array containing the wavelength (in microns) sample points for the Sampled Material.

 

reals() As Double

1D Array containing the real refractive indexes for the wavelength sample points.

 

imags() As Double

1D Array containing the imaginary components of the refractive indexes for the wavelength sample points.

 

Remarks

This subroutine sets the parameters of a specified glass Sampled Material in the associated FRED document.  If there is a problem, the subroutine posts an error and returns without modifying the Sampled Material.

 

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 = ( 4p k / 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

GetSampledMaterial

Examples

Materials

 

 

 

 

 

Copyright © Photon Engineering, LLC