API for pyspeckle package

pyspeckle.pyspeckle Module

Generate and analyze speckle patterns.

A port of the SimSpeckle collection of routines (by Duncan and Kirkpatrick) to track and analyze laser speckle.

Documentation and examples are available at <https://pyspeckle2.readthedocs.io>

Functions

create_exp_1D(M, mean, stdev, cl)	Generate an array of length M of values with exponential autocorrelation.
create_gaussian_1D(M, mean, stdev, cl)	Generate an array of length M of values with Gaussian autocorrelation.
autocorrelation(x)	Find the autocorrelation of a 1D array.
local_contrast_2D(x, kernel)	Calculate local (2D) spatial contrast and determine first-order statistics.
local_contrast_2D_plot(x, kernel)	Create a graph showing local and global spatial contrast.
create_Exponential(M, pix_per_speckle[, ...])	Generate an M x M polarized, fully-developed speckle irradiance pattern.
create_Rayleigh(N, pix_per_speckle[, alpha, ...])	Generate an M x M unpolarized speckle irradiance pattern.
statistics_plot(x[, initialize])	Plot the first and second-order statistics of a speckle pattern.
slice_plot(data, x, y, z[, initialize, ...])	Plot the x, y, and z slices of 3D data cube.
create_Exponential_3D(M, pix_per_speckle[, ...])	Generate an M x M x M polarized, fully-developed speckle irradiance pattern.
create_Rayleigh_3D(M, pix_per_speckle[, ...])	Generate an M x M x M unpolarized speckle irradiance pattern.