:py:mod:`mlair.data_handler.data_handler_neighbors`
===================================================

.. py:module:: mlair.data_handler.data_handler_neighbors


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

Classes
~~~~~~~

.. autoapisummary::

   mlair.data_handler.data_handler_neighbors.DataHandlerNeighbors
   mlair.data_handler.data_handler_neighbors.DummyDataHandler



Functions
~~~~~~~~~

.. autoapisummary::

   mlair.data_handler.data_handler_neighbors.run_data_prep
   mlair.data_handler.data_handler_neighbors.create_data_prep



Attributes
~~~~~~~~~~

.. autoapisummary::

   mlair.data_handler.data_handler_neighbors.__author__
   mlair.data_handler.data_handler_neighbors.__date__
   mlair.data_handler.data_handler_neighbors.number
   mlair.data_handler.data_handler_neighbors.num_or_list
   mlair.data_handler.data_handler_neighbors.a


.. py:data:: __author__
   :annotation: = Lukas Leufen

   

.. py:data:: __date__
   :annotation: = 2020-07-17

   This data handler is just a prototype and has not been validated to work properly! Use it with caution!

   :type: WARNING

.. py:data:: number
   

   

.. py:data:: num_or_list
   

   

.. py:class:: DataHandlerNeighbors(id_class, data_path, neighbors=None, min_length=0, extreme_values: num_or_list = None, extremes_on_right_tail_only: bool = False)

   Bases: :py:obj:`mlair.data_handler.DefaultDataHandler`

   Data handler including neighboring stations.

   .. py:method:: build(cls, station, **kwargs)
      :classmethod:

      Return initialised class.


   .. py:method:: _create_collection(self)


   .. py:method:: get_coordinates(self, include_neighbors=False)

      Return coordinates as dictionary with keys `lon` and `lat`.



.. py:function:: run_data_prep()

   Comment: methods just to start write meaningful test routines.


.. py:function:: create_data_prep()

   Comment: methods just to start write meaningful test routines.


.. py:class:: DummyDataHandler(name, number_of_samples=None)

   Bases: :py:obj:`mlair.data_handler.AbstractDataHandler`

   .. py:method:: create_X(self)

      Inputs are random numbers between 0 and 10 with shape (no_samples, window=14, variables=5).


   .. py:method:: create_Y(self)

      Targets are normal distributed random numbers with shape (no_samples, window=5, variables=1).


   .. py:method:: get_X(self, upsampling=False, as_numpy=False)

      Upsampling parameter is not used for X.


   .. py:method:: get_Y(self, upsampling=False, as_numpy=False)

      Upsampling parameter is not used for Y.


   .. py:method:: __str__(self)

      Return str(self).



.. py:data:: a