Navigation: Scripting Reference Manual > Functions & Subroutines > CreateRaysFromVectorField

 

CreateRaysFromVectorField

 

Contact Us: fredsupport@photonengr.com

 

Description

Creates a rayset by Gabor synthesis from the specified arrays containing real and imaginary components using settings from the T_SYNTH_RAYS_FROM_FIELD structure.  The synthesized rayset will propagate along the +Z axis of the associated analysis grid.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

count = CreateRaysFromVectorField( nCoordSys, ana, Xreal, Ximag, Yreal, Yimag, raysynth, wave )

 

Parameters

count (Long or Huge_)

Number of rays used in Vector Field calculation.

 

nCoordSys As Long

Node number of the FRED entity whose coordinate system the ana structure is expressed in.

 

ana As T_ANALYSIS

T_ANALYSIS structure used to define a planar sample area over which the calculation will be performed.

 

Xreal() As Double

Array to be loaded with the real part of the X-component of vector wave field.

 

Ximag() As Double

Array to be loaded with the imaginary part of the X-component of the vector wave field.

 

Yreal() As Double

Array to be loaded with the real part of the Y-component of the vector wave field.

 

Yimag() As Double

Array to be loaded with the imaginary part of the Y-component of the vector wave field.

 

raysynth As T_SYNTH_RAYS_FROM_FIELD

Structure containing Gabor synthesis settings.

 

wave As Double

Wavelength (in microns) of field to be synthesized.

 

Remarks

Creates a rayset by Gabor synthesis from the specified arrays containing real and imaginary components using settings from the T_SYNTH_RAYS_FROM_FIELD structure.

 

Rays created by this method are added directly to the ray buffer with a default Append operation. If the intent is to replace existing rays with the newly created ones, simply issue a DeleteRays command prior to ray creation.

 

See Also

ScalarField

VectorField

ScalarFieldToFile

VectorFieldToFile

CreateRaysFromScalarField

CreateRaysFromScalarFieldFile

CreateRaysFromVectorFieldFile

ClipFieldInFile

T_SYNTH_RAYS_FROM_FIELD

Irradiance

Intensity

EnergyDensity

T_ANALYSIS

LoadAnalysis

SetAnalysisParameters

 

 

 

 

 

Copyright © Photon Engineering, LLC