Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
SaQC
Manage
Activity
Members
Labels
Plan
Issues
35
Issue boards
Milestones
Wiki
Code
Merge requests
7
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
rdm-software
SaQC
Commits
8fafcd78
Commit
8fafcd78
authored
3 years ago
by
Peter Lünenschloß
Browse files
Options
Downloads
Patches
Plain Diff
more doctext
parent
a04f94cd
No related branches found
Branches containing commit
No related tags found
Tags containing commit
6 merge requests
!685
Release 2.4
,
!684
Release 2.4
,
!567
Release 2.2.1
,
!566
Release 2.2
,
!501
Release 2.1
,
!429
Global kwarg docs
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
sphinxdoc/documentation/GlobalKeywords.rst
+59
-4
59 additions, 4 deletions
sphinxdoc/documentation/GlobalKeywords.rst
with
59 additions
and
4 deletions
sphinxdoc/documentation/GlobalKeywords.rst
+
59
−
4
View file @
8fafcd78
...
...
@@ -57,9 +57,9 @@ call to :py:meth:`saqc.SaQC.plot`.
It is especially useful for enriching figures with custom context information and for making results from
different function calls distinguishable with respect to their purpose and parameterisation.
Check out the following example
s.
Check out the following example
:
Now
we apply some flagging functions to mark anomalies, at first, without usage of the ``label`` keyword
At first,
we apply some flagging functions to mark anomalies, at first, without usage of the ``label`` keyword
.. doctest:: exampleLabel
...
...
@@ -112,7 +112,7 @@ dfilter
-------
The ``dfilter`` keyword controls the threshold up to which a flag triggers masking of its associated value, when passed
on
,
to any flagging function. Any value ``v`` with a flag ``f(v)`` will be masked, if ``f(v) >= dfilter``. A masked value
on to any flagging function. Any value ``v`` with a flag ``f(v)`` will be masked, if ``f(v) >= dfilter``. A masked value
is not visible to a flagging function, so it will neither be part of any calculations performed, nor will it be
flagged by this function. Lets visualize this with the :py:plot:`saqc.SaqC.plot` method. (We are reusing data and code
from `Example Data`_ section). First, we set some flags to the data:
...
...
@@ -150,4 +150,59 @@ and thus, the resulting plot will be cleared from the flags:
qc.plot('data', dfilter=50)
We can also
We can also use the interplay between ``dfilter`` keyword and ``flag`` keyword, to order flags priority.
By default, the ``dfilter`` keyword is set to the highest flag value (``255``). So, the flag second call
to :py:meth:`flagRange` in the example below, wont get passed the values already flagged by the first call to
:py:meth:`flagRange` - so it cant check the value level and assign no flag.
.. doctest:: exampleLabel
>>> qc = saqc.SaQC(data)
>>> qc = qc.flagRange('data', max=15, label='value > 15')
>>> qc = qc.flagRange('data', max=0, label='value > 0')
>>> qc.plot('data') # doctest:+SKIP
.. plot::
:context: close-figs
:include-source: False
qc = saqc.SaQC(data)
qc = qc.flagRange('data', max=15)
qc = qc.flagRange('data', max=0)
qc.plot('data')
We could either lower the significance if the flags set by the first call to :py:meth:`flagRange`, or increase the
``dfilter`` threshold of the second call above the default flag level of ``255``.
Both possibilities and results are shown below:
.. doctest:: exampleLabel
>>> qc = saqc.SaQC(data)
>>> qc = qc.flagRange('data', max=15, label='value > 15', flag=200)
>>> qc = qc.flagRange('data', max=0, label='value > 0')
>>> qc.plot('data') # doctest:+SKIP
.. plot::
:context: close-figs
:include-source: False
qc = saqc.SaQC(data)
qc = qc.flagRange('data', max=15, flag=200)
qc = qc.flagRange('data', max=0)
qc.plot('data')
.. doctest:: exampleLabel
>>> qc = saqc.SaQC(data)
>>> qc = qc.flagRange('data', max=15, label='value > 15')
>>> qc = qc.flagRange('data', max=0, label='value > 0', dfilter=300)
>>> qc.plot('data') # doctest:+SKIP
.. plot::
:context: close-figs
:include-source: False
qc = saqc.SaQC(data)
qc = qc.flagRange('data', max=15)
qc = qc.flagRange('data', max=0, dfilter=300)
qc.plot('data')
\ No newline at end of file
This diff is collapsed.
Click to expand it.
David Schäfer
@schaefed
mentioned in commit
63b55c6d
·
2 years ago
mentioned in commit
63b55c6d
mentioned in commit 63b55c6d7dadb0e612b23a897f292d5ffc14cb52
Toggle commit list
David Schäfer
@schaefed
mentioned in commit
684dc8a0
·
2 years ago
mentioned in commit
684dc8a0
mentioned in commit 684dc8a0515470d644fc85fee95d07661c8dd572
Toggle commit list
David Schäfer
@schaefed
mentioned in commit
8f7a90e4
·
1 year ago
mentioned in commit
8f7a90e4
mentioned in commit 8f7a90e4aed61c79a9dc8d67541a46beba0907e8
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment