Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 1.94 KB

Prop-Package.rst

File metadata and controls

97 lines (66 loc) · 1.94 KB

prop sub-package

+otslm.+tools.+prop

The otslm.tools.prop package contains classes for propagating the fields. For simple beam propagation, see +tools.visualise. This documentation contains information on the Propagator base class and the propagator sub-classes. The package contains additional base classes for the common code shared between the forward and inverse methods.

For most propagators there are three methods that can be used to create a new instance. The class constructor creates a new instance where you specify all the options. The simple and simpleProp static functions create an instance of the propagator from an input pattern and return an output image or propagator depending on the method.

Propagator base class

Propagator

Fft3Forward

Fft3Forward

Fft3Inverse

Fft3Inverse

FftEwaldForward

FftEwaldForward

FftEwaldInverse

FftEwaldInverse

FftForward

FftForward

FftInverse

FftInverse

FftDebyeForward

FftDebyeForward

OttForward

OttForward

Ott2Forward

Ott2Forward

RsForward

Warning

This method may be unstable.

RsForward