smooth_circular¶
-
metpy.calc.smooth_circular(scalar_grid, radius, passes=1)[source]¶ Filter with a circular window smoother.
- Parameters
scalar_grid (array-like) – N-dimensional scalar grid to be smoothed. If more than two axes, smoothing is only done along the last two.
radius (int) – Radius of the circular smoothing window. The “diameter” of the circle (width of smoothing window) is 2 * radius + 1 to provide a smoothing window with odd shape.
passes (int) – The number of times to apply the filter to the grid. Defaults to 1.
- Returns
array-like – The filtered scalar grid
Notes
This function can be applied multiple times to create a more smoothed field and will only smooth the interior points, leaving the end points with their original values (this function will leave an unsmoothed edge of size radius around the data). If a masked value or NaN values exists in the array, it will propagate to any point that uses that particular grid point in the smoothing calculation. Applying the smoothing function multiple times will propogate NaNs further throughout the domain.
See also
smooth_window,smooth_rectangular,smooth_n_point,smooth_gaussian
