tape.analysis.structure_function.bauer_2009a.calculator
=======================================================

.. py:module:: tape.analysis.structure_function.bauer_2009a.calculator


Classes
-------

.. autoapisummary::

   tape.analysis.structure_function.bauer_2009a.calculator.Bauer2009AStructureFunctionCalculator


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

.. py:class:: Bauer2009AStructureFunctionCalculator(lightcurves: List[tape.analysis.structure_function.sf_light_curve.StructureFunctionLightCurve], argument_container: tape.analysis.structure_function.base_argument_container.StructureFunctionArgumentContainer)

   Bases: :py:obj:`tape.analysis.structure_function.base_calculator.StructureFunctionCalculator`


   This class implements the structure function calculation described in
   Eqn. 4 of Bauer et al. 2009, 2009ApJ...696.1241B [https://arxiv.org/abs/0902.4103]

   `SF(tau) = sqrt( mean(delta_flux^2) - mean(err^2) )`

   Note that the return value is structure function squared.

   Additional references:
   Graham et al. 2014MNRAS.439..703G [https://arxiv.org/abs/1401.1785]


   .. py:method:: calculate()

      Abstract method that must be implemented by the child class.



   .. py:method:: name_id() -> str
      :staticmethod:


      This method will return the unique name of the Structure Function
      calculation method.



   .. py:method:: expected_argument_container() -> type
      :staticmethod:


      This method will return the argument container class type (not an
      instance) that the Structure Function calculation method requires in
      order to perform it's calculations.