helikite.processing.sorting
===========================

.. py:module:: helikite.processing.sorting


Attributes
----------

.. autoapisummary::

   helikite.processing.sorting.logger


Functions
---------

.. autoapisummary::

   helikite.processing.sorting.df_column_sort_key


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

.. py:data:: logger

.. py:function:: df_column_sort_key(export_df: Tuple[pandas.DataFrame, helikite.instruments.base.Instrument]) -> pandas.DataFrame

   Sort key for ordering of exported dataframes

   Uses the export_order in the Instrument object to define sort 'height'
   ie. (df, 100) is sorted higher than (df, 50)

   :param export_df: Tuple of dataframe and Instrument object
   :type export_df: Tuple[pd.DataFrame, Instrument]

   :returns: Sort order
   :rtype: int