opendrift.readers.reader_oscillating
====================================

.. py:module:: opendrift.readers.reader_oscillating


Classes
-------

.. autoapisummary::

   opendrift.readers.reader_oscillating.Reader


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

.. py:class:: Reader(variable, amplitude, period=timedelta(hours=24), period_seconds=None, phase=0, zero_time=datetime(2017, 1, 1, 0))

   Bases: :py:obj:`opendrift.readers.basereader.BaseReader`, :py:obj:`opendrift.readers.basereader.ContinuousReader`


   Returning values oscillating in time with given amplitude and period

   init with 


   .. py:attribute:: variables


   .. py:attribute:: amplitude


   .. py:attribute:: period_seconds


   .. py:attribute:: zero_time


   .. py:attribute:: proj4
      :value: '+proj=latlong +datum=WGS84'



   .. py:attribute:: xmin
      :value: -180



   .. py:attribute:: xmax
      :value: 180



   .. py:attribute:: ymin
      :value: -90



   .. py:attribute:: ymax
      :value: 90



   .. py:attribute:: start_time
      :value: None



   .. py:attribute:: end_time
      :value: None



   .. py:attribute:: time_step
      :value: None



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



   .. py:method:: get_variables(requestedVariables, time=None, x=None, y=None, z=None)

      Obtain and return values of the requested variables at all positions
      (x, y, z) closest to given time.

      Returns:

          Dictionary with arrays of length len(x) with values at exact positions x, y and z.