.. _wf:

Weighting Functions
===================

These classes provide a consistent framework for calculating weighting functions using different methods and engines.

For HR, the finite difference classes should be used, as the built-in methods are approximations not suitable for calculating AMFs. For DO, the finite difference class is not recommended, as the built-in method is exact and more efficient. The MC class is only meant for use by the air mass factor module.



Base Classes
************

WeightingFunctionBase has initialization parameters common to all weighting
function classes. Finite difference and variable grid classes add more
parameters.

.. autoclass:: skdoas.wf.wf.WeightingFunctionBase
   :members: __init__
.. autoclass:: skdoas.wf.finite_difference_wf.WeightingFunctionFiniteDifferenceBase
   :members: __init__
.. autoclass:: skdoas.wf.finite_difference_wf.WeightingFunctionFiniteDifferenceVariableGrid
   :members: __init__

High Resolution (HR) Classes
****************************

.. autoclass:: skdoas.wf.hr_wf.WeightingFunctionHR
.. autoclass:: skdoas.wf.hr_wf.WeightingFunctionFiniteDifferenceHR
.. autoclass:: skdoas.wf.hr_wf.WeightingFunctionFiniteDifferenceVariableGridHR
.. autoclass:: skdoas.wf.hr_wf.WeightingFunctionFiniteDifferenceMatchShellsHR
.. autoclass:: skdoas.wf.hr_wf.WeightingFunctionFiniteDifferenceConstantLayersHR
.. autoclass:: skdoas.wf.hr_wf.WeightingFunctionFiniteDifferenceConstantLayersVariableGridHR

Discrete Ordinates (DO) Classes
*******************************

.. autoclass:: skdoas.wf.do_wf.WeightingFunctionDO
.. autoclass:: skdoas.wf.do_wf.WeightingFunctionFiniteDifferenceDO

Monte Carlo (MC) Classes
************************

.. autoclass:: skdoas.wf.mc_wf.WeightingFunctionNullMC
   :no-members: