finesse.simulations.workspace.GouyFuncWrapper

Overview

class finesse.simulations.workspace.GouyFuncWrapper[source]

Bases: object

Helper class for wrapping a C fill function that can be referenced from Python by objects. This allows a direct C call to the function from other cdef functions.

Wraps a cdef for setting the gouy phase during a modal simulation.

Examples

Create a C function then wrap it using this class:

>>> cdef int c_set_gouy(ABCDWorkspace ptr_ws) noexcept:
>>>    cdef MirrorWorkspace ws = <MirrorWorkspace>ptr_ws
>>>    ...
>>>
>>> fill = GouyFuncWrapper.make_from_ptr(c_set_gouy)