Documentation

This page presents the different modules attached to the oscfar package. Some functions are quite useful and have also been given some aliases to access them faster. You can also access a list of parameters that have worked well so far on tested datasets:

best_params = {
    "guard_cells": 1,
    "train_cells": 8,
    "rank_k": 0.75,
    "threshold_factor": 0.9,
    "averaging": 2,
    "min_snr": 2,
    "baseline": 0.15,
}

This can be used like a **kwargs parameter for the OS-CFAR algorithms. Note that the minimum distance argument needs to be provided each time the algorithms are used.

General use methods

Alias Full link to function
oscfar.os_cfar oscfar.cfar.os_cfar_1d
vwindow_os_cfar oscfar.cfar.variable_window_os_cfar_indices

Filters

Alias Full link to function
baseline_filter oscfar.filters.remove_baseline_peaks
lowpass_filter oscfar.filters.lowpass_filter
highpass_filter oscfar.filters.highpass_filter
median_smoothing oscfar.filters.median_filter
mean_smoothing oscfar.filters.moving_average_filter
group_peaks oscfar.filters.find_representative_peaks
force_min_dist oscfar.filters.enforce_min_distance
check_snr oscfar.filters.verify_peaks_snr
force_max_extent oscfar.filters.filter_peaks_by_extent_1d

Gaussian functions

Alias Full link to function
multi_gaussian oscfar.gaussian_fit.sum_of_gaussians
multi_scattered_gaussian oscfar.gaussian_fit.sum_of_scattered_gaussians
grid_search_gaussian oscfar.gaussian_fit.find_best_multi_gaussian_fit

Utilities

Alias Full link to function
peaks oscfar.utils.Peaks
waterfall_axes oscfar.utils.WaterFallAxes
waterfall_grid oscfar.utils.WaterFallGrid
npz_reader oscfar.utils.npz_reader
npz_writer oscfar.utils.npz_writer

Table of contents