guess_line_velocity

sitelle.fit.guess_line_velocity(max_pos, v_min, v_max, lines=None, debug=False, return_line=False)

Estimation of the velocity shift from a line position. Because we don’t have a priori knowledge on which line we are looking at, we try different rest lines while the estimation is not in a given velocity range. If None of the lines are compatible with a velocity shift in the given range, we ouput NaN.

Parameters:

• max_pos (float) – Observed line position, in cm-1.
• v_min (float) – Constraint on the lower bound of the velocity range.
• v_max (float) – Constraint on the upper bound of the velocity range.
• lines (list of str) – Names of the rest line candidates for the observed line.
• debug (bool) – (Optional) If True, a debug id displayed (default = False)
• return_line (bool) – (Optional) If True, the name of the line that produced the estimation is output.

Returns:

• v_guess (float) – The guess on the velocity (NaN if not included in the velocity range)
• line_name (str) – (Only if return_line = True) the name of the line.