Line filter: Difference between revisions
Jump to navigation
Jump to search
imported>Neal (→Inputs) |
imported>Neal |
||
Line 28: | Line 28: | ||
* '''psf''': [ {'gaussian'} | 'box' | 'triangular'] Line shape or point source function (PSF) for filtering. | * '''psf''': [ {'gaussian'} | 'box' | 'triangular'] Line shape or point source function (PSF) for filtering. | ||
* '''conv''': [ {'convolve'} | 'deconvolve' ] Governs the algorithm and tells it to convolve with the point source function given in (options.psf) or deconvolve. If 'deconvolve', then (options.reg) is used. | |||
* '''reg''': {1e-6} regularization parameter (this parameter is used for ridging in the deconvolution algorithm). | |||
===See Also=== | ===See Also=== |
Revision as of 09:10, 17 March 2009
Purpose
Spectral filtering spectral filtering via convolution and deconvolution.
Synopsis
- xf = line_filter(x,win,options);
Description
Inputs
- x = MxN matrix of data of class 'double' or 'dataset'. If 'dataset' it must x.type=='data'. Each of the M rows are convolved with the linear filter given in (options.lineshape).
- win =
- 1) A scalar parameter corresponding to the analogous window width of the filter.
- options.psf =
- 'gaussian', (win) corresponds to the std in the Gaussian distribution.
- 'box', (win) is the half-width in number of channels.
- 'triangular', (win) is the half-width in channels.
- options.psf =
- 2) If (win) is 1xN vector, then it is used as the PSF and (options.psf) is ignored. The FFT of the PSF is calculated and used in the convolution or deconvolution algorithm.
Outputs
- xf = Filtered data of class 'dataset'.
Options
options = a structure array with the following fields:
- psf: [ {'gaussian'} | 'box' | 'triangular'] Line shape or point source function (PSF) for filtering.
- conv: [ {'convolve'} | 'deconvolve' ] Governs the algorithm and tells it to convolve with the point source function given in (options.psf) or deconvolve. If 'deconvolve', then (options.reg) is used.
- reg: {1e-6} regularization parameter (this parameter is used for ridging in the deconvolution algorithm).