vunits.convert.freq_to_wavenumber¶
-
vunits.convert.
freq_to_wavenumber
(freq, units_in='Hz', return_quantity=False, units_out='cm-1')¶ Converts frequency to wavenumber
- Parameters
freq (float) – Frequency
units_in (str, optional) – Units corresponding to
freq
. Default is ‘Hz’.return_quantity (bool, optional) – If True, returns
Quantity
. Otherwise, returns float.units_out (str, optional) – Units corresponding to
wavenumber
. Default is ‘cm-1’.
- Returns
wavenumber – Wavenumber corresponding to
units_out
.- Return type
float or
Quantity
obj