spectral_axis_conversion#

jdaviz.core.unit_conversion_utils.spectral_axis_conversion(values, original_units, target_units, with_unit=False)[source]#

Attempt to convert original_units, and target_units, which are spectral axis quantities, between different units. The conversion is skipped if only one of the units is ‘pix’ to allow for mixed pixel/world unit viewing.

Parameters:
valuesarray-like

Spectral axis values to convert.

original_unitsstr

Current units of values.

target_unitsstr

Desired output units for values.

with_unitbool, optional

If True, the returned value is a Quantity. If False, only the numerical values are returned. (Default is False).

Returns:
converted_valuesarray-like or Quantity

Converted values, or original values unchanged if converting between pixel and world coordinates (to support mixed-unit viewing).