Home | Trees | Indices | Help |
|
---|
|
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] 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] Name: Name of the beam if any. [string] 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 (None if laser). [string] Face: face of the optic where the beam departs from. [string]
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
|
|
|||
BeamCount = 0
|
|
|||
Inherited from |
|
Beam initializer. This is the initializer used internally for beam creation, for user inputed beams, see class method userGaussianBeam. Returns a Gaussian beam with attributes as the parameters.
|
Constructor used for user inputed beams, separated from the class initializer because the internal state of a beam is very different from the input of this user-defined beam. Input parameters are processed to make arguments for the class contructor and then the corresponding beam is returned. |
String representation of the beam, when calling print(beam).
|
Compute the complex parameters q1 and q2 and theta of beam. Returns a dictionary with keys: '1': q1 [complex] '2': q2 [complex] 'theta': theta [float] |
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Thu Jun 8 15:38:14 2017 | http://epydoc.sourceforge.net |