181 lines
11 KiB
HTML
181 lines
11 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
|
|
<meta name="generator" content="pdoc3 0.11.1">
|
|
<title>defs.OzoneMonitor API documentation</title>
|
|
<meta name="description" content="The docstring for this submodule">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
|
|
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
|
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
|
<script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { inlineMath: [ ['$','$'], ["\\(","\\)"] ], processEscapes: true } });</script>
|
|
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS_CHTML" integrity="sha256-kZafAc6mZvK3W3v1pHOcUix30OHQN6pU/NO2oFkqZVw=" crossorigin></script>
|
|
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
|
|
<script>window.addEventListener('DOMContentLoaded', () => {
|
|
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
|
|
hljs.highlightAll();
|
|
})</script>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<article id="content">
|
|
<header>
|
|
<h1 class="title">Module <code>defs.OzoneMonitor</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<p>The docstring for this submodule</p>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
<dt id="defs.OzoneMonitor.OzoneAnalyser"><code class="flex name class">
|
|
<span>class <span class="ident">OzoneAnalyser</span></span>
|
|
<span>(</span><span>file: <a title="defs.Helper.DATFile" href="Helper.html#defs.Helper.DATFile">DATFile</a>, on_time_interval)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"><p>The docstring for this class</p>
|
|
<p>Description: Bla bla bla</p>
|
|
<h2 id="attributes">Attributes</h2>
|
|
<dl>
|
|
<dt><strong><code>word</code></strong> : <code>str</code></dt>
|
|
<dd>A word</dd>
|
|
</dl>
|
|
<h2 id="methods">Methods</h2>
|
|
<p><strong>init</strong>: HelloWorld
|
|
The class constructor</p></div>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">class OzoneAnalyser():
|
|
|
|
"""The docstring for this class
|
|
|
|
Description: Bla bla bla
|
|
|
|
Attributes
|
|
----------
|
|
word: str
|
|
A word
|
|
|
|
Methods
|
|
-------
|
|
__init__: HelloWorld
|
|
The class constructor
|
|
"""
|
|
|
|
def __init__(self, file: DATFile, on_time_interval):
|
|
|
|
self.file = file
|
|
self.on_time_interval = on_time_interval
|
|
self.averaged_data = None
|
|
|
|
def GetData(self):
|
|
|
|
self.file.read()
|
|
|
|
def AverageWithSMPS(self, smps_analyser: OFRAnalyser, cut_edges: int, subtract_baseline = ['yes', 5]):
|
|
|
|
avg_ozone = []
|
|
mprr_data = []
|
|
|
|
local_smps_data = smps_analyser.data[(smps_analyser.data['Starting Time (-)'] >= smps_analyser.on_time_interval[0]) &
|
|
(smps_analyser.data['Starting Time (-)'] <= smps_analyser.on_time_interval[1])].reset_index()
|
|
|
|
baseline = None
|
|
|
|
for index, data in local_smps_data.iterrows():
|
|
|
|
start = data['Starting Time (-)']
|
|
|
|
if index == 0:
|
|
|
|
if subtract_baseline[0] == 'yes':
|
|
baseline_start = start - pd.Timedelta(minutes = int(subtract_baseline[1]))
|
|
baseline_ozone_data = self.file.data[(self.file.data['timestamp'] >= baseline_start) &
|
|
(self.file.data['timestamp'] <= start)]
|
|
baseline = np.average(baseline_ozone_data['ozone'])
|
|
|
|
if index in list(range(cut_edges)):
|
|
continue
|
|
|
|
stop = start + pd.Timedelta(seconds = data['Sampling Time (s)'])
|
|
|
|
mprr_data.append(data['Mass Production Rate (kg/s)'])
|
|
|
|
local_ozone_data = self.file.data[(self.file.data['timestamp'] >= start) &
|
|
(self.file.data['timestamp'] <= stop)]
|
|
avg_ozone.append(np.average(local_ozone_data['ozone']))
|
|
|
|
for sub_index in list(range(cut_edges)):
|
|
del avg_ozone[-(sub_index + 1)]
|
|
del mprr_data[-(sub_index + 1)]
|
|
|
|
out_mprr_data = np.array(mprr_data)
|
|
|
|
if subtract_baseline[0] == 'yes':
|
|
out_avg_ozone = np.array([baseline - value for value in avg_ozone])
|
|
elif subtract_baseline[0] != 'yes':
|
|
out_avg_ozone = np.array([value for value in avg_ozone])
|
|
|
|
self.averaged_data = pd.DataFrame({'Ozone (ppb)': out_avg_ozone, 'Mass Production Rate (kg/s)': out_mprr_data})</code></pre>
|
|
</details>
|
|
<h3>Methods</h3>
|
|
<dl>
|
|
<dt id="defs.OzoneMonitor.OzoneAnalyser.AverageWithSMPS"><code class="name flex">
|
|
<span>def <span class="ident">AverageWithSMPS</span></span>(<span>self, smps_analyser: <a title="defs.SMPS.OFRAnalyser" href="SMPS.html#defs.SMPS.OFRAnalyser">OFRAnalyser</a>, cut_edges: int, subtract_baseline=['yes', 5])</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"></div>
|
|
</dd>
|
|
<dt id="defs.OzoneMonitor.OzoneAnalyser.GetData"><code class="name flex">
|
|
<span>def <span class="ident">GetData</span></span>(<span>self)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<div class="desc"></div>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</article>
|
|
<nav id="sidebar">
|
|
<div class="toc">
|
|
<ul></ul>
|
|
</div>
|
|
<ul id="index">
|
|
<li><h3>Super-module</h3>
|
|
<ul>
|
|
<li><code><a title="defs" href="index.html">defs</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-classes">Classes</a></h3>
|
|
<ul>
|
|
<li>
|
|
<h4><code><a title="defs.OzoneMonitor.OzoneAnalyser" href="#defs.OzoneMonitor.OzoneAnalyser">OzoneAnalyser</a></code></h4>
|
|
<ul class="">
|
|
<li><code><a title="defs.OzoneMonitor.OzoneAnalyser.AverageWithSMPS" href="#defs.OzoneMonitor.OzoneAnalyser.AverageWithSMPS">AverageWithSMPS</a></code></li>
|
|
<li><code><a title="defs.OzoneMonitor.OzoneAnalyser.GetData" href="#defs.OzoneMonitor.OzoneAnalyser.GetData">GetData</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
|
|
</footer>
|
|
</body>
|
|
</html>
|