.. _sphx_glr_auto_examples_qc:

.. _qc_examples:

Quality Control Examples
--------------------------

Examples showing different ways to apply quality control to your data.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to query the ARM Data Quality Report (DQR) webservice, to retrieve the machine readable DQR information and print it out to screen.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_dqr_print_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_dqr_print`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Query the ARM DQR webservice</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a short example of how the relative variability test can be applied to a set of variables to determine if one has greater variability than the others.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_relative_variability_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_relative_variability`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Apply the relative variability test to data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to query the ARM Data Quality Report (DQR) webservice, to retrieve the machine readable DQR information.  This function adds the DQR information to corresponding QC variables (qc_[variablename]) in the dataset.  The example then shows how to visualize this information as we do with the normal QC variables.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_dqr_qc_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_dqr_qc`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Query the ARM DQR webservice</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an example of how to use 2 dimentional DataArrays containing multiple 1 dimentional data, including a summary quality control plot showing the tests for each 1 dimentional data slice. This example uses the force_line_plot keyword which will force multiple 1 dimentional plots for each element along the second dimention of the non-time dimention.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_force_line_qc_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_force_line_qc`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Forcing line plots with 2D data and QC</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an example for how to use the step change detection test. The test uses the cumulative sum control chart to detect when a sudden shift in values occurs. It has an option to insert NaN value when there is a data gap to not have those periods returned as a data shift. This example produces two plots, one with the data gap flagged and one without.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_qc_step_change_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_qc_step_change`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting flagged data gaps with a step change test</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Simple example for applying BSRN QC and plotting the data and the corresponding QC flags using colorblind friendly colors. https://bsrn.awi.de/data/quality-checks/">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_qc_bsrn_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_qc_bsrn`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting Baseline Surface Radiation Network (BSRN) QC Flags</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an example of how to use existing or create new quality control varibles. All the tests are located in act/qc/qctests.py file but called under the qcfilter method.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_qc_example_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_qc_example`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working with embedded quality control variables</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an example of how to use existing or create new quality control variables and extend the quality control flagging. The anicllary quality control variable can be expanded by integrating external Data Quality Reports, adding additional generic ACT tests, instrument specific ACT tests, or reading a configuration file of known failures to clean up the data variable.">

.. only:: html

  .. image:: /auto_examples/qc/images/thumb/sphx_glr_plot_arm_qc_thumb.png
    :alt:

  :doc:`/auto_examples/qc/plot_arm_qc`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working with and expanding embedded quality control variables</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/qc/plot_dqr_print
   /auto_examples/qc/plot_relative_variability
   /auto_examples/qc/plot_dqr_qc
   /auto_examples/qc/plot_force_line_qc
   /auto_examples/qc/plot_qc_step_change
   /auto_examples/qc/plot_qc_bsrn
   /auto_examples/qc/plot_qc_example
   /auto_examples/qc/plot_arm_qc