Namespace Elements

Index

Functions

Functions

attenuator

attenuator(r?: number): Operator

- Defined in Elements.ts:34
An attenuator, or: neutral density filter

Parameters
- r: number = Math.SQRT1_2
  
  Amplitude attenuation factor. Intensity is changed by r^2. By default it absorbs 50% photons.
Returns Operator

beamSplitter

beamSplitter(angle: number, split?: number): Operator

- Defined in Elements.ts:70
A symmetric non-polarizing beam splitter. Think: a very thin slab of glass. 0: -, 45: /, 90: |, 135: \

angle
Angle in degrees, from -> CCW. Needs to be multiple of 45deg.

todo
CHECK reflection phase.

Parameters
- angle: number
- split: number = 0.5
Returns Operator
Operator with dimensions [dimDir, dimPol].

cornerCube

cornerCube(): Operator

- Defined in Elements.ts:86
A corner cube, from in all 4 directions. https://en.wikipedia.org/wiki/Corner_reflector

Returns Operator

faradayRotator

faradayRotator(angle: number, polarizationRotation?: number): Operator

- Defined in Elements.ts:125
Faraday rotator (for polarization rotation) https://en.wikipedia.org/wiki/Faraday_rotator

angle
Angle in degrees, from -> CCW. Needs to be multiple of 90. 0: ->, 45: ^, 90: <-, 135: v

Parameters
- angle: number
- polarizationRotation: number = 0.125
Returns Operator

generateOperator

generateOperator(cell: ICell): IXYOperator

- Defined in Elements.ts:246
Compute operators from the grid cells

Parameters
- cell: ICell
Returns IXYOperator
IXYOperator

generateOperators

generateOperators(cells: ICell[]): IXYOperator[]

- Defined in Elements.ts:261
Compute list of operators from the grid

Parameters
- cells: ICell[]
Returns IXYOperator[]
IXYOperator[] list

glassSlab

glassSlab(): Operator

- Defined in Elements.ts:48
A glass slab - delays phase by lambda/4.

Returns Operator

incoherentLightOperator

incoherentLightOperator(opDirPol: Operator): Operator

- Defined in Elements.ts:179
Turn operator from coherent, polarized light, to incoherent, non-polarized intensity.

Parameters
- opDirPol: Operator
  
  Operator with [direction,polarization] dimensions.
Returns Operator
Operator with real values and dimenson [direction].

mirror

mirror(angle: number): Operator

- Defined in Elements.ts:58
A both-sided mirror, from metal or any other optically denser medium. 0: -, 45: /, 90: |, 135: \

angle
Angle in degrees, from -> CCW. Needs to be multiple of 45deg.

Parameters
- angle: number
Returns Operator
Operator with dimensions [dimDir, dimPol].

phasePlate

phasePlate(rotation: number, phaseShift: number): Operator

- Defined in Elements.ts:153
A phase plate for linear polarization.

todo
Convention: modify this polarization, ortonogal, or some other way?

Parameters
- rotation: number
  
  Element rotation in degrees
- phaseShift: number
Returns Operator

polarizer

polarizer(angle: number): Operator

- Defined in Elements.ts:138
A linear polarizer.

todo
Check angle conventions.

Parameters
- angle: number
  
  In plane rotation, in degrees [0, 90, 180, 270], i.e | - | -.
Returns Operator

polarizingBeamsplitter

polarizingBeamsplitter(angle: number): Operator

- Defined in Elements.ts:109
A polarizing beam splitter. Think: a very thin slab of glass. 0: [/], 90: []

note
Changed convention from 45 and 135deg!

angle
Angle in degrees, from -> CCW. Needs to be 0 or 90, up to 180deg.

Parameters
- angle: number
Returns Operator
Operator with dimensions [dimDir, dimPol].

sugarSolution

sugarSolution(polarizationRotation?: number): Operator

- Defined in Elements.ts:25
Sugar solution (for polarization rotation)

Parameters
- polarizationRotation: number = 0.125
Returns Operator

vacuumJar

vacuumJar(): Operator

- Defined in Elements.ts:41
A vacuum jar - advances phase by lambda/4.

Returns Operator

Generated using TypeDoc