bandpass_filter#

sunkit_image.trace.bandpass_filter(image, nsm1=1, nsm2=3)[source]#

Applies a band pass filter to the image.

Parameters:

image (numpy.ndarray, sunpy.map.GenericMap) – Image to be filtered.
nsm1 (int) – Low pass filter boxcar smoothing constant. Defaults to 1.
nsm2 (int) – High pass filter boxcar smoothing constant. The value of nsm2 equal to nsm1 + 1 gives the best enhancement. Defaults to 3.

Returns:

numpy.ndarray – Bandpass filtered image. If a map is input, a map is returned with new data and the same metadata.