Description This data structure is used to specify the ray direction specification of the type "M Squared Laser Beam".
Definition Type T_SOURCEDIRM2LASER angleType As String M2x As Double M2y AsDouble numX As Long numY As Long semiAngX As Double semiAngY As Double semiWidX As Double semiWidY As Double
Members angleType As String Specifies the meaning of semiAngX and semiAngY. Valid entries are: "Full width at half power" "Half width at half power" "Full width at 1/e amplitude point" "Half width at 1/e amplitude point" "Full width at 1/e^2 power point" "Half width at 1/e^2 power point" "Full width at 1% power point" "Half width at 1% power point" "Variance power full width (second moment)" "Variance power half width (second moment)"
M2x As Double Specifies the m-squared value of the source in the X direction. Values must be between 1.0 and 5.0.
M2y As Double Specifies the m-squared value of the source in the Y direction. Values must be between 1.0 and 5.0.
numX As Long Number of sample points along the X direction of the beam. Recommended power of 2 between 4 and 2048 (inclusive).
numY As Long Number of sample points along the Y direction of the beam. Recommended power of 2 between 4 and 2048 (inclusive).
semiAngX As Double Half angle of the beam divergence in the X direction whose interpretation is specified by member angleType. Values between 0 and 90 in degrees.
semiAngY As Double Half angle of the beam divergence in the Y direction whose interpretation is specified by member angleType. Values between 0 and 90 in degrees.
semiWidX As Double RESERVED FOR FUTURE USE This member variable is reserved for future use and any value entered will be ignored. You can use -1 as the value here for clarity.
semiWidY As Double RESERVED FOR FUTURE USE This member variable is reserved for future use and any value entered will be ignored. You can use -1 as the value here for clarity.
Example The following example queries a source for its ray directions type and then gets, modifies and resets the M2 Laser Beam specification.
Sub Main
Dim srcNode As Long srcNode = FindFullName( "Optical Sources.Source 1" )
Dim tM2 As T_SOURCEDIRM2LASER InitSourceDirM2Laser( tM2 ) If IsSourceDirM2Laser( srcNode ) Then GetSourceDirM2Laser( srcNode, tM2 ) tM2.M2x = 2.1 tM2.M2y = 2.1 SetSourceDirM2Laser( srcNode, tM2 ) End If
End Sub
See Also
|