eradiate.spectral.response.make_gaussian

Contents

eradiate.spectral.response.make_gaussian#

eradiate.spectral.response.make_gaussian(wl_center, fwhm, cutoff=3.0, wl=None, wl_res=1.0, pad=False, normalize=True)[source]#

Generate a Gaussian spectral response function dataset from central wavelength and full width at half maximum values.

Parameters:
  • wl_center (quantity or float) – Central wavelength of the Gaussian distribution. If passed as a float, the value is interpreted as being given in nm.

  • fwhm (quantity or float) – Full width at half maximum of the Gaussian distribution. If passed as a float, the value is interpreted as being given in nm.

  • cutoff (float, default: 3.0) – Cut-off, in multiples of the standard deviation σ.

  • wl (quantity or array-like, optional) – Mesh used to evaluate the discretized distribution. If unset, a regular mesh with spacing given by wl_res is used. If passed as an array, the value is interpreted as being given in nm.

  • wl_res (quantity or float, optional) – Resolution of the automatic spectral mesh if relevant. If passed as a float, the value is interpreted as being given in nm.

  • pad (bool, default: False) – If True, pad SRF data with leading and trailing zeros.

  • normalize (bool, default: True) – If True, the generated SRF data is normalized to have a maximum equal to 1.

Returns:

Dataset – A dataset compliant with the Eradiate SRF format. The uncertainty variable is set to NaN.