dtmm.wave¶
Wave creation and wave characterization functions.
Module Contents¶
-
dtmm.wave.betaphi(shape, k0, out=None)¶ Returns beta and phi arrays of all possible plane eigenwaves.
- Parameters
shape ((int,int)) – Shape of the plane eigenwave.
k0 (float) – Wavenumber in pixel units.
out ((ndarray, ndarray), optional) – Output arrays tuple
- Returns
beta, phi arrays
- Return type
array, array
-
dtmm.wave.betaxy(shape, k0, out=None)¶ Returns betax, betay arrays of plane eigenwaves.
- Parameters
shape ((int,int)) – Shape of the plane eigenwave.
k0 (float) – Wavenumber in pixel units.
out ((ndarray, ndarray), optional) – Output arrays tuple
- Returns
beta, phi arrays
- Return type
array, array
-
dtmm.wave.k0(wavelength, pixelsize=1.0)¶ Calculate wave number in vacuum from a given wavelength and pixelsize
- Parameters
wavelength (float or array of floats) – Wavelength in nm
pixelsize (float) – Pixelsize in nm
- Returns
Wavenumber array
- Return type
array
-
dtmm.wave.wavelengths(start=380, stop=780, count=9)¶ Raturns wavelengths (in nanometers) equaly spaced in wavenumbers between start and stop.
- Parameters
start (float) – First wavelength
stop (float) – Last wavelength
count (int) – How many wavelengths
- Returns
out – A wavelength array
- Return type
ndarray
-
dtmm.wave.eigenwave(shape, i, j, amplitude=None, out=None)¶ Returns a planewave with a given fourier coefficient indices i and j.
- Parameters
shape ((int,int)) – Shape of the plane eigenwave.
i (int) – i-th index of the fourier coefficient
j (float) – j-th index of the fourier coefficient
amplitude (complex) – Amplitude of the fourier mode.
out (ndarray, optional) – Output array
- Returns
Plane wave array.
- Return type
array
-
dtmm.wave.planewave(shape, k0, beta, phi, out=None)¶ Returns a 2D planewave array with a given beta, phi, wave number k0.
- Parameters
shape ((int,int)) – Shape of the plane eigenwave.
k0 (float or array of floats) – Wavenumbers in pixel units.
beta (float) – Beta parameter of the plane wave
phi (float) – Phi parameter of the plane wave
out ((ndarray, ndarray), optional) – Output arrays tuple
- Returns
Plane wave array.
- Return type
array