Package theia :: Package optics :: Module beamsplitter :: Class BeamSplitter
[hide private]
[frames] | no frames]

Class BeamSplitter

source code




Beamsplitter class.

This class represents beam splitters composed of two faces (HR, AR)
and with a wedge angle. These are the objects with which the beams will
interact during the ray tracing. Please see the documentation for details
on the geometric construction of these optics.

Beam Splitters behave exactly like mirrors, except that:
    * The default values for transmittances and reflectivities are different
    * Beam splitters never increase the order upon interaction of beams.

Actions:
    * T on HR: 0
    * R on HR: 0
    * T on AR: 0
    * R on AR: 0

*=== Additional attributes with respect to the Optic class ===*

None

*=== Name ===*

BeamSplitter

**Note**: the curvature of any surface is positive for a concave surface
(coating inside the sphere).
Thus kurv*HRNorm/|kurv| always points to the center
of the sphere of the surface, as is the convention for the lineSurfInter of
geometry module. Same for AR.

*******     HRK > 0 and ARK > 0     *******           HRK > 0 and ARK < 0
 *****                               ********         and |ARK| > |HRK|
 H***A                               H*********A
 *****                               ********
*******                             *******

Nested Classes [hide private]

Inherited from component.SetupComponent: __metaclass__

Instance Methods [hide private]
 
__init__(self, Wedge=0.0, Alpha=0.0, X=0.0, Y=0.0, Z=0.0, Theta=1.57079632679, Phi=0.0, Diameter=0.1, HRr=0.5, HRt=0.5, ARr=0.1, ARt=0.9, HRK=0.0, ARK=0, Thickness=0.02, N=1.4585, KeepI=False, Ref=None)
BeamSplitter initializer.
source code
 
lines(self)
Returns the list of lines necessary to print the object.
source code

Inherited from optic.Optic: apexes, collision, geoCheck, hit, hitAR, hitHR, hitSide, isHit, isHitDics, translate

Inherited from component.SetupComponent: __str__

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

Class Variables [hide private]
  Name = 'BeamSplitter'
  __abstractmethods__ = frozenset([])

Inherited from optic.Optic: OptCount

Inherited from component.SetupComponent: SetupCount

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, Wedge=0.0, Alpha=0.0, X=0.0, Y=0.0, Z=0.0, Theta=1.57079632679, Phi=0.0, Diameter=0.1, HRr=0.5, HRt=0.5, ARr=0.1, ARt=0.9, HRK=0.0, ARK=0, Thickness=0.02, N=1.4585, KeepI=False, Ref=None)
(Constructor)

source code 

BeamSplitter initializer.

Parameters are the attributes.

Returns a beam splitter.

Overrides: object.__init__

lines(self)

source code 

Returns the list of lines necessary to print the object.

Overrides: component.SetupComponent.lines