cassis_lte_python.database.transitions
======================================

.. py:module:: cassis_lte_python.database.transitions


Attributes
----------

.. autoapisummary::

   cassis_lte_python.database.transitions.LOGGER
   cassis_lte_python.database.transitions.FIELDS
   cassis_lte_python.database.transitions.TRAN_COLNAME
   cassis_lte_python.database.transitions.TAG_COLNAME
   cassis_lte_python.database.transitions.SP_COLNAME
   cassis_lte_python.database.transitions.TRAN_DF_COLS


Classes
-------

.. autoapisummary::

   cassis_lte_python.database.transitions.Transition


Functions
---------

.. autoapisummary::

   cassis_lte_python.database.transitions.get_transition_list
   cassis_lte_python.database.transitions.get_transition_df
   cassis_lte_python.database.transitions.is_selected
   cassis_lte_python.database.transitions.select_transitions


Module Contents
---------------

.. py:data:: LOGGER

.. py:data:: FIELDS

.. py:data:: TRAN_COLNAME
   :value: 'transition'


.. py:data:: TAG_COLNAME
   :value: 'tag'


.. py:data:: SP_COLNAME
   :value: 'sp_name'


.. py:data:: TRAN_DF_COLS
   :value: ['transition', 'tag', 'sp_name', 'db_id', 'fMHz', 'f_err_mhz', 'aij', 'elow', 'eup', 'igu',...


.. py:class:: Transition(tag, f_trans_mhz, aij, elo_cm, gup, sp_name='', f_err_mhz=None, db_id=None, qn='')

   .. py:attribute:: f_trans_mhz


   .. py:attribute:: f_err_mhz
      :value: None



   .. py:attribute:: aij


   .. py:attribute:: elo_cm


   .. py:attribute:: elo_J


   .. py:attribute:: eup_J


   .. py:attribute:: gup


   .. py:attribute:: eup


   .. py:attribute:: tag
      :value: ''



   .. py:attribute:: name
      :value: ''



   .. py:attribute:: db_id
      :value: None



   .. py:attribute:: qn
      :value: ''



.. py:function:: get_transition_list(species: list | str, fmhz_ranges, database=DATABASE_SQL, return_type='dict', **thresholds)

   :param species:
   :param fmhz_ranges:
   :param database:
   :param return_type:
   :param thresholds:
   :return:


.. py:function:: get_transition_df(species: list | str, fmhz_ranges, database=DATABASE_SQL, shift_kms=0.0, **thresholds)

.. py:function:: is_selected(tran: Transition, sp_thresholds: dict, bright_lines_only=False)

   Determine if a transition fulfills all constraints.
   :param tran: a Transition object
   :param sp_thresholds: a dictionary containing the species' thresholds
   :param bright_lines_only: TODO: TBC
   :return:


.. py:function:: select_transitions(tran_df: pandas.DataFrame, thresholds: dict | None = None, xrange=None, bright_lines_only=False, vlsr=None)