Package theia :: Package tree :: Module beamtree :: Class BeamTree
[hide private]
[frames] | no frames]

Class BeamTree

source code


BeamTree class.

A BeamTree is a binary tree which allows to keep track of the beams as they are traced throughout the optical setup. The Root of the tree is a Gaussian beam and the other attributes are the daughter trees and all the data of the interaction producing these with the Root beam

*=== Attributes ===* Name: class attribute, name of object. [string] Root: beam of this node of the tree. [GaussianBeam] T: beam resulting from the transmission of the Root beam. [BeamTree] R: beam resulting from the reflection of the Root beam. [BeamTree]

Instance Methods [hide private]
 
__init__(self, Root=None, T=None, R=None)
BeamTree initializer.
source code
 
__str__(self)
String representation of a BeamTree, for print(tree).
source code
 
lines(self)
Returns the list of lines necessary to print the object.
source code
 
beamList(self)
Returns the string representation the tree of beams.
source code
 
beamLines(self)
Returns the list of lines necessary to print the list of beams.
source code
 
numberOfBeams(self)
Return the total number of beams.
source code
 
outputLines(self)
Return the list of lines to write the output of simulation.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
  Name = 'BeamTree'
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, Root=None, T=None, R=None)
(Constructor)

source code 

BeamTree initializer.

Overrides: object.__init__

__str__(self)
(Informal representation operator)

source code 

String representation of a BeamTree, for print(tree).

Overrides: object.__str__