Class GaussianBeam

source code

GaussianBeam class.

This class represents general astigmatic Gaussian beams in 3D space.
These are the objects that are intended to interact with the optical
components during the ray tracing and that are rendered in 3D thanks to
FreeCAD.

*=== Attributes ===*
BeamCount: class attribute, counts beams. [integer]
Name: class attribute. [string]
QTens: general astigmatic complex curvature tensor at the origin.
    [np. array of complex]
N: Refraction index of the medium in which the beam is placed. [float]
Wl: Wave-length in vacuum of the beam (frequency never changes). [float]
P: Power of the beam. [float]
Pos: Position in 3D space of the origin of the beam. [3D vector]
Dir: Normalized direction in 3D space of the beam axis. [3D vector]
U: A tuple of unitary vectors which along with Dir form a direct orthonormal
    basis in which the Q tensor is expressed. [tuple of 3D vectors]
Ref: Reference to the beam. [string]
OptDist: Optical length. [float]
Length: Geometrical length of the beam. [float]
StrayOrder: Number representing the *strayness* of the beam. If the beams
    results from a transmission on a HR surface or a reflection on a AR
    surface, then its StrayOrder is the StrayOrder of the parent beam + 1.
    [integer]
Optic: Ref of optic where the beam departs from ('Laser' if laser). [string]
Face: Face of the optic where the beam departs from. [string]
TargetOptic: Ref of the optic where the beam terminates (None if open
    beam). [string]
TargetFace: Face of the target optic where the beam terminates. [string]
DWx: Distance of waist on X. [float]
DWy: Distance of waist on Y. [float]
Wx: Waist on X. [float]
Wy: Waist on Y. [float]
IWx: Width of beam on X at origin. [float]
IWy: Width of beam on Y at origin. [float]
TWx: Width of beam on X at target surface (None if open beam). [float]
TWy: Width of beam on Y at target surface (None if open beam).

Compute the complex parameters q1 and q2 and theta of beam.

What is implemented here is a straightforward calculation to extract
the q1, q2, and theta of the normal form of Q.

    Returns a tuple q1, q2, theta