Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceDirApodSampled

 

GetSourceDirApodSampled

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the power data from a source with a "Sampled as a function of spherical angles" power direction apodization type.

 

Syntax

success = GetSourceDirApodSampled ( n, data, dirXX, dirXY, dirXZ, dirZX, dirZY, dirZZ )

 

Parameters

success (Boolean)

Indicates if the function succeeded (True) or failed (False).

 

n As Long

Node number of the source.

 

data() As Double

Returns an array of polar angles, azimuth angles, and apodization values.  See the Remarks section.

 

dirXX As Double

Returns the X component of the azimuth axis direction vector.

 

dirXY As Double

Returns the Y component of the azimuth axis direction vector.

 

dirXZ As Double

Returns the Z component of the azimuth axis direction vector.

 

dirZX As Double

Returns the X component of the polar axis direction vector.

 

dirZY As Double

Returns the Y component of the polar axis direction vector.

 

dirZZ As Double

Returns the Z component of the polar axis direction vector.

 

Remarks

This function retrieves the power data from a source with a "Sampled as a function of spherical angles" power direction apodization type. If there is a problem the function returns False and does not set an error.

 

The first column of data is the polar angles (degrees).  The first row is the azimuthal angles (degrees).  The remainder of the array is the apodization values at the corresponding polar and azimuthal angles.

 

See Also

IsSourceDirApodSampled

SetSourceDirApodSampled

 

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC