Features#

Sigima provides a comprehensive suite of signal and image processing computational features organized into logical categories. This page provides an organized overview of all available computation functions with direct links to their API documentation.

Note

All computation functions are available in the sigima.proc module. The sigima.tools modules provide lower-level utility functions used internally by the proc functions.

Common Operations#

These operations are available for both signals and images with similar functionality.

Arithmetic Operations#

Signal Functions	Image Functions	Description
`addition`	`addition`	Add two signals/images
`difference`	`difference`	Subtract one signal/image from another
`product`	`product`	Multiply two signals/images
`division`	`division`	Divide one signal/image by another
`average`	`average`	Compute average of multiple signals/images
`standard_deviation`	`standard_deviation`	Compute standard deviation of multiple signals/images
`quadratic_difference`	`quadratic_difference`	Compute quadratic difference between signals/images
`arithmetic`	`arithmetic`	Generic arithmetic operations with parameters

Constant Operations#

Signal Functions	Image Functions	Description
`addition_constant`	`addition_constant`	Add a constant value to signal/image
`difference_constant`	`difference_constant`	Subtract a constant from signal/image
`product_constant`	`product_constant`	Multiply signal/image by a constant
`division_constant`	`division_constant`	Divide signal/image by a constant

Mathematical Operations#

Signal Functions	Image Functions	Description
`absolute`	`absolute`	Compute absolute value
`exp`	`exp`	Exponential function
`log10`	`log10`	Base-10 logarithm
`inverse`	`inverse`	Compute reciprocal
`real`	`real`	Extract real part of complex data
`imag`	`imag`	Extract imaginary part of complex data
`phase`	`phase`	Extract phase of complex data
`astype`	`astype`	Convert data type
`transpose`	`transpose`	Transpose coordinates/axes
N/A	`log10_z_plus_n`	Log10 with offset for zero handling

Signal-Specific Mathematical Operations#

Function	Description
`sqrt`	Square root
`power`	Raise to power
`to_cartesian`	Convert to Cartesian coordinates
`to_polar`	Convert to polar coordinates

Complex Number Operations#

Signal Functions	Image Functions	Description
`complex_from_real_imag`	`complex_from_real_imag`	Create complex data from real and imaginary parts
`complex_from_magnitude_phase`	`complex_from_magnitude_phase`	Create complex data from magnitude and phase

Fourier Analysis#

Signal Functions	Image Functions	Description
`fft`	`fft`	Fast Fourier Transform (1D/2D)
`ifft`	`ifft`	Inverse Fast Fourier Transform (1D/2D)
`magnitude_spectrum`	`magnitude_spectrum`	Magnitude spectrum
`phase_spectrum`	`phase_spectrum`	Phase spectrum
`psd`	`psd`	Power spectral density

Convolution Operations#

Signal Functions	Image Functions	Description
`convolution`	`convolution`	Convolution operation
`deconvolution`	`deconvolution`	Deconvolution operation

Filtering#

Signal Functions	Image Functions	Description
`gaussian_filter`	`gaussian_filter`	Gaussian smoothing filter
`moving_average`	`moving_average`	Moving average filter
`moving_median`	`moving_median`	Moving median filter
`wiener`	`wiener`	Wiener filter

Noise Addition#

Signal Functions	Image Functions	Description
`add_gaussian_noise`	`add_gaussian_noise`	Add Gaussian noise for testing
`add_poisson_noise`	`add_poisson_noise`	Add Poisson noise for testing
`add_uniform_noise`	`add_uniform_noise`	Add uniform noise for testing

Signal Conditioning#

Signal Functions	Image Functions	Description
`normalize`	`normalize`	Normalize amplitude/intensity values
`clip`	`clip`	Clip values to specified range
`offset_correction`	`offset_correction`	Remove DC offset/background

Region of Interest (ROI)#

Signal Functions	Image Functions	Description
`extract_roi`	`extract_roi`	Extract single ROI from data
`extract_rois`	`extract_rois`	Extract multiple ROIs from data

Calibration#

Signal Functions	Image Functions	Description
`calibration`	`calibration`	Apply coordinate system calibration

Signal Processing#

Array Operations#

Function	Description
`signals_to_image`	Convert signals to image representation

Frequency Filtering#

Function	Description
`lowpass`	Low-pass filter
`highpass`	High-pass filter
`bandpass`	Band-pass filter
`bandstop`	Band-stop filter
`frequency_filter`	Generic frequency filtering

Signal Conditioning & Processing#

Function	Description
`detrending`	Remove linear trend
`apply_window`	Apply windowing function
`resampling`	Resample signal
`interpolate`	Interpolate signal
`reverse_x`	Reverse x-axis order
`xy_mode`	Handle XY coordinate modes
`replace_x_by_other_y`	Replace X axis using another signal’s Y values
`zero_padding`	Zero-padding for signals

Signal Analysis#

Function	Description
`stats`	Statistical measurements
`histogram`	Compute signal histogram
`contrast`	Compute signal contrast
`derivative`	Compute signal derivative
`integral`	Compute signal integral
`sampling_rate_period`	Analyze sampling rate and period

Peak and Feature Detection#

Function	Description
`peak_detection`	Peak detection in signals
`bandwidth_3db`	3dB bandwidth measurement
`fwhm`	Full Width at Half Maximum
`fw1e2`	Full Width at 1/e²
`full_width_at_y`	Full width at custom level
`dynamic_parameters`	Dynamic range parameters
`x_at_y`	Find x-coordinates at given y-value
`y_at_x`	Find y-values at given x-coordinate
`x_at_minmax`	Find x-coordinates of extrema

Curve Fitting#

Function	Description
`linear_fit`	Linear regression
`polynomial_fit`	Polynomial fitting
`gaussian_fit`	Gaussian curve fitting
`lorentzian_fit`	Lorentzian curve fitting
`voigt_fit`	Voigt profile fitting
`twohalfgaussian_fit`	Two-half Gaussian fitting
`exponential_fit`	Exponential decay fitting
`piecewiseexponential_fit`	Piecewise exponential fitting
`sigmoid_fit`	Sigmoid curve fitting
`sinusoidal_fit`	Sinusoidal fitting
`planckian_fit`	Planckian (blackbody) fitting
`cdf_fit`	Cumulative distribution function fitting
`evaluate_fit`	Evaluate fitted function
`extract_fit_params`	Extract fitting parameters

Stability Analysis#

Function	Description
`allan_variance`	Allan variance
`allan_deviation`	Allan deviation
`modified_allan_variance`	Modified Allan variance
`overlapping_allan_variance`	Overlapping Allan variance
`hadamard_variance`	Hadamard variance
`time_deviation`	Time deviation
`total_variance`	Total variance

Pulse Analysis#

Function	Description
`extract_pulse_features`	Extract comprehensive pulse characteristics

Utility Functions#

Function	Description
`check_same_sample_rate`	Verify consistent sampling rates
`get_nyquist_frequency`	Calculate Nyquist frequency

Image Processing#

Geometry and Transformations#

Function	Description
`rotate`	Rotate image by arbitrary angle
`rotate90`	Rotate image 90° clockwise
`rotate270`	Rotate image 270° clockwise
`fliph`	Flip image horizontally
`flipv`	Flip image vertically
`translate`	Translate image by specified offset
`resize`	Resize image to specified dimensions
`resampling`	Resample image with different methods
`binning`	Reduce image size by binning pixels
`set_uniform_coords`	Set uniform coordinate system
`transformer`	Apply custom geometric transformations

Frequency Domain Filtering#

Function	Description
`butterworth`	Butterworth frequency filter
`gaussian_freq_filter`	Gaussian frequency filter

Edge Detection#

Function	Description
`sobel`	Sobel edge detector
`sobel_h`	Sobel horizontal edges
`sobel_v`	Sobel vertical edges
`scharr`	Scharr edge detector
`scharr_h`	Scharr horizontal edges
`scharr_v`	Scharr vertical edges
`prewitt`	Prewitt edge detector
`prewitt_h`	Prewitt horizontal edges
`prewitt_v`	Prewitt vertical edges
`farid`	Farid edge detector
`farid_h`	Farid horizontal edges
`farid_v`	Farid vertical edges
`roberts`	Roberts cross-gradient
`laplace`	Laplacian edge detector
`canny`	Canny edge detector

Feature Detection#

Function	Description
`blob_dog`	Blob detection using Difference of Gaussians
`blob_doh`	Blob detection using Determinant of Hessian
`blob_log`	Blob detection using Laplacian of Gaussians
`blob_opencv`	OpenCV-based blob detection
`peak_detection`	2D peak detection
`contour_shape`	Contour shape analysis
`hough_circle_peaks`	Circular Hough transform

Morphological Operations#

Function	Description
`erosion`	Morphological erosion
`dilation`	Morphological dilation
`opening`	Morphological opening
`closing`	Morphological closing
`white_tophat`	White top-hat transform
`black_tophat`	Black top-hat transform

Thresholding#

Function	Description
`threshold`	Manual threshold with custom value
`threshold_otsu`	Otsu’s thresholding
`threshold_li`	Li’s thresholding
`threshold_yen`	Yen’s thresholding
`threshold_triangle`	Triangle thresholding
`threshold_isodata`	Isodata thresholding
`threshold_mean`	Mean thresholding
`threshold_minimum`	Minimum thresholding

Exposure and Intensity Correction#

Function	Description
`histogram`	Compute image histogram
`equalize_hist`	Histogram equalization
`equalize_adapthist`	Adaptive histogram equalization
`adjust_gamma`	Gamma correction
`adjust_log`	Logarithmic adjustment
`adjust_sigmoid`	Sigmoid adjustment
`rescale_intensity`	Rescale intensity range
`flatfield`	Flat-field correction

Image Restoration#

Function	Description
`denoise_bilateral`	Bilateral denoising
`denoise_tv`	Total variation denoising
`denoise_wavelet`	Wavelet denoising
`denoise_tophat`	Top-Hat denoising
`erase`	Erase image regions

Preprocessing#

Function	Description
`zero_padding`	Zero-padding for images

Measurements and Analysis#

Function	Description
`centroid`	Compute image centroid
`enclosing_circle`	Find minimum enclosing circle
`stats`	Statistical measurements
`line_profile`	Extract profile along a line
`segment_profile`	Extract profile along a multi-segment line
`radial_profile`	Extract radial profile from center
`average_profile`	Average profile over region
`horizontal_projection`	Project image onto horizontal axis
`vertical_projection`	Project image onto vertical axis
`generate_image_grid_roi`	Generate grid of ROIs