Skip to content

Commit

Permalink
Improve docs DQ (#2902)
Browse files Browse the repository at this point in the history
Co-authored-by: Brett M. Morris <[email protected]>
  • Loading branch information
camipacifici and bmorris3 authored May 31, 2024
1 parent e4fdd5b commit 85b808e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
Binary file added docs/imviz/img/imviz_dq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/imviz/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,34 @@ will expand to flag to reveal the flag's short name and description,
as well as a visibility toggle for that flag. Click on the color swatch
to select a color for any flag.

.. image:: ./img/imviz_dq.png
:alt: Imviz DQ plugin
:width: 600px


How to load the data quality array
----------------------------------

The data quality array can be loaded by simply passing the appropriate
extension when loading the data.

.. code-block:: python
imviz = Imviz()
imviz.load_data('path/to/file', ext=('SCI', 'DQ'))
imviz.show()
From the API
------------

If only a few of the bits are relevant to your workflow, it can be useful to hide all flags without the important bits. Say we want to see only flags containing bits zero and two. From the UI, we could select those bits in the "Filter by bits" dropdown, or from the API we could:

.. code-block:: python
dq_plugin = imviz.plugins['Data Quality']
dqplugin.flags_filter = [0, 2]
.. _imviz-subset-plugin:

Subset Tools
Expand Down

0 comments on commit 85b808e

Please sign in to comment.