PyPO User Manual
BindCPU.py File Reference

Bindings for the ctypes interface for PyPO. More...

Functions

def PyPO.BindCPU.loadCPUlib ()
 Load the PyPOcpu shared library. More...
 
def PyPO.BindCPU.PyPO_CPUd (source, target, runPODict)
 Perform a PO propagation on the CPU. More...
 
def PyPO.BindCPU.RT_CPUd (runRTDict)
 Perform an RT propagation on the CPU. More...
 

Detailed Description

Bindings for the ctypes interface for PyPO.

These bindings are concerned with propagations for the ray-tracer and the physical optics on the CPU.

Function Documentation

◆ loadCPUlib()

def PyPO.BindCPU.loadCPUlib ( )

Load the PyPOcpu shared library.

Will detect the operating system and link the library accordingly.

Returns
lib The ctypes library containing the C/C++ functions.

◆ PyPO_CPUd()

def PyPO.BindCPU.PyPO_CPUd (   source,
  target,
  runPODict 
)

Perform a PO propagation on the CPU.

Note that the calculations are always done in double precision for the CPU. Depending on the 'mode' parameter in the runPODict, this function returns different objects. Please see the dictionary templates for an overview.

Parameters
sourceA reflDict dictionary of the surface on which the source currents/scalarfields are defined.
targetA reflDict dictionary of the target surface on which the results are calculated.
runPODictA runPODict dictionary containing the relevant propagation parameters.
See also
runPODict

◆ RT_CPUd()

def PyPO.BindCPU.RT_CPUd (   runRTDict)

Perform an RT propagation on the CPU.

Note that the calculations are always done in double precision for the CPU.

Parameters
runRTDictA runRTDict dictionary containing the relevant propagation parameters.
See also
runRTDict