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

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


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

Classes
~~~~~~~

.. autoapisummary::

   tape.analysis.structure_function.basic.calculator.BasicStructureFunctionCalculator




.. py:class:: BasicStructureFunctionCalculator(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`

   SF calculation method that calculates excess variance directly as a
   variance of observations with observational errors subtracted.
   For reference, please see Equation 12 in https://arxiv.org/abs/1604.05858

   .. 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.