:py:mod:`tape.analysis.structure_function.schmidt_2010.calculator`
==================================================================

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


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

Classes
~~~~~~~

.. autoapisummary::

   tape.analysis.structure_function.schmidt_2010.calculator.Schmidt2010StructureFunctionCalculator




Attributes
~~~~~~~~~~

.. autoapisummary::

   tape.analysis.structure_function.schmidt_2010.calculator.SQRT_PI_OVER_2


.. py:data:: SQRT_PI_OVER_2

   

.. py:class:: Schmidt2010StructureFunctionCalculator(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. 2 of Schmidt et al. 2010, 2010ApJ...714.1194S [https://arxiv.org/abs/1002.2642]
   Schmidt et al. 2010, Erratum 2010ApJ...721.1941S

   `SF(delta_t) = mean(sqrt(pi/2) * abs(delta_flux_i,j) - sqrt(err_i^2 + err_j^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.