convolution
index
/users/schrei_f/src/py4CAtS/lite/src/convolution.py

Convolution of monochromatic spectrum/spectra with Box, Triangle, Gaussian spectral response functions.

 
Functions
       
convolveBox(vGrid, yValues, hwhm=1.0, what='i', sample=1.0, wGrid=None)
Convolve spectra with a Box (rectangular) spectral response function.
 
ARGUMENTS:
----------
vGrid:     the wavenumber grid of the monochromatic (high resolution) spectra
yValues:   a rank-1 spectrum or rank-2 array (matrix) of spectra
hwhm:      half width of box
what:      type of spectra:  'i' or 'r' radiance or eff.height (default)
                             't'        transmission
                             'o'        optical depth (see note)
sample:    number of new grid points per hwhm (default 1.0)
wGrid:     new wavenumber grid (default None ==> set automatically;  when given, do NOT return it again)
 
RETURNS:
--------
wGrid:      new wavenumber grid  (only if set automatically!)
ySmoothed:  the spectrum/spectra convolved with a Gaussian with len(wGrid) spectral points.
 
NOTE:
-----
* In case of transmission, the convolution uses absorption = 1-transmission
* In case of optical depth, this is transformed to absorption = 1 - transmission = 1-exp(-od)
  before the convolution and transformed back afterwards
convolveGauss(vGrid, yValues, hwhm=1.0, what='i', nWidths=5.0, sample=4.0, wGrid=None)
Convolve spectra with a Gaussian spectral response function.
 
ARGUMENTS:
----------
vGrid:     the wavenumber grid of the monochromatic (high resolution) spectra
yValues:   a rank-1 spectrum or rank-2 array (matrix) of spectra
hwhm:      half width @ half maximum
what:      type of spectra:  'i' or 'r' radiance or eff.height (default)
                             't'        transmission
                             'o'        optical depth (see note)
nWidths:   left and right wing cutoff for Gauss response function in units of HWHM
sample:    number of new grid points per hwhm (default 4.0)
wGrid:     new wavenumber grid (default None ==> set automatically;  when given, do NOT return it again)
 
RETURNS:
--------
wGrid:      new wavenumber grid  (only if set automatically!)
ySmoothed:  the spectrum/spectra convolved with a Gaussian with len(wGrid) spectral points.
 
NOTE:
-----
* In case of transmission, the convoluti oon uses absorption = 1-transmission
* In case of optical depth, this is transformed to absorption = 1 - transmission = 1-exp(-od)
  before the convolution and transformed back afterwards
convolveTriangle(vGrid, yValues, hwhm=1.0, what='i', sample=2.0, wGrid=None)
Convolve spectra with a triangular spectral response function.
 
ARGUMENTS:
----------
vGrid:     the wavenumber grid of the monochromatic (high resolution) spectra
yValues:   a rank-1 spectrum or rank-2 array (matrix) of spectra
hwhm:      half width of triangle
what:      type of spectra:  'i' or 'r' radiance or eff.height (default)
                             't'        transmission
                             'o'        optical depth (see note)
sample:    number of new grid points per hwhm (default 2.0)
wGrid:     new wavenumber grid (default None ==> set automatically;  when given, do NOT return it again)
 
RETURNS:
--------
wGrid:      new wavenumber grid  (only if set automatically!)
ySmoothed:  the spectrum/spectra convolved with a Gaussian with len(wGrid) spectral points.
 
NOTE:
-----
* In case of transmission, the convolution uses absorption = 1-transmission
* In case of optical depth, this is transformed to absorption = 1 - transmission = 1-exp(-od)
  before the convolution and transformed back afterwards