Package theia :: Package optics :: Module special :: Class Special
[hide private]
[frames] | no frames]

Class Special

source code




Special class.

This class represents general optics, as their actions on R and T are left
to the user to input. They are useful for special optics which are neither
reflective nor transmissive.

Actions:
    * T on HR: user input
    * R on HR: user input
    * T on AR: user input
    * R on AR: user input

**Note**: by default the actions of these objects are those of
beamsplitters (0, 0, 0, 0)

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

None

*=== Name ===*

Special

**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.99, HRt=0.01, ARr=0.1, ARt=0.9, HRK=0.01, ARK=0, Thickness=0.02, N=1.4585, KeepI=False, RonHR=0, TonHR=0, RonAR=0, TonAR=0, Ref=None)
Special optic 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 = 'Special'
  __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.99, HRt=0.01, ARr=0.1, ARt=0.9, HRK=0.01, ARK=0, Thickness=0.02, N=1.4585, KeepI=False, RonHR=0, TonHR=0, RonAR=0, TonAR=0, Ref=None)
(Constructor)

source code 

Special optic initializer.

Parameters are the attributes.

Returns a special optic.

Overrides: object.__init__

lines(self)

source code 

Returns the list of lines necessary to print the object.

Overrides: component.SetupComponent.lines