Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
regions: `~specutils.utils.SpectralRegion` or list of `~specutils.utils.SpectralRegion`
Region within the spectrum to calculate the FWHM value. If regions is
`None`, computation is performed over entire spectrum.
Returns
-------
gaussian_fwhm : `~astropy.units.Quantity` or list (based on region input)
Approximate full width of the signal at half max
Notes
-----
The spectrum should be continuum subtracted before being passed to this
function.
"""
return computation_wrapper(_compute_gaussian_fwhm, spectrum, regions)
regions: `~specutils.utils.SpectralRegion` or list of `~specutils.utils.SpectralRegion`
Region within the spectrum to calculate the FWZI value. If regions is
`None`, computation is performed over entire spectrum.
Returns
-------
`~astropy.units.Quantity` or list (based on region input)
Full width of the signal at zero intensity.
Notes
-----
The spectrum must be continuum subtracted before being passed to this
function.
"""
return computation_wrapper(_compute_fwzi, spectrum, regions)
regions: `~specutils.utils.SpectralRegion` or list of `~specutils.utils.SpectralRegion`
Region within the spectrum to calculate the FWHM value. If regions is
`None`, computation is performed over entire spectrum.
Returns
-------
whm : `~astropy.units.Quantity` or list (based on region input)
Full width of the signal at half max
Notes
-----
The spectrum should be continuum subtracted before being passed to this
function.
"""
return computation_wrapper(_compute_fwhm, spectrum, regions)
regions : `~specutils.SpectralRegion` or list of `~specutils.SpectralRegion`
Region within the spectrum to calculate the gaussian sigma width. If
regions is `None`, computation is performed over entire spectrum.
Returns
-------
flux : `~astropy.units.Quantity`
Flux in the provided spectrum (or regions). Unit isthe ``spectrum``'s'
``flux`` unit times ``spectral_axis`` unit.
Notes
-----
While the flux can be computed on any spectrum or region, it should be
continuum-subtracted to compute actual line fluxes.
"""
return computation_wrapper(_compute_line_flux, spectrum, regions)
regions: `~specutils.utils.SpectralRegion` or list of `~specutils.utils.SpectralRegion`
Region within the spectrum to calculate the gaussian sigma width. If
regions is `None`, computation is performed over entire spectrum.
Returns
-------
approx_sigma: `~astropy.units.Quantity` or list (based on region input)
Approximated sigma value of the spectrum
Notes
-----
The spectrum should be continuum subtracted before being passed to this
function.
"""
return computation_wrapper(_compute_gaussian_sigma_width, spectrum, regions)
Returns
-------
ew : `~astropy.units.Quantity`
Equivalent width calculation, in the same units as the ``spectrum``'s
``spectral_axis``.
Notes
-----
To do a standard equivalent width measurement, the ``spectrum`` should be
continuum-normalized to whatever ``continuum`` is before this function is
called.
"""
kwargs = dict(continuum=continuum)
return computation_wrapper(_compute_equivalent_width, spectrum, regions, **kwargs)