algorithms.kernel_smooth

Module: algorithms.kernel_smooth

Inheritance diagram for nipy.algorithms.kernel_smooth:

TODO

Class

LinearFilter

class nipy.algorithms.kernel_smooth.LinearFilter(coordmap, shape, fwhm=6.0, scale=1.0, location=0.0, cov=None)

Bases: object

A class to implement some FFT smoothers for Image objects. By default, this does a Gaussian kernel smooth. More choices would be better!

Methods

smooth

__init__(coordmap, shape, fwhm=6.0, scale=1.0, location=0.0, cov=None)

Parameters:

coordmap : TODO

TODO

fwhm : float

TODO

scale : float

TODO

location : float

TODO

smooth(inimage, clean=False, is_fft=False)

Parameters:

inimage : core.api.Image

The image to be smoothed

clean : bool

Should we call nan_to_num on the data before smoothing?

is_fft : bool

Has the data already been fft’d?

Returns:

Image

Functions

nipy.algorithms.kernel_smooth.fwhm2sigma(fwhm)

Convert a FWHM value to sigma in a Gaussian kernel.

Parameters:

fwhm : float

TODO

Returns:

float

nipy.algorithms.kernel_smooth.sigma2fwhm(sigma)

Convert a sigma in a Gaussian kernel to a FWHM value.

Parameters:sigma : float Returns:float