diff --git a/docs/build/doctrees/Reference/components/dataset/index.doctree b/docs/build/doctrees/Reference/components/dataset/index.doctree
index d3306af4760357b452ed2cb1c716c1263446a3c7..f96174ad92cc2f0bd6da7965d1e47c3f5f92ed96 100644
Binary files a/docs/build/doctrees/Reference/components/dataset/index.doctree and b/docs/build/doctrees/Reference/components/dataset/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/dataset_image/index.doctree b/docs/build/doctrees/Reference/components/dataset_image/index.doctree
index f911e9016f5183a817e39b31eb5caa24daaf3351..64e2c0539f7a4e8a1d57b0b6dcd8344f6a69644f 100644
Binary files a/docs/build/doctrees/Reference/components/dataset_image/index.doctree and b/docs/build/doctrees/Reference/components/dataset_image/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/dataset_keyvalue/index.doctree b/docs/build/doctrees/Reference/components/dataset_keyvalue/index.doctree
index 7de7e15c63bf8d42b169857b32a745010052cc7c..e84382cd0d65cb10bc66c9abae99b68d9dd0bbfb 100644
Binary files a/docs/build/doctrees/Reference/components/dataset_keyvalue/index.doctree and b/docs/build/doctrees/Reference/components/dataset_keyvalue/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/dataset_video/index.doctree b/docs/build/doctrees/Reference/components/dataset_video/index.doctree
index d124cfeea063c5c27662a5486f73aae6c8548989..5b51ff69501e8ac8ce7a7193c2068fbea88df683 100644
Binary files a/docs/build/doctrees/Reference/components/dataset_video/index.doctree and b/docs/build/doctrees/Reference/components/dataset_video/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/index.doctree b/docs/build/doctrees/Reference/components/index.doctree
index f84082efef60c85334010cc1f14926341cd738a0..0bd4cad4a9c87981dc22402bfa1976dc3bc355ab 100644
Binary files a/docs/build/doctrees/Reference/components/index.doctree and b/docs/build/doctrees/Reference/components/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/instrument/index.doctree b/docs/build/doctrees/Reference/components/instrument/index.doctree
index 2897dbfcc1cf8610114fec122bad4aedcbfe809f..7ec62720d6e60606dde93a04c5959d67c4b8a06d 100644
Binary files a/docs/build/doctrees/Reference/components/instrument/index.doctree and b/docs/build/doctrees/Reference/components/instrument/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/parameter/index.doctree b/docs/build/doctrees/Reference/components/parameter/index.doctree
index 73b8e3b29fe658f88408463a5b7be1be1d089263..1fd5189099633b0442beffd8b74d3e1e8a26427d 100644
Binary files a/docs/build/doctrees/Reference/components/parameter/index.doctree and b/docs/build/doctrees/Reference/components/parameter/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/pipeline/index.doctree b/docs/build/doctrees/Reference/components/pipeline/index.doctree
index 702e7a12dc7f673f902dc641469250de2cf17533..8dc333399aec6024a0cc59108b215577cf98f177 100644
Binary files a/docs/build/doctrees/Reference/components/pipeline/index.doctree and b/docs/build/doctrees/Reference/components/pipeline/index.doctree differ
diff --git a/docs/build/doctrees/Reference/components/storage/index.doctree b/docs/build/doctrees/Reference/components/storage/index.doctree
index b347e2cc59ebec6804a52135e4f1b4e6d68a7b8d..b9fd641ccfa53d505dc2fe2d46193d5e64663428 100644
Binary files a/docs/build/doctrees/Reference/components/storage/index.doctree and b/docs/build/doctrees/Reference/components/storage/index.doctree differ
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
index da8b64f9a43a784e7969702b7e69eab228df7184..5897a84e9c62d692120eaaf6bc74a5cd323fa36a 100644
Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ
diff --git a/docs/build/doctrees/user/index.doctree b/docs/build/doctrees/user/index.doctree
index 2e6785e612f5672f0f416f2a82a343c520b6c1d1..511d50739fce75b3bdc4311ecaf3204e68025adc 100644
Binary files a/docs/build/doctrees/user/index.doctree and b/docs/build/doctrees/user/index.doctree differ
diff --git a/docs/build/html/Reference/components/dataset/index.html b/docs/build/html/Reference/components/dataset/index.html
index cc9a6b63c3d593311e57a4e80c614e930bee5af1..25e98d33df54c15bd57c5038a8be2fcb98fa1fa6 100644
--- a/docs/build/html/Reference/components/dataset/index.html
+++ b/docs/build/html/Reference/components/dataset/index.html
@@ -105,7 +105,7 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.dataset.Dataset" title="components.dataset.Dataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset</span></code></a></p></td>
-<td><p>An object of this class represent the dataset.</p></td>
+<td><p>An object of this class represents the dataset.</p></td>
</tr>
</tbody>
</table>
@@ -127,7 +127,7 @@
<dt class="sig sig-object py" id="components.dataset.Dataset">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.dataset.</span></span><span class="sig-name descname"><span class="pre">Dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.dataset.Dataset" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></p>
-<p>An object of this class represent the dataset.</p>
+<p>An object of this class represents the dataset.</p>
<p>At present, there is no requirement for the type of data, it is simply stored in the dataset.data attribute
and further processing will be performed according to the different data types read in.</p>
<dl class="field-list simple">
diff --git a/docs/build/html/Reference/components/dataset_image/index.html b/docs/build/html/Reference/components/dataset_image/index.html
index ac760f0a06964957b5929308f364227d96deca9a..a4103ff75dd7e04d00481e961b0331f12e972a5a 100644
--- a/docs/build/html/Reference/components/dataset_image/index.html
+++ b/docs/build/html/Reference/components/dataset_image/index.html
@@ -105,7 +105,7 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.dataset_image.Dataset_Image" title="components.dataset_image.Dataset_Image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset_Image</span></code></a></p></td>
-<td><p>An object of this class represents 1 image (Mulitple images havent been considered or investigated yet).</p></td>
+<td><p>An object of this class represents 1 image (Multiple images have not been considered or investigated yet).</p></td>
</tr>
</tbody>
</table>
@@ -113,7 +113,7 @@
<dt class="sig sig-object py" id="components.dataset_image.Dataset_Image">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.dataset_image.</span></span><span class="sig-name descname"><span class="pre">Dataset_Image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.dataset_image.Dataset_Image" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></p>
-<p>An object of this class represents 1 image (Mulitple images havent been considered or investigated yet).</p>
+<p>An object of this class represents 1 image (Multiple images have not been considered or investigated yet).</p>
<p>The user only needs to provide the path of the image, this class will read it using the pillow lib</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
diff --git a/docs/build/html/Reference/components/dataset_keyvalue/index.html b/docs/build/html/Reference/components/dataset_keyvalue/index.html
index 7de8c814069cf6388163416795aec5800493e04e..45d71e96b0487b463a0dc1cd54e1b8266948beea 100644
--- a/docs/build/html/Reference/components/dataset_keyvalue/index.html
+++ b/docs/build/html/Reference/components/dataset_keyvalue/index.html
@@ -105,7 +105,7 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.dataset_keyvalue.Dataset_KeyValue" title="components.dataset_keyvalue.Dataset_KeyValue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset_KeyValue</span></code></a></p></td>
-<td><p>Dataset_KeyValue class is used as a converter between a dictionary formated in a HDF5 storable way to a hdf file</p></td>
+<td><p>Dataset_KeyValue class is used as a converter between a dictionary formated in an HDF5 storable way to a hdf file</p></td>
</tr>
</tbody>
</table>
@@ -113,7 +113,7 @@
<dt class="sig sig-object py" id="components.dataset_keyvalue.Dataset_KeyValue">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.dataset_keyvalue.</span></span><span class="sig-name descname"><span class="pre">Dataset_KeyValue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.dataset_keyvalue.Dataset_KeyValue" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></p>
-<p>Dataset_KeyValue class is used as a converter between a dictionary formated in a HDF5 storable way to a hdf file</p>
+<p>Dataset_KeyValue class is used as a converter between a dictionary formated in an HDF5 storable way to a hdf file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
@@ -133,14 +133,14 @@
<dd><p>Expects a Dictionary that starts with run</p>
<p>Parameter:
1. see if dictname = parameter;
-2. if last group = parameter, go into dict and create parameter for each (e.g.: gain, offset )
+2. if last group = parameter, go into dict and create parameter for each (e. g.: gain, offset )
3. Go into the parameters and add the attributes</p>
-<p>Data is similiar to parameter just that we add data instead</p>
+<p>Data is similar to parameter, just that we add data instead</p>
<p>XXXXXXXXXX data kann also have attributes —-> How would attributes look in a JSON-> Dict?</p>
<dl class="simple">
-<dt>_Group<span class="classifier">str</span></dt><dd><p>parameter to be used by the recursive function; describes the last “wrapper class” ( pipeline,instruments,model)</p>
+<dt>_Group<span class="classifier">str</span></dt><dd><p>parameter to be used by the recursive function; describes the last “wrapper class” (pipeline,instruments,model)</p>
</dd>
-<dt>_last_group<span class="classifier">str</span></dt><dd><p>parameter to be used by the resursive function</p>
+<dt>_last_group<span class="classifier">str</span></dt><dd><p>parameter to be used by the recursive function</p>
</dd>
<dt>Dict<span class="classifier">list, tuple, dict</span></dt><dd><p>nested key value pairs –>
Dicti[key]: whole dictionary is called by the name Dicti, to get a single value Dicti[key] is called
diff --git a/docs/build/html/Reference/components/dataset_video/index.html b/docs/build/html/Reference/components/dataset_video/index.html
index 899929ce9a6f3cfc6037b06ed0f9597b50458a1a..dc2dd1d4a31eecf6eec5bac42ee344c1de87a9ab 100644
--- a/docs/build/html/Reference/components/dataset_video/index.html
+++ b/docs/build/html/Reference/components/dataset_video/index.html
@@ -105,7 +105,7 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.dataset_video.Dataset_Video" title="components.dataset_video.Dataset_Video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset_Video</span></code></a></p></td>
-<td><p>An object of this class represent the video dataset.</p></td>
+<td><p>An object of this class represents the video dataset.</p></td>
</tr>
</tbody>
</table>
@@ -113,7 +113,7 @@
<dt class="sig sig-object py" id="components.dataset_video.Dataset_Video">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.dataset_video.</span></span><span class="sig-name descname"><span class="pre">Dataset_Video</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.dataset_video.Dataset_Video" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></p>
-<p>An object of this class represent the video dataset.</p>
+<p>An object of this class represents the video dataset.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the dataset</p>
@@ -134,7 +134,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="components.dataset_video.Dataset_Video.output_file">
<span class="sig-name descname"><span class="pre">output_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_output</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.dataset_video.Dataset_Video.output_file" title="Permalink to this definition"></a></dt>
-<dd><p>this function is designed to convert the binary format data into the origina format</p>
+<dd><p>this function is designed to convert the binary format data into the original format</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path_output</strong> (<em>str</em>) – the path of output</p>
@@ -145,7 +145,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="components.dataset_video.Dataset_Video.convert_pics">
<span class="sig-name descname"><span class="pre">convert_pics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_output</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.dataset_video.Dataset_Video.convert_pics" title="Permalink to this definition"></a></dt>
-<dd><p>this function is to convert the video file into frames segmentations</p>
+<dd><p>this function is to convert the video file into frame segmentations</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path_output</strong> (<em>str</em>) – the path of output</p>
diff --git a/docs/build/html/Reference/components/index.html b/docs/build/html/Reference/components/index.html
index dae6ae102413b7fb17dccd99cac49a21d46773a4..ed9d44e64fa0fdcb5b3f6b009b82601c873b8fb9 100644
--- a/docs/build/html/Reference/components/index.html
+++ b/docs/build/html/Reference/components/index.html
@@ -124,16 +124,16 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.Storage" title="components.Storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></a></p></td>
-<td><p>This class is an abstrcted class for all other class, providing initialization function with a name</p></td>
+<td><p>This class is an abstracted for all other classes, providing initialization function with a name</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#components.Dataset_Image" title="components.Dataset_Image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset_Image</span></code></a></p></td>
-<td><p>An object of this class represents 1 image (Mulitple images havent been considered or investigated yet).</p></td>
+<td><p>An object of this class represents 1 image (Multiple images have not been considered or investigated yet).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.Dataset_Video" title="components.Dataset_Video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset_Video</span></code></a></p></td>
-<td><p>An object of this class represent the video dataset.</p></td>
+<td><p>An object of this class represents the video dataset.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#components.Parameter" title="components.Parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Parameter</span></code></a></p></td>
-<td><p>An object of this class represent the Parameter.</p></td>
+<td><p>An object of this class represents the Parameter.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.Model" title="components.Model"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Model</span></code></a></p></td>
<td><p>This object is used to represent the model for data processing in the experiment</p></td>
@@ -152,8 +152,8 @@
<dl class="py class">
<dt class="sig sig-object py" id="components.Storage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.</span></span><span class="sig-name descname"><span class="pre">Storage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage" title="Permalink to this definition"></a></dt>
-<dd><p>This class is an abstrcted class for all other class, providing initialization function with a name
-and store function to generate a hdf5 file</p>
+<dd><p>This class is an abstracted for all other classes, providing initialization function with a name
+and store function to generate an HDF5 file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the instant</p>
@@ -162,7 +162,7 @@ and store function to generate a hdf5 file</p>
<dl class="py method">
<dt class="sig sig-object py" id="components.Storage.set_storage_path">
<span class="sig-name descname"><span class="pre">set_storage_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.set_storage_path" title="Permalink to this definition"></a></dt>
-<dd><p>set the storage path, where you want to store the hdf5 file</p>
+<dd><p>set the storage path where you want to store the HDF5 file</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>please always use “/” in path string instead of “”</p>
@@ -180,8 +180,8 @@ and store function to generate a hdf5 file</p>
<dd></dd></dl>
<dl class="py method">
-<dt class="sig sig-object py" id="components.Storage.store_hdf5">
-<span class="sig-name descname"><span class="pre">store_hdf5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.store_hdf5" title="Permalink to this definition"></a></dt>
+<dt class="sig sig-object py" id="components.Storage.store_HDF5">
+<span class="sig-name descname"><span class="pre">store_HDF5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.store_HDF5" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -197,36 +197,36 @@ and store function to generate a hdf5 file</p>
<dl class="py method">
<dt class="sig sig-object py" id="components.Storage.__str__">
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.__str__" title="Permalink to this definition"></a></dt>
-<dd><p>rewrite the builtin method to modify the behavious of print() for this instance
-to make the print result more readerable</p>
+<dd><p>rewrite the built-in method to modify the behaviors of print() for this instance
+to make the print result more readable</p>
<p>before:</p>
<p>>>>print(run1)</p>
<p><run.Run object at 0x0000022AA45715A0></p>
<p>after:</p>
<p>>>>print(run1)</p>
<p>‘run1’</p>
-<p>here the string ‘run1’ is the name of this instance</p>
+<p>here, the string ‘run1’ is the name of this instance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="components.Storage.__repr__">
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.__repr__" title="Permalink to this definition"></a></dt>
-<dd><p>rewrite the builtin method to modify the behavious of print() for a list of instances
-to make the print result more readerable</p>
+<dd><p>rewrite the built-in method to modify the behaviors of print() for a list of instances
+to make the print result more readable</p>
<p>before:</p>
<p>>>>print(run1.pipelines)</p>
<p>[<pipeline.Pipeline object at 0x0000022AA45715A0>, <pipeline.Pipeline object at 0x0000022AA4gd1s0>]</p>
<p>after:</p>
<p>>>>print(run1.pipelines)</p>
<p>[‘pipe1’, ‘pipe2’]</p>
-<p>here the strings ‘pipe1’ and ‘pipe2’ are the names of this instance</p>
+<p>here, the strings ‘pipe1’ and ‘pipe2’ are the names of this instance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="components.Storage.show">
<span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.show" title="Permalink to this definition"></a></dt>
-<dd><p>use the method to show the detail information about this instance, for example all attributes and name
-it should return a string like this</p>
+<dd><p>use the method to show the detailed information about this instance, for example all attributes and names.
+It should return a string like this:</p>
<p class="rubric">Examples</p>
<p>>> msmtrun.show()</p>
<p>#### pipelines ####</p>
@@ -247,7 +247,7 @@ it should return a string like this</p>
<span class="sig-name descname"><span class="pre">add_attrs_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Storage.add_attrs_dict" title="Permalink to this definition"></a></dt>
<dd><p>Add a flat Dictionary of key values as a set of attributes.</p>
<dl class="simple">
-<dt>dict<span class="classifier">str</span></dt><dd><p>The Dictionary consists of Key Value pairs, with the keys being the name of the attribute
+<dt>dict<span class="classifier">str</span></dt><dd><p>The Dictionary consists of Key Value pairs, with the keys being the names of the attribute
and the value being the value assigned to the attribute</p>
</dd>
</dl>
@@ -264,7 +264,7 @@ object: Any</p>
<div><p>an object which can be an instance of any class</p>
</div></blockquote>
<dl class="simple">
-<dt>object_string: str</dt><dd><p>an encoded string, maybe very long when the original object is large</p>
+<dt>object_string: str</dt><dd><p>an encoded string, maybe very long if the original object is large</p>
</dd>
</dl>
<dl class="field-list simple">
@@ -307,7 +307,7 @@ object_string: str</p>
<dt class="sig sig-object py" id="components.Dataset_Image">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.</span></span><span class="sig-name descname"><span class="pre">Dataset_Image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Dataset_Image" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#components.Storage" title="components.Storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
-<p>An object of this class represents 1 image (Mulitple images havent been considered or investigated yet).</p>
+<p>An object of this class represents 1 image (Multiple images have not been considered or investigated yet).</p>
<p>The user only needs to provide the path of the image, this class will read it using the pillow lib</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@@ -334,7 +334,7 @@ object_string: str</p>
<dt class="sig sig-object py" id="components.Dataset_Video">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.</span></span><span class="sig-name descname"><span class="pre">Dataset_Video</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Dataset_Video" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#components.Storage" title="components.Storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
-<p>An object of this class represent the video dataset.</p>
+<p>An object of this class represents the video dataset.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the dataset</p>
@@ -355,7 +355,7 @@ object_string: str</p>
<dl class="py method">
<dt class="sig sig-object py" id="components.Dataset_Video.output_file">
<span class="sig-name descname"><span class="pre">output_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_output</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Dataset_Video.output_file" title="Permalink to this definition"></a></dt>
-<dd><p>this function is designed to convert the binary format data into the origina format</p>
+<dd><p>this function is designed to convert the binary format data into the original format</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path_output</strong> (<em>str</em>) – the path of output</p>
@@ -366,7 +366,7 @@ object_string: str</p>
<dl class="py method">
<dt class="sig sig-object py" id="components.Dataset_Video.convert_pics">
<span class="sig-name descname"><span class="pre">convert_pics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_output</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Dataset_Video.convert_pics" title="Permalink to this definition"></a></dt>
-<dd><p>this function is to convert the video file into frames segmentations</p>
+<dd><p>this function is to convert the video file into frame segmentations</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path_output</strong> (<em>str</em>) – the path of output</p>
@@ -380,7 +380,7 @@ object_string: str</p>
<dt class="sig sig-object py" id="components.Parameter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.</span></span><span class="sig-name descname"><span class="pre">Parameter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Parameter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#components.Storage" title="components.Storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
-<p>An object of this class represent the Parameter.</p>
+<p>An object of this class represents the Parameter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the parameter</p>
@@ -428,11 +428,11 @@ para1.attrs[‘units’] = ‘cm’</p>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.</span></span><span class="sig-name descname"><span class="pre">Instrument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.Instrument" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#components.Storage" title="components.Storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></a></p>
<p>This class represents Datasets that are mapped from other datasets using a given model</p>
-<p>This can be used to convert the input of a sensor to its actual pysical data using the given model
-for example polynomals or lookup tables.</p>
+<p>This can be used to convert the input of a sensor to its actual physical data using the given model,
+for example polynomials or lookup tables.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the instument</p>
+<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the instrument</p>
</dd>
</dl>
<p class="rubric">Examples</p>
@@ -483,7 +483,7 @@ for example polynomals or lookup tables.</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
-<li><p><strong>TypeError</strong> – raised when the element of list_obj is not the type of Instrument of Dataset</p></li>
+<li><p><strong>TypeError</strong> – raised when the element of list_obj is not the type of Instrument or Dataset</p></li>
<li><p><strong>AssertionError</strong> – raised when list_obj is not a list or it is empty</p></li>
</ul>
</dd>
diff --git a/docs/build/html/Reference/components/instrument/index.html b/docs/build/html/Reference/components/instrument/index.html
index 2ebe0e0c84620300dd723eb3a2eb14b0ee7cee10..97d043f18d2f9c7dbc1ac6e3f5d80d93312015b8 100644
--- a/docs/build/html/Reference/components/instrument/index.html
+++ b/docs/build/html/Reference/components/instrument/index.html
@@ -114,11 +114,11 @@
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.instrument.</span></span><span class="sig-name descname"><span class="pre">Instrument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.instrument.Instrument" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></p>
<p>This class represents Datasets that are mapped from other datasets using a given model</p>
-<p>This can be used to convert the input of a sensor to its actual pysical data using the given model
-for example polynomals or lookup tables.</p>
+<p>This can be used to convert the input of a sensor to its actual physical data using the given model,
+for example polynomials or lookup tables.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the instument</p>
+<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the instrument</p>
</dd>
</dl>
<p class="rubric">Examples</p>
diff --git a/docs/build/html/Reference/components/parameter/index.html b/docs/build/html/Reference/components/parameter/index.html
index e42e40fbd00629f8aaa17a57cba3b47fb52d81aa..97c7826156328d20566109d52d92c55bbdedb851 100644
--- a/docs/build/html/Reference/components/parameter/index.html
+++ b/docs/build/html/Reference/components/parameter/index.html
@@ -105,7 +105,7 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.parameter.Parameter" title="components.parameter.Parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Parameter</span></code></a></p></td>
-<td><p>An object of this class represent the Parameter.</p></td>
+<td><p>An object of this class represents the Parameter.</p></td>
</tr>
</tbody>
</table>
@@ -113,7 +113,7 @@
<dt class="sig sig-object py" id="components.parameter.Parameter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.parameter.</span></span><span class="sig-name descname"><span class="pre">Parameter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.parameter.Parameter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></p>
-<p>An object of this class represent the Parameter.</p>
+<p>An object of this class represents the Parameter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the parameter</p>
diff --git a/docs/build/html/Reference/components/pipeline/index.html b/docs/build/html/Reference/components/pipeline/index.html
index 49ef75eb05fb4e96ab1e51f04c603855c406a118..b8ffa35322c08b072592abea9b405e8096ed3b0f 100644
--- a/docs/build/html/Reference/components/pipeline/index.html
+++ b/docs/build/html/Reference/components/pipeline/index.html
@@ -138,7 +138,7 @@
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
-<li><p><strong>TypeError</strong> – raised when the element of list_obj is not the type of Instrument of Dataset</p></li>
+<li><p><strong>TypeError</strong> – raised when the element of list_obj is not the type of Instrument or Dataset</p></li>
<li><p><strong>AssertionError</strong> – raised when list_obj is not a list or it is empty</p></li>
</ul>
</dd>
diff --git a/docs/build/html/Reference/components/storage/index.html b/docs/build/html/Reference/components/storage/index.html
index e083118df5f8b1fded42965f0b421f7063000af2..9ee53b6f5eeed4391abca5b24ba340c83ae510cc 100644
--- a/docs/build/html/Reference/components/storage/index.html
+++ b/docs/build/html/Reference/components/storage/index.html
@@ -104,15 +104,15 @@
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#components.storage.Storage" title="components.storage.Storage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Storage</span></code></a></p></td>
-<td><p>This class is an abstrcted class for all other class, providing initialization function with a name</p></td>
+<td><p>This class is an abstracted for all other classes, providing initialization function with a name</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
<dt class="sig sig-object py" id="components.storage.Storage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">components.storage.</span></span><span class="sig-name descname"><span class="pre">Storage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage" title="Permalink to this definition"></a></dt>
-<dd><p>This class is an abstrcted class for all other class, providing initialization function with a name
-and store function to generate a hdf5 file</p>
+<dd><p>This class is an abstracted for all other classes, providing initialization function with a name
+and store function to generate an HDF5 file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the instant</p>
@@ -121,7 +121,7 @@ and store function to generate a hdf5 file</p>
<dl class="py method">
<dt class="sig sig-object py" id="components.storage.Storage.set_storage_path">
<span class="sig-name descname"><span class="pre">set_storage_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.set_storage_path" title="Permalink to this definition"></a></dt>
-<dd><p>set the storage path, where you want to store the hdf5 file</p>
+<dd><p>set the storage path where you want to store the HDF5 file</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>please always use “/” in path string instead of “”</p>
@@ -139,8 +139,8 @@ and store function to generate a hdf5 file</p>
<dd></dd></dl>
<dl class="py method">
-<dt class="sig sig-object py" id="components.storage.Storage.store_hdf5">
-<span class="sig-name descname"><span class="pre">store_hdf5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.store_hdf5" title="Permalink to this definition"></a></dt>
+<dt class="sig sig-object py" id="components.storage.Storage.store_HDF5">
+<span class="sig-name descname"><span class="pre">store_HDF5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.store_HDF5" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -156,36 +156,36 @@ and store function to generate a hdf5 file</p>
<dl class="py method">
<dt class="sig sig-object py" id="components.storage.Storage.__str__">
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.__str__" title="Permalink to this definition"></a></dt>
-<dd><p>rewrite the builtin method to modify the behavious of print() for this instance
-to make the print result more readerable</p>
+<dd><p>rewrite the built-in method to modify the behaviors of print() for this instance
+to make the print result more readable</p>
<p>before:</p>
<p>>>>print(run1)</p>
<p><run.Run object at 0x0000022AA45715A0></p>
<p>after:</p>
<p>>>>print(run1)</p>
<p>‘run1’</p>
-<p>here the string ‘run1’ is the name of this instance</p>
+<p>here, the string ‘run1’ is the name of this instance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="components.storage.Storage.__repr__">
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.__repr__" title="Permalink to this definition"></a></dt>
-<dd><p>rewrite the builtin method to modify the behavious of print() for a list of instances
-to make the print result more readerable</p>
+<dd><p>rewrite the built-in method to modify the behaviors of print() for a list of instances
+to make the print result more readable</p>
<p>before:</p>
<p>>>>print(run1.pipelines)</p>
<p>[<pipeline.Pipeline object at 0x0000022AA45715A0>, <pipeline.Pipeline object at 0x0000022AA4gd1s0>]</p>
<p>after:</p>
<p>>>>print(run1.pipelines)</p>
<p>[‘pipe1’, ‘pipe2’]</p>
-<p>here the strings ‘pipe1’ and ‘pipe2’ are the names of this instance</p>
+<p>here, the strings ‘pipe1’ and ‘pipe2’ are the names of this instance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="components.storage.Storage.show">
<span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.show" title="Permalink to this definition"></a></dt>
-<dd><p>use the method to show the detail information about this instance, for example all attributes and name
-it should return a string like this</p>
+<dd><p>use the method to show the detailed information about this instance, for example all attributes and names.
+It should return a string like this:</p>
<p class="rubric">Examples</p>
<p>>> msmtrun.show()</p>
<p>#### pipelines ####</p>
@@ -206,7 +206,7 @@ it should return a string like this</p>
<span class="sig-name descname"><span class="pre">add_attrs_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#components.storage.Storage.add_attrs_dict" title="Permalink to this definition"></a></dt>
<dd><p>Add a flat Dictionary of key values as a set of attributes.</p>
<dl class="simple">
-<dt>dict<span class="classifier">str</span></dt><dd><p>The Dictionary consists of Key Value pairs, with the keys being the name of the attribute
+<dt>dict<span class="classifier">str</span></dt><dd><p>The Dictionary consists of Key Value pairs, with the keys being the names of the attribute
and the value being the value assigned to the attribute</p>
</dd>
</dl>
@@ -223,7 +223,7 @@ object: Any</p>
<div><p>an object which can be an instance of any class</p>
</div></blockquote>
<dl class="simple">
-<dt>object_string: str</dt><dd><p>an encoded string, maybe very long when the original object is large</p>
+<dt>object_string: str</dt><dd><p>an encoded string, maybe very long if the original object is large</p>
</dd>
</dl>
<dl class="field-list simple">
diff --git a/docs/build/html/_sources/Reference/components/dataset/index.rst.txt b/docs/build/html/_sources/Reference/components/dataset/index.rst.txt
index 286e4a0d99bd793250e89277911f5f0ecd4b68cd..406bb76208dce141ab36be5628317ea6fa053c59 100644
--- a/docs/build/html/_sources/Reference/components/dataset/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/dataset/index.rst.txt
@@ -29,7 +29,7 @@ Attributes
Bases: :py:obj:`Storage`
- An object of this class represent the dataset.
+ An object of this class represents the dataset.
At present, there is no requirement for the type of data, it is simply stored in the dataset.data attribute
and further processing will be performed according to the different data types read in.
diff --git a/docs/build/html/_sources/Reference/components/dataset_image/index.rst.txt b/docs/build/html/_sources/Reference/components/dataset_image/index.rst.txt
index 6c1a6d944334faa236ccf6576e53a059dacb6766..5ad864643a1188c42de930b3c3e05ef6991ea247 100644
--- a/docs/build/html/_sources/Reference/components/dataset_image/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/dataset_image/index.rst.txt
@@ -21,7 +21,7 @@ Classes
Bases: :py:obj:`Storage`
- An object of this class represents 1 image (Mulitple images havent been considered or investigated yet).
+ An object of this class represents 1 image (Multiple images have not been considered or investigated yet).
The user only needs to provide the path of the image, this class will read it using the pillow lib
diff --git a/docs/build/html/_sources/Reference/components/dataset_keyvalue/index.rst.txt b/docs/build/html/_sources/Reference/components/dataset_keyvalue/index.rst.txt
index d5b20d8498803c7e270c2832c19f35f205e80fba..e839695b1cf8742f35e0e78c86e6e0c78d14a876 100644
--- a/docs/build/html/_sources/Reference/components/dataset_keyvalue/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/dataset_keyvalue/index.rst.txt
@@ -21,7 +21,7 @@ Classes
Bases: :py:obj:`Storage`
- Dataset_KeyValue class is used as a converter between a dictionary formated in a HDF5 storable way to a hdf file
+ Dataset_KeyValue class is used as a converter between a dictionary formated in an HDF5 storable way to a hdf file
:param Name: Name of the whole HDF file/Run
@@ -41,10 +41,10 @@ Classes
Parameter:
1. see if dictname = parameter;
- 2. if last group = parameter, go into dict and create parameter for each (e.g.: gain, offset )
+ 2. if last group = parameter, go into dict and create parameter for each (e. g.: gain, offset )
3. Go into the parameters and add the attributes
- Data is similiar to parameter just that we add data instead
+ Data is similar to parameter, just that we add data instead
XXXXXXXXXX data kann also have attributes ----> How would attributes look in a JSON-> Dict?
@@ -52,10 +52,10 @@ Classes
_Group : str
- parameter to be used by the recursive function; describes the last "wrapper class" ( pipeline,instruments,model)
+ parameter to be used by the recursive function; describes the last "wrapper class" (pipeline,instruments,model)
_last_group : str
- parameter to be used by the resursive function
+ parameter to be used by the recursive function
Dict : list, tuple, dict
nested key value pairs -->
diff --git a/docs/build/html/_sources/Reference/components/dataset_video/index.rst.txt b/docs/build/html/_sources/Reference/components/dataset_video/index.rst.txt
index f052411228ce7649bfb858652185e98e64c48d47..b54d544ba2e0bce65242ebdda0f35e170db7b0a7 100644
--- a/docs/build/html/_sources/Reference/components/dataset_video/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/dataset_video/index.rst.txt
@@ -21,7 +21,7 @@ Classes
Bases: :py:obj:`Storage`
- An object of this class represent the video dataset.
+ An object of this class represents the video dataset.
:param name: the name of the dataset
:type name: str
@@ -48,7 +48,7 @@ Classes
.. py:method:: output_file(self, path_output)
- this function is designed to convert the binary format data into the origina format
+ this function is designed to convert the binary format data into the original format
:param path_output: the path of output
:type path_output: str
@@ -56,7 +56,7 @@ Classes
.. py:method:: convert_pics(self, path_output)
- this function is to convert the video file into frames segmentations
+ this function is to convert the video file into frame segmentations
:param path_output: the path of output
:type path_output: str
diff --git a/docs/build/html/_sources/Reference/components/index.rst.txt b/docs/build/html/_sources/Reference/components/index.rst.txt
index 6d27c7a4dc3b2e927ec75878a8df4e2b950a0d6e..a7572a34419bfd60177c37d625127d3d151777e1 100644
--- a/docs/build/html/_sources/Reference/components/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/index.rst.txt
@@ -44,15 +44,15 @@ Classes
.. py:class:: Storage(name)
- This class is an abstrcted class for all other class, providing initialization function with a name
- and store function to generate a hdf5 file
+ This class is an abstracted for all other classes, providing initialization function with a name
+ and store function to generate an HDF5 file
:param name: the name of the instant
:type name: str
.. py:method:: set_storage_path(self, path)
- set the storage path, where you want to store the hdf5 file
+ set the storage path where you want to store the HDF5 file
.. attention:: please always use "/" in path string instead of ""
@@ -63,7 +63,7 @@ Classes
.. py:method:: is_overwritable(self)
- .. py:method:: store_hdf5(self, root=None)
+ .. py:method:: store_HDF5(self, root=None)
.. py:method:: store_json(self, root=None)
@@ -74,8 +74,8 @@ Classes
.. py:method:: __str__(self)
- rewrite the builtin method to modify the behavious of print() for this instance
- to make the print result more readerable
+ rewrite the built-in method to modify the behaviors of print() for this instance
+ to make the print result more readable
before:
@@ -89,13 +89,13 @@ Classes
'run1'
- here the string 'run1' is the name of this instance
+ here, the string 'run1' is the name of this instance
.. py:method:: __repr__(self)
- rewrite the builtin method to modify the behavious of print() for a list of instances
- to make the print result more readerable
+ rewrite the built-in method to modify the behaviors of print() for a list of instances
+ to make the print result more readable
before:
@@ -109,13 +109,13 @@ Classes
['pipe1', 'pipe2']
- here the strings 'pipe1' and 'pipe2' are the names of this instance
+ here, the strings 'pipe1' and 'pipe2' are the names of this instance
.. py:method:: show(self)
- use the method to show the detail information about this instance, for example all attributes and name
- it should return a string like this
+ use the method to show the detailed information about this instance, for example all attributes and names.
+ It should return a string like this:
.. rubric:: Examples
@@ -151,7 +151,7 @@ Classes
Parameters:
-----------
dict : str
- The Dictionary consists of Key Value pairs, with the keys being the name of the attribute
+ The Dictionary consists of Key Value pairs, with the keys being the names of the attribute
and the value being the value assigned to the attribute
@@ -165,7 +165,7 @@ Classes
Returns:
--------
object_string: str
- an encoded string, maybe very long when the original object is large
+ an encoded string, maybe very long if the original object is large
.. py:method:: decode(self, object_string)
@@ -186,7 +186,7 @@ Classes
Bases: :py:obj:`Storage`
- An object of this class represents 1 image (Mulitple images havent been considered or investigated yet).
+ An object of this class represents 1 image (Multiple images have not been considered or investigated yet).
The user only needs to provide the path of the image, this class will read it using the pillow lib
@@ -214,7 +214,7 @@ Classes
Bases: :py:obj:`Storage`
- An object of this class represent the video dataset.
+ An object of this class represents the video dataset.
:param name: the name of the dataset
:type name: str
@@ -241,7 +241,7 @@ Classes
.. py:method:: output_file(self, path_output)
- this function is designed to convert the binary format data into the origina format
+ this function is designed to convert the binary format data into the original format
:param path_output: the path of output
:type path_output: str
@@ -249,7 +249,7 @@ Classes
.. py:method:: convert_pics(self, path_output)
- this function is to convert the video file into frames segmentations
+ this function is to convert the video file into frame segmentations
:param path_output: the path of output
:type path_output: str
@@ -260,7 +260,7 @@ Classes
Bases: :py:obj:`Storage`
- An object of this class represent the Parameter.
+ An object of this class represents the Parameter.
:param name: the name of the parameter
:type name: str
@@ -309,10 +309,10 @@ Classes
This class represents Datasets that are mapped from other datasets using a given model
- This can be used to convert the input of a sensor to its actual pysical data using the given model
- for example polynomals or lookup tables.
+ This can be used to convert the input of a sensor to its actual physical data using the given model,
+ for example polynomials or lookup tables.
- :param name: the name of the instument
+ :param name: the name of the instrument
:type name: str
.. rubric:: Examples
@@ -367,7 +367,7 @@ Classes
:param list_obj: a list of Instrument or Dataset object(s)
:type list_obj: List[Instrument | Dataset]
- :raises TypeError: raised when the element of list_obj is not the type of Instrument of Dataset
+ :raises TypeError: raised when the element of list_obj is not the type of Instrument or Dataset
:raises AssertionError: raised when list_obj is not a list or it is empty
diff --git a/docs/build/html/_sources/Reference/components/instrument/index.rst.txt b/docs/build/html/_sources/Reference/components/instrument/index.rst.txt
index 60d38fe56ffda89439b3b4877f37e0a25f0e2c16..595efb2cb8289bbe3cd0acc855a7b5399ac7cc7c 100644
--- a/docs/build/html/_sources/Reference/components/instrument/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/instrument/index.rst.txt
@@ -23,10 +23,10 @@ Classes
This class represents Datasets that are mapped from other datasets using a given model
- This can be used to convert the input of a sensor to its actual pysical data using the given model
- for example polynomals or lookup tables.
+ This can be used to convert the input of a sensor to its actual physical data using the given model,
+ for example polynomials or lookup tables.
- :param name: the name of the instument
+ :param name: the name of the instrument
:type name: str
.. rubric:: Examples
diff --git a/docs/build/html/_sources/Reference/components/parameter/index.rst.txt b/docs/build/html/_sources/Reference/components/parameter/index.rst.txt
index f50a1c0985c276ea89711024323794389543fdc0..21d219a6c0b27cb72986b910a20be14faebdecb0 100644
--- a/docs/build/html/_sources/Reference/components/parameter/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/parameter/index.rst.txt
@@ -21,7 +21,7 @@ Classes
Bases: :py:obj:`Storage`
- An object of this class represent the Parameter.
+ An object of this class represents the Parameter.
:param name: the name of the parameter
:type name: str
diff --git a/docs/build/html/_sources/Reference/components/pipeline/index.rst.txt b/docs/build/html/_sources/Reference/components/pipeline/index.rst.txt
index 5deb526e696157b05d1caf40ec4c6a86d2a6c408..1d5c2cf5312490e52afab4eea4e6bde562796dac 100644
--- a/docs/build/html/_sources/Reference/components/pipeline/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/pipeline/index.rst.txt
@@ -52,7 +52,7 @@ Classes
:param list_obj: a list of Instrument or Dataset object(s)
:type list_obj: List[Instrument | Dataset]
- :raises TypeError: raised when the element of list_obj is not the type of Instrument of Dataset
+ :raises TypeError: raised when the element of list_obj is not the type of Instrument or Dataset
:raises AssertionError: raised when list_obj is not a list or it is empty
diff --git a/docs/build/html/_sources/Reference/components/storage/index.rst.txt b/docs/build/html/_sources/Reference/components/storage/index.rst.txt
index 906195c5e57349afd44716570cb9034769611567..d3755a2d7dc2d658fb5643520b45f68ab440f94f 100644
--- a/docs/build/html/_sources/Reference/components/storage/index.rst.txt
+++ b/docs/build/html/_sources/Reference/components/storage/index.rst.txt
@@ -19,15 +19,15 @@ Classes
.. py:class:: Storage(name)
- This class is an abstrcted class for all other class, providing initialization function with a name
- and store function to generate a hdf5 file
+ This class is an abstracted for all other classes, providing initialization function with a name
+ and store function to generate an HDF5 file
:param name: the name of the instant
:type name: str
.. py:method:: set_storage_path(self, path)
- set the storage path, where you want to store the hdf5 file
+ set the storage path where you want to store the HDF5 file
.. attention:: please always use "/" in path string instead of ""
@@ -38,7 +38,7 @@ Classes
.. py:method:: is_overwritable(self)
- .. py:method:: store_hdf5(self, root=None)
+ .. py:method:: store_HDF5(self, root=None)
.. py:method:: store_json(self, root=None)
@@ -49,8 +49,8 @@ Classes
.. py:method:: __str__(self)
- rewrite the builtin method to modify the behavious of print() for this instance
- to make the print result more readerable
+ rewrite the built-in method to modify the behaviors of print() for this instance
+ to make the print result more readable
before:
@@ -64,13 +64,13 @@ Classes
'run1'
- here the string 'run1' is the name of this instance
+ here, the string 'run1' is the name of this instance
.. py:method:: __repr__(self)
- rewrite the builtin method to modify the behavious of print() for a list of instances
- to make the print result more readerable
+ rewrite the built-in method to modify the behaviors of print() for a list of instances
+ to make the print result more readable
before:
@@ -84,13 +84,13 @@ Classes
['pipe1', 'pipe2']
- here the strings 'pipe1' and 'pipe2' are the names of this instance
+ here, the strings 'pipe1' and 'pipe2' are the names of this instance
.. py:method:: show(self)
- use the method to show the detail information about this instance, for example all attributes and name
- it should return a string like this
+ use the method to show the detailed information about this instance, for example all attributes and names.
+ It should return a string like this:
.. rubric:: Examples
@@ -126,7 +126,7 @@ Classes
Parameters:
-----------
dict : str
- The Dictionary consists of Key Value pairs, with the keys being the name of the attribute
+ The Dictionary consists of Key Value pairs, with the keys being the names of the attribute
and the value being the value assigned to the attribute
@@ -140,7 +140,7 @@ Classes
Returns:
--------
object_string: str
- an encoded string, maybe very long when the original object is large
+ an encoded string, maybe very long if the original object is large
.. py:method:: decode(self, object_string)
diff --git a/docs/build/html/_sources/user/index.rst.txt b/docs/build/html/_sources/user/index.rst.txt
index 3c51c52786958450179846090fa5519cdb426412..cd68b722d696d06f4ad217b735b714d7e032043a 100644
--- a/docs/build/html/_sources/user/index.rst.txt
+++ b/docs/build/html/_sources/user/index.rst.txt
@@ -32,8 +32,8 @@ Now, we can add the first data to our HDF5 file. |br|
We start with a dataset. Below, you can see how to implement it. |br|
In the first line, we create the dataset1 which is called "msmt01".
This is done by using the constructor (add link to description) of the dataset class. |br|
-After that, we add the actual data. For this purpose, we use the ... function. In this case, we create some random numbers. |br|
-With the third line, we add an attribute to the dataset. Here, we specify samplerate we used while recording the data.
+After that, we add the actual data. For this purpose, create a random set of numbers and then add them to the data paramter of dataset1. |br|
+With the third line, we add an attribute to the dataset. Here, we specify the samplerate we used while recording the data.
The name of the parameter is determined in the brackets and the value is added with the equal sign. |br|
In the last line, another attribute is added. In this case, the attribute is a timestamp to document when the data was collected::
@@ -48,7 +48,7 @@ Modelling a sensor characteristic
Let's assume the data we collected was measured with a preasure sensor. The sensor creates a voltage signal as an output.
The voltage signal needs to be converted to a pressure value according to a characteristic curve.
-For this end, we will implement the characteristic curve as a parameter, add this parameter to a model and create an instrument from this model.
+To this end, we will implement the characteristic curve as a parameter, add this parameter to a model and create an instrument from this model.
Step by step: let's start with the parameter. |br|
In the following lines of code, we see how to implement the parameter object.
First, we create the object parameter1 and name it "gain" by writing so in the brackets. |br|
@@ -79,7 +79,7 @@ Structuring of the data
In the next step, we add our dataset to a pipeline object. Normally we add several datasets here to generate an array. |br|
At the same time, we store the metadata of the instruments used in a test rig in the pipeline module. |br|
-The main purpuse of the pipeline class is to struchture and organize the data. |br|
+The main purpose of the pipeline class is to struchture and organize the data. |br|
In the lines below, the object pipeline1 is created. In brackets, you can determine
the location where it is stored in the HDF5 file. Afterwards, we add the dataset1 to the pipeline1.
The last three lines contain metadata of the used instrument::
@@ -110,12 +110,12 @@ Now, we can add the pipeline object and the parameter object to the run object::
msmtrun.add([parameter1])
****************************
-Create and store hdf5 file
+Create and store HDF5 file
****************************
Before we can export our HDF5 file, we need to specify the location where it should be saved and the name of the file.
-Pay attention that you use the slash symbol "/" instead of backslash "\" to determine the location
-and pay attention that you choose a name for you file plus the ending ".h5"::
+Pay attention that you use the slash symbol "/" instead of backslash "\\" to determine the location
+and pay attention that you choose a name for your file plus the ending ".h5"::
msmtrun.set_storage_path("C:/Users/Example/PYKKN/example_for_docs.h5")
@@ -125,20 +125,22 @@ This is how we can ensure to export the whole file::
msmtrun.store()
Now, let's have a look at the created HDF5 file. Below, you can see a picture of the created file.
-The structure is fully expanded and an open source HDF5 viewer is used to show it.
-On the left side, you can see the structe of the file we created.
+The structure is fully expanded and an open-source HDF5 viewer is used to show it.
+On the left side, you can see the structe of the file we created:
.. image:: user-images/example-project/example-project_overviewWholeProject.png
+
+
.. end of example project
.. start of example project how to impkement an Excel csv file
============================================
-Example project import of an .csv file
+Example project import of a .csv object
============================================
-In the following project, we will show you how to store data from a csv table in a HDF5 file using PYKKN. |br|
-This might be usefull when you for example have stored your data in an Excel sheet. With Excel you can then export th efile as a csv file and store it into hdf5.
+In the following project, we will show you how to store data from a csv table in an HDF5 file using PYKKN. |br|
+This might be usefull if, for example, your data is stored in an Excel sheet. With Excel, you can then export the file as a csv file and store it into HDF5.
As an example, look at the following table:
.. csv-table:: Example Table
@@ -161,7 +163,7 @@ Let's start by setting up the project as usual, though in this short case we wou
import numpy as np
-In this case, it is important to add the panda framework as well because we will use this to store the csv file::
+In this case, it is important to add the panda framework as well because we will use this to store the CSV file::
import panda as pd
@@ -169,7 +171,7 @@ In this case, it is important to add the panda framework as well because we will
Inserting and storing of the data
*********************************
-At first, we will store the .csv file as a variable which we can then add to dataset object. To do this, we use the function read_csv() from the panda framework::
+At first, we will store the CSV file as a variable which we can then add to dataset object. To do this, we use the function read_csv() from the panda framework::
df = pd.read_csv("test_data.csv")
@@ -193,11 +195,11 @@ The output of this short project can be seen below:
.. start of the explanation of the recurring functionalities of the differen modules
=======================================
-Rcurring functionalities and attributes
+Recurring functionalities and attributes
=======================================
In PYKKN, you will find several functions that are avalaible in different modules. To achieve this, the library is based on object-oriented programming
-and several modules inherit functions from the storable class. The functions of this class will be explained below in more detail to avoid explaning again for each module.
+and several modules inherit functions from the storable class. The functions of this class will be explained below in more detail to avoid explaining again for each module.
For further information about the storable class, you can visit the API reference. (add link to API refrence) |br|
To give you a brief overview of the classtructure of PYKKN you can have a look at the UML diagram below (feel free to click on the graphic to zoom in):
@@ -209,12 +211,10 @@ The following modules inherit from the storage class (add links to the api refer
* dataset
* dataset_image
-* dataset_keyValue
+* dataset_keyvalue
* dataset_video
* instrument
* model
-* instrument
-* model
* parameter
* pipeline
* run
@@ -225,14 +225,14 @@ All the objects that are created from these classes can use the following functi
set_storage_path(path: str)
****************************
-Every object that is created from theses classes can export HDF5 file.
+Every object that is created from theses classes can export HDF5 files.
Before doing so, the storage path needs to be defined. Therefore, you add the storage path
to the function as a parameter. The storage path needs to be in quotation marks ("") and end on the name
of the HDF5 file plus the ending ".h5". Here, you can see an example::
data1.set_storage_path("C:/Users/Example/data1.h5")
-Be aware to use the slash symbol "/" instead of backslash "\".
+Be aware to use the slash symbol "/" instead of backslash "\\".
*******
store()
@@ -297,9 +297,9 @@ Dataset module
With the dataset module, you are able to store an array of numbers.
As PYKKN is made for scientific research, the dataset modle is typically used when
storing measured data from a test rig. Apart from the pure data, it is possible to
-store metadata such as samplerate and timestamp. |br|
+store metadata such as the samplerate and the timestamp. |br|
-To create a dataset object, the constructer is needed.
+To create a dataset object, the constructor is needed.
The parameter of the constructor determines the name of the dataset.
This is also the name shown in the HDF5 file in the end.
You can see an example here::
@@ -323,9 +323,9 @@ The samplerate is represented as a number in 1/s. The timestamp should have the
dataset1.attrs['timestamp'] = '2022-06-12 10:39:11'
If you want to create an HDF5 file from this dataset, it possible to do so.
-In PYKKN it is possible to create a HDF5 file from every single object that is created.
+In PYKKN it is possible to create an HDF5 file from every single object that is created.
Therefore, we first set up the storage path by writing it in the brackets of the set_storage_path() function.
-Keep in mind to use the slash symbol "/" in the path instead of backslash "\" and add the name plus ".h5" in the end of the path::
+Keep in mind to use the slash symbol "/" in the path instead of backslash "\\" and add the name plus ".h5" in the end of the path::
dataset1.set_storage_path('test/test_ut_ds.h5')
@@ -339,8 +339,8 @@ Dataset image
With this module, the user is enabled to store an image in the HDF5 file. If you are dealing with a video, please use dataset_video module
instead of trying to store it as an array of images with this module. There are two steps to implement an image.
-First, you create an object of the datasat_image class and give it a name when using the constructor in this case the name is "image_dataset_1.
-Afterwards, you add the path of the image where it stored to PYKKN can collect the data::
+First, you create an object of the datasat_image class and give it a name when using the constructor. In this case the name is "image_dataset_1.
+Afterwards, you add the path of the image where it is stored so PYKKN can collect the data::
datasetImage1 = Dataset_Image('image_dataset_1')
datasetImage1.data = "/test/test_rig_1.jpg"
@@ -356,7 +356,7 @@ Dataset video
**************
If you want to store a video in your HDF5 file, you can use this module. The usage is very similar to the image module.
-First, create an object that represents the video you want to store. Then,add the storage path. If you want, you can also
+First, create an object that represents the video you want to store. Then, add the storage path. If you want, you can also
add the timestamp as metadata::
datasetVideo1 = Dataset_Video('video_dataset_1')
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
index 291f493ce24d423d19e7c7a9323d0b55a50288fc..631fde6c136c4aa21691b8f1287934c72256710f 100644
--- a/docs/build/html/genindex.html
+++ b/docs/build/html/genindex.html
@@ -426,10 +426,10 @@
<li><a href="reference/components/storage/index.html#components.storage.Storage.store">(components.storage.Storage method)</a>
</li>
</ul></li>
- <li><a href="reference/components/index.html#components.Storage.store_hdf5">store_hdf5() (components.Storage method)</a>
+ <li><a href="reference/components/index.html#components.Storage.store_HDF5">store_HDF5() (components.Storage method)</a>
<ul>
- <li><a href="reference/components/storage/index.html#components.storage.Storage.store_hdf5">(components.storage.Storage method)</a>
+ <li><a href="reference/components/storage/index.html#components.storage.Storage.store_HDF5">(components.storage.Storage method)</a>
</li>
</ul></li>
<li><a href="reference/components/index.html#components.Storage.store_json">store_json() (components.Storage method)</a>
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
index 6087233eef7fcae41d1dbc848fe5f504c3d48cb4..7a37b78cf8120d909e88380e912cefccfc7e330e 100644
Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
index d4b116784f3dfda583e0892e435311fc077b93a8..31f6b3af1a4ac2476cdda600f1382367964ecf45 100644
--- a/docs/build/html/searchindex.js
+++ b/docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["index","reference/components/dataset/index","reference/components/dataset_image/index","reference/components/dataset_keyvalue/index","reference/components/dataset_video/index","reference/components/index","reference/components/instrument/index","reference/components/model/index","reference/components/parameter/index","reference/components/pipeline/index","reference/components/run/index","reference/components/storage/index","reference/index","start/index","user/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","reference\\components\\dataset\\index.rst","reference\\components\\dataset_image\\index.rst","reference\\components\\dataset_keyvalue\\index.rst","reference\\components\\dataset_video\\index.rst","reference\\components\\index.rst","reference\\components\\instrument\\index.rst","reference\\components\\model\\index.rst","reference\\components\\parameter\\index.rst","reference\\components\\pipeline\\index.rst","reference\\components\\run\\index.rst","reference\\components\\storage\\index.rst","reference\\index.rst","start\\index.rst","user\\index.rst"],objects:{"":[[5,0,0,"-","components"]],"components.Dataset_Image":[[5,2,1,"","data"],[5,2,1,"","output_file"]],"components.Dataset_Video":[[5,2,1,"","convert_pics"],[5,2,1,"","data"],[5,2,1,"","output_file"]],"components.Instrument":[[5,2,1,"","add"]],"components.Model":[[5,2,1,"","add"]],"components.Pipeline":[[5,2,1,"","add"]],"components.Run":[[5,2,1,"","add"]],"components.Storage":[[5,2,1,"","__repr__"],[5,2,1,"","__str__"],[5,2,1,"","add_attrs_dict"],[5,2,1,"","decode"],[5,2,1,"","encode"],[5,2,1,"","is_overwritable"],[5,2,1,"","set_storage_path"],[5,2,1,"","show"],[5,2,1,"","store"],[5,2,1,"","store_hdf5"],[5,2,1,"","store_json"]],"components.dataset":[[1,1,1,"","Dataset"],[1,3,1,"","d"]],"components.dataset_image":[[2,1,1,"","Dataset_Image"]],"components.dataset_image.Dataset_Image":[[2,2,1,"","data"],[2,2,1,"","output_file"]],"components.dataset_keyvalue":[[3,1,1,"","Dataset_KeyValue"]],"components.dataset_keyvalue.Dataset_KeyValue":[[3,2,1,"","nested_dict"]],"components.dataset_video":[[4,1,1,"","Dataset_Video"]],"components.dataset_video.Dataset_Video":[[4,2,1,"","convert_pics"],[4,2,1,"","data"],[4,2,1,"","output_file"]],"components.instrument":[[6,1,1,"","Instrument"]],"components.instrument.Instrument":[[6,2,1,"","add"]],"components.model":[[7,1,1,"","Model"]],"components.model.Model":[[7,2,1,"","add"]],"components.parameter":[[8,1,1,"","Parameter"]],"components.pipeline":[[9,1,1,"","Pipeline"]],"components.pipeline.Pipeline":[[9,2,1,"","add"]],"components.run":[[10,1,1,"","Run"]],"components.run.Run":[[10,2,1,"","add"]],"components.storage":[[11,1,1,"","Storage"]],"components.storage.Storage":[[11,2,1,"","__repr__"],[11,2,1,"","__str__"],[11,2,1,"","add_attrs_dict"],[11,2,1,"","decode"],[11,2,1,"","encode"],[11,2,1,"","is_overwritable"],[11,2,1,"","set_storage_path"],[11,2,1,"","show"],[11,2,1,"","store"],[11,2,1,"","store_hdf5"],[11,2,1,"","store_json"]],components:[[5,1,1,"","Dataset_Image"],[5,1,1,"","Dataset_Video"],[5,1,1,"","Instrument"],[5,1,1,"","Model"],[5,1,1,"","Parameter"],[5,1,1,"","Pipeline"],[5,1,1,"","Run"],[5,1,1,"","Storage"],[1,0,0,"-","dataset"],[2,0,0,"-","dataset_image"],[3,0,0,"-","dataset_keyvalue"],[4,0,0,"-","dataset_video"],[6,0,0,"-","instrument"],[7,0,0,"-","model"],[8,0,0,"-","parameter"],[9,0,0,"-","pipeline"],[10,0,0,"-","run"],[11,0,0,"-","storage"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:data"},terms:{"0":14,"00":14,"001":[],"009":[],"01":14,"023":14,"038":14,"040":14,"042":[],"05":14,"050":[],"06":[1,4,5,14],"064":[],"068":14,"071":[],"073":[],"077":[],"08":[],"087":14,"091":[],"093":14,"0x0000022aa45715a0":[5,11],"0x0000022aa4gd1s0":[5,11],"1":[1,2,3,5,8,12,14],"10":[1,13,14],"1000":[1,14],"108":[],"11":[1,4,5,14],"110":14,"112":14,"113":14,"12":[1,14],"122":14,"123":[],"126":[],"127":[],"12_pykkn_umldiagram_clearbackground":[],"13":[4,5,14],"130":[],"137":[],"14":14,"141":[],"142":[],"147":[],"148":[],"15":14,"152":14,"157":[],"163":14,"164":14,"167":14,"176":14,"177":[],"179":[],"18":14,"194":[],"2":[3,5,11,13,14],"20":14,"2017":14,"202":14,"2022":[1,4,5,14],"203":[],"21":14,"22":[4,5,14],"221":[],"223":[],"224":[],"226":[],"228":[],"245":[],"247":[],"248":[],"25":14,"254":[],"261":14,"262":14,"265":[],"269":14,"278":[],"297":[],"3":[3,13,14],"30":14,"303":[],"305":[],"307":[],"315":[],"317":14,"328":[],"342":[],"35":14,"350":14,"365":[],"367":[],"368":[],"370":[],"375":[],"376":[],"377":[],"381":14,"384":14,"385":[],"389":[],"39":[1,14],"396":14,"4":14,"40":14,"402":14,"404":[],"422":14,"429":14,"433":[],"437":[],"44":14,"441":[],"442":14,"443":[],"448":[],"45":14,"451":[],"452":[],"456":[],"461":14,"473":[],"475":14,"476":14,"477":[],"481":14,"486":[],"490":[],"5":14,"50":14,"500":[],"504":[],"510":14,"512":[],"515":14,"523":[],"536":[],"545":14,"55":14,"550":14,"552":[],"559":[],"560":[],"581":[],"584":14,"6":14,"60":14,"601":[],"602":[],"605":[],"612":14,"613":[],"621":14,"622":14,"640":14,"65":14,"653":14,"674":[],"679":14,"691":[],"694":14,"695":[],"7":14,"70":[5,11,14],"713":14,"720":[],"738":[],"739":[],"741":[],"743":[],"75":14,"772":[],"773":[],"776":[],"780":[],"789":[],"791":[],"796":14,"8":14,"80":14,"808":[],"809":14,"815":[],"827":[],"828":14,"832":[],"834":14,"838":[],"844":[],"846":[],"848":14,"85":14,"853":[],"854":14,"862":[],"872":[],"876":[],"881":[],"883":14,"884":14,"898":14,"899":[],"9":[],"90":14,"900":[],"903":14,"909":14,"918":14,"919":[],"920":14,"922":14,"930":14,"944":[],"945":[],"95":14,"955":[],"967":[],"970":[],"972":[],"974":14,"976":[],"980":[],"982":[],"989":14,"992":[],"case":14,"class":14,"do":[13,14],"export":[2,5,14],"function":[0,2,3,4,5,11],"long":[5,11],"return":[5,11],"short":14,"try":14,"while":14,As:14,At:[1,13,14],Be:14,But:[],For:14,If:[13,14],In:14,On:14,That:[],The:[0,2,3,5,11,13,14],Then:14,There:14,To:[0,14],With:14,__repr__:[5,11],__str__:[5,11],_description_:[5,11],_group:3,_kei:3,_last_group:3,_nested_group:3,_record:[4,5,14],_static:[],_templat:[],aa:[5,11],abl:14,about:[5,11,14],abstrct:[5,11],access:14,accord:[1,14],accrod:[],achiev:14,activ:13,actual:[5,6,14],ad:[5,6,14],add:[3,5,6,7,9,10,11],add_attrs_dict:[5,11],administr:[3,4,5,14],adp:[],after:[5,11,14],afterward:14,again:14,aif:[],all:[5,11,13,14],also:[3,14],alwai:[5,11],an:[0,1,2,4,5,8,11],anaconda:13,ani:[5,11,14],anoth:14,anyth:[5,11],apart:14,api:[0,14],ar:[5,6,11,13,14],arrai:14,assertionerror:[5,6,7,9,10],assign:[5,11,14],assum:14,ataset1:[2,4,5],attach:14,attent:14,attr:[1,4,5,8,9],attribut:[3,5,11],author:[5,11,14],auto:12,autoapi:12,autoapi_dir:[],autoapi_root:[],autodoc:[],autodoc_typehint:[],avala:14,avoid:14,awar:14,backslash:14,base:[1,2,3,4,5,6,7,8,9,10,13,14],bb:[5,11],becaus:14,been:[2,5],befor:[5,11,14],behavi:[5,11],behind:14,being:[5,11],below:[13,14],between:[3,13],binari:[4,5],bracket:14,brief:14,build:[],build_multi_paramet:[],builtin:[5,11],c:[3,4,5,13,14],call:[3,14],can:[0,5,6,11,13,14],capa1:[5,9,14],capa:[5,9],captur:[4,5,14],cc:[5,11],channel_01_raw:[],channel_01_sc:[],channel_02_raw:[],channel_02_sc:[],channel_03_raw:[],channel_03_sc:[],channel_04_raw:[],channel_04_sc:[],channel_05_raw:[],channel_05_sc:[],channel_06_raw:[],channel_06_sc:[],channel_07_raw:[],channel_07_sc:[],channel_08_raw:[],channel_08_sc:[],channel_09_raw:[],channel_09_sc:[],channel_10_raw:[],channel_10_sc:[],check:[5,11],choos:14,classtructur:14,click:14,cm:[5,8],code:14,collec:[],collect:14,color:[],com:13,command:[13,14],comment:[],compar:14,compon:12,conda:13,conduct:[],conf:[],conflict:13,consid:[2,5],consist:[5,11],construct:14,constructor:14,contain:[0,5,9,12,14],content:14,convert:[3,4,5,6,14],convert_p:[4,5],converter_01:[],converter_01_raw2:[],converter_01_raw:[],converter_02:[],converter_02_raw2:[],converter_02_raw:[],converter_03:[],converter_03_raw2:[],converter_03_raw:[],converter_04:[],converter_04_raw2:[],converter_04_raw:[],converter_05:[],converter_05_raw2:[],converter_05_raw:[],converter_06:[],converter_06_raw2:[],converter_06_raw:[],converter_07:[],converter_07_raw2:[],converter_07_raw:[],converter_08:[],converter_08_raw2:[],converter_08_raw:[],converter_09:[],converter_09_raw2:[],converter_09_raw:[],converter_10:[],converter_10_raw2:[],converter_10_raw:[],copyright:[],correspond:13,creat:[3,12,13],create_inst:[],curv:14,d:1,data1:14,data:[0,1,2,3,4,5,6,7],datasat:14,datasat_imag:14,dataseimage1:14,dataset1:[1,2,4,5,9,14],dataset2:[5,9],dataset:[2,4,5,6,9,12],dataset_data_pars:[],dataset_imag:[5,12,14],dataset_keyvalu:[5,12,14],dataset_video:[5,12,14],datasetimage1:14,datasetvideo1:14,dd:[5,11,14],deal:14,decod:[5,11],defin:14,depend:13,dergeraet:[5,11,14],deriv:[5,9],describ:[0,3],descript:[0,14],design:[2,4,5],desktop:3,detail:[0,5,11,13,14],determin:14,df:14,diagram:14,dic:[],dict:[3,5,11],dicti:3,dictionari:[3,5,11,14],dictnam:3,dicttohdf_1:3,differ:[0,1,14],difficulti:13,distribut:13,doc:13,document:[12,14],done:14,doubl:[1,14],e:3,each:[3,13,14],ee:[5,11],efil:14,ein:[],element:[5,9],empti:[5,9],en:13,enabl:14,encod:[5,11],encount:13,end:14,ensur:14,environ:[0,13],equal:14,establish:13,everi:14,exampl:[0,1,2,3,4,5,6,7,8,9,10,11],example_for_doc:14,excel:14,exclude_pattern:[],execut:13,expand:14,expect:3,experi:[0,5,7],experimentel:[],explain:14,explan:14,ext:[],extens:14,fail:[5,6,7,10],feedback:13,feedthrough:14,feel:14,ff:[5,11],file:[0,3,4,5,11],file_example_mp4_1920_18mg:[],filenam:[],find:14,first:0,flat:[5,11,14],flowmet:[],follow:[5,9,14],forg:13,form:[5,11,14],format:[3,4,5,11],found:13,frame:[4,5],framework:14,free:14,from:[5,6,14],fucntion:[],fulli:14,further:[1,14],g:3,gain:[3,14],gener:[5,11,12,14],get:[0,3],gitlab:13,give:[13,14],given:[5,6],go:3,graphic:14,group:3,guid:0,h5:[1,3,4,5,14],h5_create_run_exampl:[],h5_create_run_example2:[],h5py:13,ha:13,handl:0,have:[3,14],havent:[2,5],hdf5:[0,3,5,11],hdf:3,here:[0,5,11,14],hh:14,how:[0,3,14],html:13,html_static_path:[],html_theme:[],http:13,imag:[2,5],image_data_pars:[],image_dataset_1:[2,5,14],imgag:[],implement:14,includ:0,index:0,inform:[5,9,11,14],inharetat:[],inherit:14,initi:[5,11],input:[0,5,6],instal:[0,13],instanc:[5,11],instant:[5,11],instead:[3,5,11,14],instr1:[],instr2:[],instrument1:[5,6,9,14],instrument:[3,5,9,12],instument:[5,6],insturment2:[5,9],investig:[2,5],io:13,is_overwrit:[5,11],its:[5,6,11],itself:14,jpg:[2,5,14],json:3,just:3,kann:3,keep:14,kei:[3,5,11],kind:14,larg:[5,11],last:[3,14],latest:13,left:14,let:14,lib:[2,5],librari:[0,13,14],like:[0,5,11],line:14,link:[0,14],linux:13,list:[3,5,6,7,9,10,11],list_obj:[5,6,7,9,10],list_of_paramet:[],locat:14,look:[3,14],lookup:[5,6],loos:[],lose:14,ls:[],made:14,main:14,make:[5,11],manag:13,mandatori:14,map:[5,6],mark:14,mayb:[5,11],measur:[5,9,14],measureddata:14,metad:[],metadata:14,metatadata:14,metatdata:[],method:[0,5,6,7,10,11],might:14,mind:14,miniconda:13,mix:14,mm:14,model1:[5,6,7,14],model2:[5,6],model:[3,5,6,9,12],modifi:[5,11],modl:14,modul:0,more:[5,11,14],mp4:[4,5,14],msmt01:14,msmt_type:[],msmtrun:[5,11,14],mulitpl:[2,5],multi:[5,6,7,9,10],mydictionari:14,n:13,name:[1,2,3,4,5,6,7,8,9,10,11],name_of_parameter_1:[],name_of_parameter_2:[],name_of_parameter_3:[],nameofdataset:14,napoleon:[],need:[2,5,14],nest:3,nested_dict:3,next:14,none:[3,5,11],normal:14,note:13,now:14,np:[1,14],number:14,numpi:[13,14],obj:[],object:[0,1,2,4,5,6,7,8,9,10,11,14],object_str:[5,11],offset:3,oil:[5,11,14],oil_id:[],oil_typ:[],one:14,onli:[2,5],open:14,opencv:13,opportun:14,opt_in:[],organ:14,orient:14,origin:[5,8,9,11,14],origina:[4,5],other:[5,6,11,13,14],our:14,outcom:[],output:[4,5,14],output_fil:[2,4,5],overrid:[],overview:14,overwrit:14,pa06:[5,11,14],packag:13,page:[0,12,13],pai:14,pair:[3,5,11],panda:[13,14],para1:[5,8],para2:[],param_kh1:[],param_kh2:[],param_pressure1:[],param_pressure2:[],param_rotspeed1:[],param_rotspeed2:[],param_temp1:[],param_temp2:[],param_temp3:[],param_torque1:[],param_torque2:[],param_volflow1:[],param_volflow2:[],paramet:[0,1,2,3,4,5,6,7,9,10,11,12],parameter1:[5,7,10,14],parameter2:[5,7,10],parametr:[],paremet:[],pars:[],parse_json:[],part:14,parti:13,path:[2,3,4,5,11],path_output:[4,5],pd:14,perform:1,pictur:14,pillow:[2,5],pipe1:[5,11],pipe2:[5,11],pipelin:[3,5,10,11,12],pipeline1:[5,9,10,14],pipeline2:[5,10],pleas:[5,11,14],plu:14,pmanag:[5,11,14],png:[],point:14,polynom:[5,6],porpos:14,porpus:[],possibl:14,powershel:13,preasur:14,preasuredata:14,preasuresensor:[],present:1,pressur:14,print:[5,11],process:[1,5,7],product:13,program:14,project:13,project_manag:[],prompt:13,properti:[2,4,5],provid:[2,5,11,14],pump_manufactur:[],pump_typ:[],pure:14,purpos:[13,14],purpus:14,py:13,pykkn:[3,14],pykkn_env:13,pykkn_pars:[],pykraken:14,pysic:[5,6],python:[0,13,14],quotat:14,r:[4,5],rais:[5,6,7,9,10],rand:14,random:14,raw:[5,9,14],read:[1,2,5],read_csv:14,reader:[5,11],recommend:13,record:14,recurs:3,recursive_create_inst:[],refer:[0,14],refrenc:14,releas:[],relev:13,repositori:0,repres:[1,2,4,5,6,7,8,9,10,14],requir:1,research:[0,14],result:[5,11],resurs:3,rewrit:[5,11],rick:[],rig:14,root:[5,11],rs1:[],run1:[3,5,10,11,14],run:[3,5,11,12,13],runnam:[],s:[5,6,7,9,10,14],same:[13,14],sampler:[1,14],save:[0,14],scale:[5,9],scientif:[0,14],search:0,see:[0,3,14],seen:14,segment:[4,5],self:[2,3,4,5,6,7,9,10,11],sensor:[5,6],seri:14,set:[0,5,11,14],set_storage_path:[1,4,5,11],sever:14,sheet:14,should:[5,9,11,13,14],show:[0,5,11],shown:14,shwon:[],side:14,sign:14,signal:14,similar:14,similiar:3,simpli:1,singl:[3,14],slash:14,so:[13,14],sof:[],some:14,sourc:[0,14],specifi:13,sphinx:12,sphinx_panel:[],sphinx_rtd_them:[],ss:14,start:[0,3],stemp:[],step:0,storabl:[3,14],storag:[1,2,3,4,5,6,7,8,9,10,12,14],store:[0,1,4,5,11],store_hdf5:[5,11],store_json:[5,11],str:[1,2,3,4,5,6,7,8,9,10,11],string:[5,11],struchtur:14,struct:14,structur:[3,5,10],success:13,support:0,svg:[],symbol:14,system:13,tabel:[],tabl:[5,6],targetrp:[5,11,14],targettmp:[5,11,14],tcorn:[5,11,14],templates_path:[],termin:13,test:[1,2,3,4,5,14],test_data:14,test_data_typ:[],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_file_exist:[],test_image_attr:[],test_instru:[],test_key_valu:3,test_meet:[4,5,14],test_model:[],test_nam:[],test_other_attr:[],test_other_attribut:[],test_param:[],test_paramet:[],test_pipelin:[],test_resourc:[],test_result:[],test_rig_1:[2,5,14],test_run:[],test_samplerate_typ:[],test_samplerate_valu:[],test_timestamp:[],test_ut_d:[1,14],test_ut_video:[4,5],test_valu:[],test_video_attr:[],test_wrong_para_input:[],testrig_nam:[],th:14,them:[],therefor:14,theses:14,thi:[1,2,4,5,6,7,8,9,10,11,12,13,14],third:[13,14],though:14,thre:[],three:14,through:14,time:[0,13,14],timestamp:[1,4,5,14],timestemp:14,tool:13,transfer:[],transmitt:14,tupl:3,tutori:13,two:14,type:[0,1,5,9,11,14],typeerror:[5,9],typenunabhaengigen:[],typic:14,uml:14,unit:[5,8,9,14],unix:13,up:[0,14],us:[0,2,3,5,6,7,11,13,14],usag:14,useful:14,user:[0,2,3,4,5,14],usersadministr:[4,5],usual:14,validierung:[],valu:[3,5,8,11],variabl:[5,8,9,14],verdraengerpumpen:[],veri:[5,11,14],verifi:13,version:13,via:[],video:[4,5],video_data_pars:[],video_dataset_1:[4,5,14],viewer:14,virtual:13,visit:14,volt:[5,9,14],voltag:[5,9,14],vom:[],von:[],wa:[13,14],wai:[3,14],want:[5,11,14],we:[0,3,13,14],welcom:13,well:14,wetak:[],when:[5,6,7,9,10,11,14],where:[5,11,14],whether:13,which:[0,5,11,14],who:[5,11],whole:[3,14],wide:14,window:13,wirkungsgradmodel:[],work:0,would:[3,14],wrapper:3,write:[13,14],wrting:[],www:13,xxxxxxxxxx:3,yet:[2,5],you:[0,5,11,13,14],your:[0,13,14],yyyi:14,zoom:14},titles:["Welcome to PYKKN\u2019s documentation!","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset_image</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset_keyvalue</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset_video</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.instrument</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.model</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.parameter</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.pipeline</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.run</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.storage</span></code>","API Reference","Getting Started","Getting Started"],titleterms:{"class":[1,2,3,4,5,6,7,8,9,10,11],"function":14,"import":14,add:14,add_attrs_dict:14,an:14,api:12,attr:14,attribut:[1,14],build_multi_paramet:[],characterist:14,compon:[1,2,3,4,5,6,7,8,9,10,11],conf:[],content:[1,2,3,4,5,6,7,8,9,10,11],creat:14,csv:14,data:14,dataset:[1,14],dataset_imag:2,dataset_keyvalu:3,dataset_video:4,dict:14,document:0,exampl:14,example_for_doc:[],excel:[],file:14,first:14,get:[13,14],h5_create_run_exampl:[],h5_create_run_example2:[],hdf5:14,imag:14,indic:0,insert:14,instrument:[6,14],kei:14,model:[7,14],modul:[1,2,3,4,6,7,8,9,10,11,14],name:14,packag:5,pair:14,paramet:[8,14],pars:[],parse_json:[],path:14,pipelin:[9,14],project:14,pykkn:0,rcur:14,refer:12,run:[10,14],s:0,sensor:14,set_storage_path:14,setup:14,show:14,specifi:14,start:[13,14],step:14,storag:11,store:14,str:14,structur:14,submodul:5,tabl:[0,14],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_instru:[],test_model:[],test_paramet:[],test_pipelin:[],test_run:[],valu:14,video:14,welcom:0}})
\ No newline at end of file
+Search.setIndex({docnames:["index","reference/components/dataset/index","reference/components/dataset_image/index","reference/components/dataset_keyvalue/index","reference/components/dataset_video/index","reference/components/index","reference/components/instrument/index","reference/components/model/index","reference/components/parameter/index","reference/components/pipeline/index","reference/components/run/index","reference/components/storage/index","reference/index","start/index","user/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["index.rst","reference\\components\\dataset\\index.rst","reference\\components\\dataset_image\\index.rst","reference\\components\\dataset_keyvalue\\index.rst","reference\\components\\dataset_video\\index.rst","reference\\components\\index.rst","reference\\components\\instrument\\index.rst","reference\\components\\model\\index.rst","reference\\components\\parameter\\index.rst","reference\\components\\pipeline\\index.rst","reference\\components\\run\\index.rst","reference\\components\\storage\\index.rst","reference\\index.rst","start\\index.rst","user\\index.rst"],objects:{"":[[5,0,0,"-","components"]],"components.Dataset_Image":[[5,2,1,"","data"],[5,2,1,"","output_file"]],"components.Dataset_Video":[[5,2,1,"","convert_pics"],[5,2,1,"","data"],[5,2,1,"","output_file"]],"components.Instrument":[[5,2,1,"","add"]],"components.Model":[[5,2,1,"","add"]],"components.Pipeline":[[5,2,1,"","add"]],"components.Run":[[5,2,1,"","add"]],"components.Storage":[[5,2,1,"","__repr__"],[5,2,1,"","__str__"],[5,2,1,"","add_attrs_dict"],[5,2,1,"","decode"],[5,2,1,"","encode"],[5,2,1,"","is_overwritable"],[5,2,1,"","set_storage_path"],[5,2,1,"","show"],[5,2,1,"","store"],[5,2,1,"","store_HDF5"],[5,2,1,"","store_json"]],"components.dataset":[[1,1,1,"","Dataset"],[1,3,1,"","d"]],"components.dataset_image":[[2,1,1,"","Dataset_Image"]],"components.dataset_image.Dataset_Image":[[2,2,1,"","data"],[2,2,1,"","output_file"]],"components.dataset_keyvalue":[[3,1,1,"","Dataset_KeyValue"]],"components.dataset_keyvalue.Dataset_KeyValue":[[3,2,1,"","nested_dict"]],"components.dataset_video":[[4,1,1,"","Dataset_Video"]],"components.dataset_video.Dataset_Video":[[4,2,1,"","convert_pics"],[4,2,1,"","data"],[4,2,1,"","output_file"]],"components.instrument":[[6,1,1,"","Instrument"]],"components.instrument.Instrument":[[6,2,1,"","add"]],"components.model":[[7,1,1,"","Model"]],"components.model.Model":[[7,2,1,"","add"]],"components.parameter":[[8,1,1,"","Parameter"]],"components.pipeline":[[9,1,1,"","Pipeline"]],"components.pipeline.Pipeline":[[9,2,1,"","add"]],"components.run":[[10,1,1,"","Run"]],"components.run.Run":[[10,2,1,"","add"]],"components.storage":[[11,1,1,"","Storage"]],"components.storage.Storage":[[11,2,1,"","__repr__"],[11,2,1,"","__str__"],[11,2,1,"","add_attrs_dict"],[11,2,1,"","decode"],[11,2,1,"","encode"],[11,2,1,"","is_overwritable"],[11,2,1,"","set_storage_path"],[11,2,1,"","show"],[11,2,1,"","store"],[11,2,1,"","store_HDF5"],[11,2,1,"","store_json"]],components:[[5,1,1,"","Dataset_Image"],[5,1,1,"","Dataset_Video"],[5,1,1,"","Instrument"],[5,1,1,"","Model"],[5,1,1,"","Parameter"],[5,1,1,"","Pipeline"],[5,1,1,"","Run"],[5,1,1,"","Storage"],[1,0,0,"-","dataset"],[2,0,0,"-","dataset_image"],[3,0,0,"-","dataset_keyvalue"],[4,0,0,"-","dataset_video"],[6,0,0,"-","instrument"],[7,0,0,"-","model"],[8,0,0,"-","parameter"],[9,0,0,"-","pipeline"],[10,0,0,"-","run"],[11,0,0,"-","storage"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:data"},terms:{"0":14,"00":14,"001":[],"009":[],"01":14,"023":14,"038":14,"040":14,"042":[],"05":14,"050":[],"06":[1,4,5,14],"064":[],"068":14,"071":[],"073":[],"077":[],"08":[],"087":14,"091":[],"093":14,"0x0000022aa45715a0":[5,11],"0x0000022aa4gd1s0":[5,11],"1":[1,2,3,5,8,12,14],"10":[1,13,14],"1000":[1,14],"108":[],"11":[1,4,5,14],"110":14,"112":14,"113":14,"12":[1,14],"122":14,"123":[],"126":[],"127":[],"12_pykkn_umldiagram_clearbackground":[],"13":[4,5,14],"130":[],"137":[],"14":14,"141":[],"142":[],"147":[],"148":[],"15":14,"152":14,"157":[],"163":14,"164":14,"167":14,"176":14,"177":[],"179":[],"18":14,"194":[],"2":[3,5,11,13,14],"20":14,"2017":14,"202":14,"2022":[1,4,5,14],"203":[],"21":14,"22":[4,5,14],"221":[],"223":[],"224":[],"226":[],"228":[],"245":[],"247":[],"248":[],"25":14,"254":[],"261":14,"262":14,"265":[],"269":14,"278":[],"297":[],"3":[3,13,14],"30":14,"303":[],"305":[],"307":[],"315":[],"317":14,"328":[],"342":[],"35":14,"350":14,"365":[],"367":[],"368":[],"370":[],"375":[],"376":[],"377":[],"381":14,"384":14,"385":[],"389":[],"39":[1,14],"396":14,"4":14,"40":14,"402":14,"404":[],"422":14,"429":14,"433":[],"437":[],"44":14,"441":[],"442":14,"443":[],"448":[],"45":14,"451":[],"452":[],"456":[],"461":14,"473":[],"475":14,"476":14,"477":[],"481":14,"486":[],"490":[],"5":14,"50":14,"500":[],"504":[],"510":14,"512":[],"515":14,"523":[],"536":[],"545":14,"55":14,"550":14,"552":[],"559":[],"560":[],"581":[],"584":14,"6":14,"60":14,"601":[],"602":[],"605":[],"612":14,"613":[],"621":14,"622":14,"640":14,"65":14,"653":14,"674":[],"679":14,"691":[],"694":14,"695":[],"7":14,"70":[5,11,14],"713":14,"720":[],"738":[],"739":[],"741":[],"743":[],"75":14,"772":[],"773":[],"776":[],"780":[],"789":[],"791":[],"796":14,"8":14,"80":14,"808":[],"809":14,"815":[],"827":[],"828":14,"832":[],"834":14,"838":[],"844":[],"846":[],"848":14,"85":14,"853":[],"854":14,"862":[],"872":[],"876":[],"881":[],"883":14,"884":14,"898":14,"899":[],"9":[],"90":14,"900":[],"903":14,"909":14,"918":14,"919":[],"920":14,"922":14,"930":14,"944":[],"945":[],"95":14,"955":[],"967":[],"970":[],"972":[],"974":14,"976":[],"980":[],"982":[],"989":14,"992":[],"abstract":[5,11],"case":14,"class":14,"do":[13,14],"export":[2,5,14],"function":[0,2,3,4,5,11],"long":[5,11],"return":[5,11],"short":14,"try":14,"while":14,As:14,At:[1,13,14],Be:14,But:[],For:14,If:[13,14],In:14,It:[5,11],On:14,That:[],The:[0,2,3,5,11,13,14],Then:14,There:14,To:[0,14],With:14,__repr__:[5,11],__str__:[5,11],_description_:[5,11],_group:3,_kei:3,_last_group:3,_nested_group:3,_record:[4,5,14],_static:[],_templat:[],aa:[5,11],abl:14,about:[5,11,14],abstrct:[],access:14,accord:[1,14],accrod:[],achiev:14,activ:13,actual:[5,6,14],ad:[5,6,14],add:[3,5,6,7,9,10,11],add_attrs_dict:[5,11],administr:[3,4,5,14],adp:[],after:[5,11,14],afterward:14,again:14,aif:[],all:[5,11,13,14],also:[3,14],alwai:[5,11],an:[0,1,2,3,4,5,8,11,14],anaconda:13,ani:[5,11,14],anoth:14,anyth:[5,11],apart:14,api:[0,14],ar:[5,6,11,13,14],arrai:14,assertionerror:[5,6,7,9,10],assign:[5,11,14],assum:14,ataset1:[2,4,5],attach:14,attent:14,attr:[1,4,5,8,9],attribut:[3,5,11],author:[5,11,14],auto:12,autoapi:12,autoapi_dir:[],autoapi_root:[],autodoc:[],autodoc_typehint:[],avala:14,avoid:14,awar:14,backslash:14,base:[1,2,3,4,5,6,7,8,9,10,13,14],bb:[5,11],becaus:14,been:[2,5],befor:[5,11,14],behavi:[],behavior:[5,11],behind:14,being:[5,11],below:[13,14],between:[3,13],binari:[4,5],bracket:14,brief:14,build:[],build_multi_paramet:[],built:[5,11],builtin:[],c:[3,4,5,13,14],call:[3,14],can:[0,5,6,11,13,14],capa1:[5,9,14],capa:[5,9],captur:[4,5,14],cc:[5,11],channel_01_raw:[],channel_01_sc:[],channel_02_raw:[],channel_02_sc:[],channel_03_raw:[],channel_03_sc:[],channel_04_raw:[],channel_04_sc:[],channel_05_raw:[],channel_05_sc:[],channel_06_raw:[],channel_06_sc:[],channel_07_raw:[],channel_07_sc:[],channel_08_raw:[],channel_08_sc:[],channel_09_raw:[],channel_09_sc:[],channel_10_raw:[],channel_10_sc:[],check:[5,11],choos:14,classtructur:14,click:14,cm:[5,8],code:14,collec:[],collect:14,color:[],com:13,command:[13,14],comment:[],compar:14,compon:12,conda:13,conduct:[],conf:[],conflict:13,consid:[2,5],consist:[5,11],construct:[],constructor:14,contain:[0,5,9,12,14],content:14,convert:[3,4,5,6,14],convert_p:[4,5],converter_01:[],converter_01_raw2:[],converter_01_raw:[],converter_02:[],converter_02_raw2:[],converter_02_raw:[],converter_03:[],converter_03_raw2:[],converter_03_raw:[],converter_04:[],converter_04_raw2:[],converter_04_raw:[],converter_05:[],converter_05_raw2:[],converter_05_raw:[],converter_06:[],converter_06_raw2:[],converter_06_raw:[],converter_07:[],converter_07_raw2:[],converter_07_raw:[],converter_08:[],converter_08_raw2:[],converter_08_raw:[],converter_09:[],converter_09_raw2:[],converter_09_raw:[],converter_10:[],converter_10_raw2:[],converter_10_raw:[],copyright:[],correspond:13,creat:[3,12,13],create_inst:[],curv:14,d:1,data1:14,data:[0,1,2,3,4,5,6,7],datasat:14,datasat_imag:14,dataseimage1:14,dataset1:[1,2,4,5,9,14],dataset2:[5,9],dataset:[2,4,5,6,9,12],dataset_data_pars:[],dataset_imag:[5,12,14],dataset_keyvalu:[5,12,14],dataset_video:[5,12,14],datasetimage1:14,datasetvideo1:14,dd:[5,11,14],deal:14,decod:[5,11],defin:14,depend:13,dergeraet:[5,11,14],deriv:[5,9],describ:[0,3],descript:[0,14],design:[2,4,5],desktop:3,detail:[0,5,11,13,14],determin:14,df:14,diagram:14,dic:[],dict:[3,5,11],dicti:3,dictionari:[3,5,11,14],dictnam:3,dicttohdf_1:3,differ:[0,1,14],difficulti:13,distribut:13,doc:13,document:[12,14],done:14,doubl:[1,14],e:3,each:[3,13,14],ee:[5,11],efil:[],ein:[],element:[5,9],empti:[5,9],en:13,enabl:14,encod:[5,11],encount:13,end:14,ensur:14,environ:[0,13],equal:14,establish:13,everi:14,exampl:[0,1,2,3,4,5,6,7,8,9,10,11],example_for_doc:14,excel:14,exclude_pattern:[],execut:13,expand:14,expect:3,experi:[0,5,7],experimentel:[],explain:14,explan:[],ext:[],extens:14,fail:[5,6,7,10],feedback:13,feedthrough:14,feel:14,ff:[5,11],file:[0,3,4,5,11],file_example_mp4_1920_18mg:[],filenam:[],find:14,first:0,flat:[5,11,14],flowmet:[],follow:[5,9,14],forg:13,form:[5,11,14],format:[3,4,5,11],found:13,frame:[4,5],framework:14,free:14,from:[5,6,14],fucntion:[],fulli:14,further:[1,14],g:3,gain:[3,14],gener:[5,11,12,14],get:[0,3],gitlab:13,give:[13,14],given:[5,6],go:3,graphic:14,group:3,guid:0,h5:[1,3,4,5,14],h5_create_run_exampl:[],h5_create_run_example2:[],h5py:13,ha:13,handl:0,have:[2,3,5,14],havent:[],hdf5:[0,3,5,11],hdf:3,here:[0,5,11,14],hh:14,how:[0,3,14],html:13,html_static_path:[],html_theme:[],http:13,imag:[2,5],image_data_pars:[],image_dataset_1:[2,5,14],imgag:[],implement:14,includ:0,index:0,inform:[5,9,11,14],inharetat:[],inherit:14,initi:[5,11],input:[0,5,6],instal:[0,13],instanc:[5,11],instant:[5,11],instead:[3,5,11,14],instr1:[],instr2:[],instrument1:[5,6,9,14],instrument:[3,5,9,12],instument:[],insturment2:[5,9],investig:[2,5],io:13,is_overwrit:[5,11],its:[5,6,11],itself:14,jpg:[2,5,14],json:3,just:3,kann:3,keep:14,kei:[3,5,11],kind:14,larg:[5,11],last:[3,14],latest:13,left:14,let:14,lib:[2,5],librari:[0,13,14],like:[0,5,11],line:14,link:[0,14],linux:13,list:[3,5,6,7,9,10,11],list_obj:[5,6,7,9,10],list_of_paramet:[],locat:14,look:[3,14],lookup:[5,6],loos:[],lose:14,ls:[],made:14,main:14,make:[5,11],manag:13,mandatori:14,map:[5,6],mark:14,mayb:[5,11],measur:[5,9,14],measureddata:14,metad:[],metadata:14,metatadata:14,metatdata:[],method:[0,5,6,7,10,11],might:14,mind:14,miniconda:13,mix:14,mm:14,model1:[5,6,7,14],model2:[5,6],model:[3,5,6,9,12],modifi:[5,11],modl:14,modul:0,more:[5,11,14],mp4:[4,5,14],msmt01:14,msmt_type:[],msmtrun:[5,11,14],mulitpl:[],multi:[5,6,7,9,10],multipl:[2,5],mydictionari:14,n:13,name:[1,2,3,4,5,6,7,8,9,10,11],name_of_parameter_1:[],name_of_parameter_2:[],name_of_parameter_3:[],nameofdataset:14,napoleon:[],need:[2,5,14],nest:3,nested_dict:3,next:14,none:[3,5,11],normal:14,note:13,now:14,np:[1,14],number:14,numpi:[13,14],obj:[],object:[0,1,2,4,5,6,7,8,9,10,11],object_str:[5,11],offset:3,oil:[5,11,14],oil_id:[],oil_typ:[],one:14,onli:[2,5],open:14,opencv:13,opportun:14,opt_in:[],organ:14,orient:14,origin:[4,5,8,9,11,14],origina:[],other:[5,6,11,13,14],our:14,outcom:[],output:[4,5,14],output_fil:[2,4,5],overrid:[],overview:14,overwrit:14,pa06:[5,11,14],packag:13,page:[0,12,13],pai:14,pair:[3,5,11],panda:[13,14],para1:[5,8],para2:[],param_kh1:[],param_kh2:[],param_pressure1:[],param_pressure2:[],param_rotspeed1:[],param_rotspeed2:[],param_temp1:[],param_temp2:[],param_temp3:[],param_torque1:[],param_torque2:[],param_volflow1:[],param_volflow2:[],paramet:[0,1,2,3,4,5,6,7,9,10,11,12],parameter1:[5,7,10,14],parameter2:[5,7,10],parametr:[],paramt:14,paremet:[],pars:[],parse_json:[],part:14,parti:13,path:[2,3,4,5,11],path_output:[4,5],pd:14,perform:1,physic:[5,6],pictur:14,pillow:[2,5],pipe1:[5,11],pipe2:[5,11],pipelin:[3,5,10,11,12],pipeline1:[5,9,10,14],pipeline2:[5,10],pleas:[5,11,14],plu:14,pmanag:[5,11,14],png:[],point:14,polynom:[],polynomi:[5,6],porpos:14,porpus:[],possibl:14,powershel:13,preasur:14,preasuredata:14,preasuresensor:[],present:1,pressur:14,print:[5,11],process:[1,5,7],product:13,program:14,project:13,project_manag:[],prompt:13,properti:[2,4,5],provid:[2,5,11,14],pump_manufactur:[],pump_typ:[],pure:14,purpos:[13,14],purpus:[],py:13,pykkn:[3,14],pykkn_env:13,pykkn_pars:[],pykraken:14,pysic:[],python:[0,13,14],quotat:14,r:[4,5],rais:[5,6,7,9,10],rand:14,random:14,raw:[5,9,14],read:[1,2,5],read_csv:14,readabl:[5,11],reader:[],recommend:13,record:14,recurs:3,recursive_create_inst:[],refer:[0,14],refrenc:14,releas:[],relev:13,repositori:0,repres:[1,2,4,5,6,7,8,9,10,14],requir:1,research:[0,14],result:[5,11],resurs:[],rewrit:[5,11],rick:[],rig:14,root:[5,11],rs1:[],run1:[3,5,10,11,14],run:[3,5,11,12,13],runnam:[],s:[5,6,7,9,10,14],same:[13,14],sampler:[1,14],save:[0,14],scale:[5,9],scientif:[0,14],search:0,see:[0,3,14],seen:14,segment:[4,5],self:[2,3,4,5,6,7,9,10,11],sensor:[5,6],seri:14,set:[0,5,11,14],set_storage_path:[1,4,5,11],sever:14,sheet:14,should:[5,9,11,13,14],show:[0,5,11],shown:14,shwon:[],side:14,sign:14,signal:14,similar:[3,14],similiar:[],simpli:1,singl:[3,14],slash:14,so:[13,14],sof:[],some:14,sourc:[0,14],specifi:13,sphinx:12,sphinx_panel:[],sphinx_rtd_them:[],ss:14,start:[0,3],stemp:[],step:0,storabl:[3,14],storag:[1,2,3,4,5,6,7,8,9,10,12,14],store:[0,1,4,5,11],store_hdf5:[5,11],store_json:[5,11],str:[1,2,3,4,5,6,7,8,9,10,11],string:[5,11],struchtur:14,struct:14,structur:[3,5,10],success:13,support:0,svg:[],symbol:14,system:13,tabel:[],tabl:[5,6],targetrp:[5,11,14],targettmp:[5,11,14],tcorn:[5,11,14],templates_path:[],termin:13,test:[1,2,3,4,5,14],test_data:14,test_data_typ:[],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_file_exist:[],test_image_attr:[],test_instru:[],test_key_valu:3,test_meet:[4,5,14],test_model:[],test_nam:[],test_other_attr:[],test_other_attribut:[],test_param:[],test_paramet:[],test_pipelin:[],test_resourc:[],test_result:[],test_rig_1:[2,5,14],test_run:[],test_samplerate_typ:[],test_samplerate_valu:[],test_timestamp:[],test_ut_d:[1,14],test_ut_video:[4,5],test_valu:[],test_video_attr:[],test_wrong_para_input:[],testrig_nam:[],th:[],them:14,therefor:14,theses:14,thi:[1,2,4,5,6,7,8,9,10,11,12,13,14],third:[13,14],though:14,thre:[],three:14,through:14,time:[0,13,14],timestamp:[1,4,5,14],timestemp:14,tool:13,transfer:[],transmitt:14,tupl:3,tutori:13,two:14,type:[0,1,5,9,11,14],typeerror:[5,9],typenunabhaengigen:[],typic:14,uml:14,unit:[5,8,9,14],unix:13,up:[0,14],us:[0,2,3,5,6,7,11,13,14],usag:14,useful:14,user:[0,2,3,4,5,14],usersadministr:[4,5],usual:14,validierung:[],valu:[3,5,8,11],variabl:[5,8,9,14],verdraengerpumpen:[],veri:[5,11,14],verifi:13,version:13,via:[],video:[4,5],video_data_pars:[],video_dataset_1:[4,5,14],viewer:14,virtual:13,visit:14,volt:[5,9,14],voltag:[5,9,14],vom:[],von:[],wa:[13,14],wai:[3,14],want:[5,11,14],we:[0,3,13,14],welcom:13,well:14,wetak:[],when:[5,6,7,9,10,14],where:[5,11,14],whether:13,which:[0,5,11,14],who:[5,11],whole:[3,14],wide:14,window:13,wirkungsgradmodel:[],work:0,would:[3,14],wrapper:3,write:[13,14],wrting:[],www:13,xxxxxxxxxx:3,yet:[2,5],you:[0,5,11,13,14],your:[0,13,14],yyyi:14,zoom:14},titles:["Welcome to PYKKN\u2019s documentation!","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset_image</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset_keyvalue</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.dataset_video</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.instrument</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.model</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.parameter</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.pipeline</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.run</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">components.storage</span></code>","API Reference","Getting Started","Getting Started"],titleterms:{"class":[1,2,3,4,5,6,7,8,9,10,11],"function":14,"import":14,add:14,add_attrs_dict:14,an:[],api:12,attr:14,attribut:[1,14],build_multi_paramet:[],characterist:14,compon:[1,2,3,4,5,6,7,8,9,10,11],conf:[],content:[1,2,3,4,5,6,7,8,9,10,11],creat:14,csv:14,data:14,dataset:[1,14],dataset_imag:2,dataset_keyvalu:3,dataset_video:4,dict:14,document:0,exampl:14,example_for_doc:[],excel:[],file:14,first:14,get:[13,14],h5_create_run_exampl:[],h5_create_run_example2:[],hdf5:14,imag:14,indic:0,insert:14,instrument:[6,14],kei:14,model:[7,14],modul:[1,2,3,4,6,7,8,9,10,11,14],name:14,object:14,packag:5,pair:14,paramet:[8,14],pars:[],parse_json:[],path:14,pipelin:[9,14],project:14,pykkn:0,rcur:[],recur:14,refer:12,run:[10,14],s:0,sensor:14,set_storage_path:14,setup:14,show:14,specifi:14,start:[13,14],step:14,storag:11,store:14,str:14,structur:14,submodul:5,tabl:[0,14],test_dataset:[],test_dataset_imag:[],test_dataset_video:[],test_instru:[],test_model:[],test_paramet:[],test_pipelin:[],test_run:[],valu:14,video:14,welcom:0}})
\ No newline at end of file
diff --git a/docs/build/html/user/index.html b/docs/build/html/user/index.html
index cb664218653cb882da51d673f47e7bf7ad1ec890..0451446eadcabfce34bf844c157f906a2125e697 100644
--- a/docs/build/html/user/index.html
+++ b/docs/build/html/user/index.html
@@ -49,15 +49,15 @@
<li class="toctree-l3"><a class="reference internal" href="#add-first-data">Add first data</a></li>
<li class="toctree-l3"><a class="reference internal" href="#modelling-a-sensor-characteristic">Modelling a sensor characteristic</a></li>
<li class="toctree-l3"><a class="reference internal" href="#structuring-of-the-data">Structuring of the data</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#create-and-store-hdf5-file">Create and store hdf5 file</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#create-and-store-hdf5-file">Create and store HDF5 file</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="#example-project-import-of-an-csv-file">Example project import of an .csv file</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#example-project-import-of-a-csv-object">Example project import of a .csv object</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="#inserting-and-storing-of-the-data">Inserting and storing of the data</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="#rcurring-functionalities-and-attributes">Rcurring functionalities and attributes</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#recurring-functionalities-and-attributes">Recurring functionalities and attributes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#set-storage-path-path-str">set_storage_path(path: str)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#store">store()</a></li>
<li class="toctree-l3"><a class="reference internal" href="#show">show()</a></li>
@@ -140,8 +140,8 @@ First, you need to implement the following lines of code. This is mandatory for
We start with a dataset. Below, you can see how to implement it. <br>
In the first line, we create the dataset1 which is called “msmt01”.
This is done by using the constructor (add link to description) of the dataset class. <br>
-After that, we add the actual data. For this purpose, we use the … function. In this case, we create some random numbers. <br>
-With the third line, we add an attribute to the dataset. Here, we specify samplerate we used while recording the data.
+After that, we add the actual data. For this purpose, create a random set of numbers and then add them to the data paramter of dataset1. <br>
+With the third line, we add an attribute to the dataset. Here, we specify the samplerate we used while recording the data.
The name of the parameter is determined in the brackets and the value is added with the equal sign. <br>
In the last line, another attribute is added. In this case, the attribute is a timestamp to document when the data was collected:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">dataset1</span> <span class="o">=</span> <span class="n">Dataset</span><span class="p">(</span><span class="s1">'msmt01'</span><span class="p">)</span>
@@ -155,7 +155,7 @@ In the last line, another attribute is added. In this case, the attribute is a t
<h3>Modelling a sensor characteristic<a class="headerlink" href="#modelling-a-sensor-characteristic" title="Permalink to this headline"></a></h3>
<p>Let’s assume the data we collected was measured with a preasure sensor. The sensor creates a voltage signal as an output.
The voltage signal needs to be converted to a pressure value according to a characteristic curve.
-For this end, we will implement the characteristic curve as a parameter, add this parameter to a model and create an instrument from this model.
+To this end, we will implement the characteristic curve as a parameter, add this parameter to a model and create an instrument from this model.
Step by step: let’s start with the parameter. <br>
In the following lines of code, we see how to implement the parameter object.
First, we create the object parameter1 and name it “gain” by writing so in the brackets. <br>
@@ -185,7 +185,7 @@ After creating this instrument, we add the model1 to this instrument:</p>
<h3>Structuring of the data<a class="headerlink" href="#structuring-of-the-data" title="Permalink to this headline"></a></h3>
<p>In the next step, we add our dataset to a pipeline object. Normally we add several datasets here to generate an array. <br>
At the same time, we store the metadata of the instruments used in a test rig in the pipeline module. <br>
-The main purpuse of the pipeline class is to struchture and organize the data. <br>
+The main purpose of the pipeline class is to struchture and organize the data. <br>
In the lines below, the object pipeline1 is created. In brackets, you can determine
the location where it is stored in the HDF5 file. Afterwards, we add the dataset1 to the pipeline1.
The last three lines contain metadata of the used instrument:</p>
@@ -216,10 +216,10 @@ Then we add some metatadata for our test series:</p>
</div>
</section>
<section id="create-and-store-hdf5-file">
-<h3>Create and store hdf5 file<a class="headerlink" href="#create-and-store-hdf5-file" title="Permalink to this headline"></a></h3>
+<h3>Create and store HDF5 file<a class="headerlink" href="#create-and-store-hdf5-file" title="Permalink to this headline"></a></h3>
<p>Before we can export our HDF5 file, we need to specify the location where it should be saved and the name of the file.
-Pay attention that you use the slash symbol “/” instead of backslash “" to determine the location
-and pay attention that you choose a name for you file plus the ending “.h5”:</p>
+Pay attention that you use the slash symbol “/” instead of backslash “\” to determine the location
+and pay attention that you choose a name for your file plus the ending “.h5”:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">msmtrun</span><span class="o">.</span><span class="n">set_storage_path</span><span class="p">(</span><span class="s2">"C:/Users/Example/PYKKN/example_for_docs.h5"</span><span class="p">)</span>
</pre></div>
</div>
@@ -229,15 +229,15 @@ This is how we can ensure to export the whole file:</p>
</pre></div>
</div>
<p>Now, let’s have a look at the created HDF5 file. Below, you can see a picture of the created file.
-The structure is fully expanded and an open source HDF5 viewer is used to show it.
-On the left side, you can see the structe of the file we created.</p>
+The structure is fully expanded and an open-source HDF5 viewer is used to show it.
+On the left side, you can see the structe of the file we created:</p>
<img alt="../_images/example-project_overviewWholeProject.png" src="../_images/example-project_overviewWholeProject.png" />
</section>
</section>
-<section id="example-project-import-of-an-csv-file">
-<h2>Example project import of an .csv file<a class="headerlink" href="#example-project-import-of-an-csv-file" title="Permalink to this headline"></a></h2>
-<p>In the following project, we will show you how to store data from a csv table in a HDF5 file using PYKKN. <br>
-This might be usefull when you for example have stored your data in an Excel sheet. With Excel you can then export th efile as a csv file and store it into hdf5.
+<section id="example-project-import-of-a-csv-object">
+<h2>Example project import of a .csv object<a class="headerlink" href="#example-project-import-of-a-csv-object" title="Permalink to this headline"></a></h2>
+<p>In the following project, we will show you how to store data from a csv table in an HDF5 file using PYKKN. <br>
+This might be usefull if, for example, your data is stored in an Excel sheet. With Excel, you can then export the file as a csv file and store it into HDF5.
As an example, look at the following table:</p>
<table class="docutils align-default" id="id2">
<caption><span class="caption-text">Example Table</span><a class="headerlink" href="#id2" title="Permalink to this table"></a></caption>
@@ -375,14 +375,14 @@ As an example, look at the following table:</p>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</pre></div>
</div>
-<p>In this case, it is important to add the panda framework as well because we will use this to store the csv file:</p>
+<p>In this case, it is important to add the panda framework as well because we will use this to store the CSV file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">panda</span> <span class="k">as</span> <span class="nn">pd</span>
</pre></div>
</div>
</section>
<section id="inserting-and-storing-of-the-data">
<h3>Inserting and storing of the data<a class="headerlink" href="#inserting-and-storing-of-the-data" title="Permalink to this headline"></a></h3>
-<p>At first, we will store the .csv file as a variable which we can then add to dataset object. To do this, we use the function read_csv() from the panda framework:</p>
+<p>At first, we will store the CSV file as a variable which we can then add to dataset object. To do this, we use the function read_csv() from the panda framework:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="s2">"test_data.csv"</span><span class="p">)</span>
</pre></div>
</div>
@@ -399,10 +399,10 @@ As an example, look at the following table:</p>
<img alt="../_images/csv_file_hdf5.jpg" src="../_images/csv_file_hdf5.jpg" />
</section>
</section>
-<section id="rcurring-functionalities-and-attributes">
-<h2>Rcurring functionalities and attributes<a class="headerlink" href="#rcurring-functionalities-and-attributes" title="Permalink to this headline"></a></h2>
+<section id="recurring-functionalities-and-attributes">
+<h2>Recurring functionalities and attributes<a class="headerlink" href="#recurring-functionalities-and-attributes" title="Permalink to this headline"></a></h2>
<p>In PYKKN, you will find several functions that are avalaible in different modules. To achieve this, the library is based on object-oriented programming
-and several modules inherit functions from the storable class. The functions of this class will be explained below in more detail to avoid explaning again for each module.
+and several modules inherit functions from the storable class. The functions of this class will be explained below in more detail to avoid explaining again for each module.
For further information about the storable class, you can visit the API reference. (add link to API refrence) <br></p>
<p>To give you a brief overview of the classtructure of PYKKN you can have a look at the UML diagram below (feel free to click on the graphic to zoom in):</p>
<a class="reference external image-reference" href="../_images/20-08-12_PYKKN_UMLdiagram_clearBackground.svg"><img alt="../_images/20-08-12_PYKKN_UMLdiagram_clearBackground.svg" src="../_images/20-08-12_PYKKN_UMLdiagram_clearBackground.svg" /></a>
@@ -410,12 +410,10 @@ For further information about the storable class, you can visit the API referenc
<ul class="simple">
<li><p>dataset</p></li>
<li><p>dataset_image</p></li>
-<li><p>dataset_keyValue</p></li>
+<li><p>dataset_keyvalue</p></li>
<li><p>dataset_video</p></li>
<li><p>instrument</p></li>
<li><p>model</p></li>
-<li><p>instrument</p></li>
-<li><p>model</p></li>
<li><p>parameter</p></li>
<li><p>pipeline</p></li>
<li><p>run</p></li>
@@ -423,14 +421,14 @@ For further information about the storable class, you can visit the API referenc
<p>All the objects that are created from these classes can use the following functions:</p>
<section id="set-storage-path-path-str">
<h3>set_storage_path(path: str)<a class="headerlink" href="#set-storage-path-path-str" title="Permalink to this headline"></a></h3>
-<p>Every object that is created from theses classes can export HDF5 file.
+<p>Every object that is created from theses classes can export HDF5 files.
Before doing so, the storage path needs to be defined. Therefore, you add the storage path
to the function as a parameter. The storage path needs to be in quotation marks (“”) and end on the name
of the HDF5 file plus the ending “.h5”. Here, you can see an example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">data1</span><span class="o">.</span><span class="n">set_storage_path</span><span class="p">(</span><span class="s2">"C:/Users/Example/data1.h5"</span><span class="p">)</span>
</pre></div>
</div>
-<p>Be aware to use the slash symbol “/” instead of backslash “".</p>
+<p>Be aware to use the slash symbol “/” instead of backslash “\”.</p>
</section>
<section id="store">
<h3>store()<a class="headerlink" href="#store" title="Permalink to this headline"></a></h3>
@@ -482,8 +480,8 @@ Therefore, PYKKN provides the opportunity to store several different types of da
<p>With the dataset module, you are able to store an array of numbers.
As PYKKN is made for scientific research, the dataset modle is typically used when
storing measured data from a test rig. Apart from the pure data, it is possible to
-store metadata such as samplerate and timestamp. <br></p>
-<p>To create a dataset object, the constructer is needed.
+store metadata such as the samplerate and the timestamp. <br></p>
+<p>To create a dataset object, the constructor is needed.
The parameter of the constructor determines the name of the dataset.
This is also the name shown in the HDF5 file in the end.
You can see an example here:</p>
@@ -506,9 +504,9 @@ The samplerate is represented as a number in 1/s. The timestamp should have the
</pre></div>
</div>
<p>If you want to create an HDF5 file from this dataset, it possible to do so.
-In PYKKN it is possible to create a HDF5 file from every single object that is created.
+In PYKKN it is possible to create an HDF5 file from every single object that is created.
Therefore, we first set up the storage path by writing it in the brackets of the set_storage_path() function.
-Keep in mind to use the slash symbol “/” in the path instead of backslash “" and add the name plus “.h5” in the end of the path:</p>
+Keep in mind to use the slash symbol “/” in the path instead of backslash “\” and add the name plus “.h5” in the end of the path:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">dataset1</span><span class="o">.</span><span class="n">set_storage_path</span><span class="p">(</span><span class="s1">'test/test_ut_ds.h5'</span><span class="p">)</span>
</pre></div>
</div>
@@ -521,8 +519,8 @@ Keep in mind to use the slash symbol “/” in the path instead of backslash
<h3>Dataset image<a class="headerlink" href="#dataset-image" title="Permalink to this headline"></a></h3>
<p>With this module, the user is enabled to store an image in the HDF5 file. If you are dealing with a video, please use dataset_video module
instead of trying to store it as an array of images with this module. There are two steps to implement an image.
-First, you create an object of the datasat_image class and give it a name when using the constructor in this case the name is “image_dataset_1.
-Afterwards, you add the path of the image where it stored to PYKKN can collect the data:</p>
+First, you create an object of the datasat_image class and give it a name when using the constructor. In this case the name is “image_dataset_1.
+Afterwards, you add the path of the image where it is stored so PYKKN can collect the data:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">datasetImage1</span> <span class="o">=</span> <span class="n">Dataset_Image</span><span class="p">(</span><span class="s1">'image_dataset_1'</span><span class="p">)</span>
<span class="n">datasetImage1</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s2">"/test/test_rig_1.jpg"</span>
</pre></div>
@@ -536,7 +534,7 @@ Afterwards, you add the path of the image where it stored to PYKKN can collect t
<section id="dataset-video">
<h3>Dataset video<a class="headerlink" href="#dataset-video" title="Permalink to this headline"></a></h3>
<p>If you want to store a video in your HDF5 file, you can use this module. The usage is very similar to the image module.
-First, create an object that represents the video you want to store. Then,add the storage path. If you want, you can also
+First, create an object that represents the video you want to store. Then, add the storage path. If you want, you can also
add the timestamp as metadata:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">datasetVideo1</span> <span class="o">=</span> <span class="n">Dataset_Video</span><span class="p">(</span><span class="s1">'video_dataset_1'</span><span class="p">)</span>
<span class="n">datasetVideo1</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="s2">"C:/Users/Administrator/Videos/Captures/test_meeting _recording.mp4"</span>
diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
index 3c51c52786958450179846090fa5519cdb426412..cd68b722d696d06f4ad217b735b714d7e032043a 100644
--- a/docs/source/user/index.rst
+++ b/docs/source/user/index.rst
@@ -32,8 +32,8 @@ Now, we can add the first data to our HDF5 file. |br|
We start with a dataset. Below, you can see how to implement it. |br|
In the first line, we create the dataset1 which is called "msmt01".
This is done by using the constructor (add link to description) of the dataset class. |br|
-After that, we add the actual data. For this purpose, we use the ... function. In this case, we create some random numbers. |br|
-With the third line, we add an attribute to the dataset. Here, we specify samplerate we used while recording the data.
+After that, we add the actual data. For this purpose, create a random set of numbers and then add them to the data paramter of dataset1. |br|
+With the third line, we add an attribute to the dataset. Here, we specify the samplerate we used while recording the data.
The name of the parameter is determined in the brackets and the value is added with the equal sign. |br|
In the last line, another attribute is added. In this case, the attribute is a timestamp to document when the data was collected::
@@ -48,7 +48,7 @@ Modelling a sensor characteristic
Let's assume the data we collected was measured with a preasure sensor. The sensor creates a voltage signal as an output.
The voltage signal needs to be converted to a pressure value according to a characteristic curve.
-For this end, we will implement the characteristic curve as a parameter, add this parameter to a model and create an instrument from this model.
+To this end, we will implement the characteristic curve as a parameter, add this parameter to a model and create an instrument from this model.
Step by step: let's start with the parameter. |br|
In the following lines of code, we see how to implement the parameter object.
First, we create the object parameter1 and name it "gain" by writing so in the brackets. |br|
@@ -79,7 +79,7 @@ Structuring of the data
In the next step, we add our dataset to a pipeline object. Normally we add several datasets here to generate an array. |br|
At the same time, we store the metadata of the instruments used in a test rig in the pipeline module. |br|
-The main purpuse of the pipeline class is to struchture and organize the data. |br|
+The main purpose of the pipeline class is to struchture and organize the data. |br|
In the lines below, the object pipeline1 is created. In brackets, you can determine
the location where it is stored in the HDF5 file. Afterwards, we add the dataset1 to the pipeline1.
The last three lines contain metadata of the used instrument::
@@ -110,12 +110,12 @@ Now, we can add the pipeline object and the parameter object to the run object::
msmtrun.add([parameter1])
****************************
-Create and store hdf5 file
+Create and store HDF5 file
****************************
Before we can export our HDF5 file, we need to specify the location where it should be saved and the name of the file.
-Pay attention that you use the slash symbol "/" instead of backslash "\" to determine the location
-and pay attention that you choose a name for you file plus the ending ".h5"::
+Pay attention that you use the slash symbol "/" instead of backslash "\\" to determine the location
+and pay attention that you choose a name for your file plus the ending ".h5"::
msmtrun.set_storage_path("C:/Users/Example/PYKKN/example_for_docs.h5")
@@ -125,20 +125,22 @@ This is how we can ensure to export the whole file::
msmtrun.store()
Now, let's have a look at the created HDF5 file. Below, you can see a picture of the created file.
-The structure is fully expanded and an open source HDF5 viewer is used to show it.
-On the left side, you can see the structe of the file we created.
+The structure is fully expanded and an open-source HDF5 viewer is used to show it.
+On the left side, you can see the structe of the file we created:
.. image:: user-images/example-project/example-project_overviewWholeProject.png
+
+
.. end of example project
.. start of example project how to impkement an Excel csv file
============================================
-Example project import of an .csv file
+Example project import of a .csv object
============================================
-In the following project, we will show you how to store data from a csv table in a HDF5 file using PYKKN. |br|
-This might be usefull when you for example have stored your data in an Excel sheet. With Excel you can then export th efile as a csv file and store it into hdf5.
+In the following project, we will show you how to store data from a csv table in an HDF5 file using PYKKN. |br|
+This might be usefull if, for example, your data is stored in an Excel sheet. With Excel, you can then export the file as a csv file and store it into HDF5.
As an example, look at the following table:
.. csv-table:: Example Table
@@ -161,7 +163,7 @@ Let's start by setting up the project as usual, though in this short case we wou
import numpy as np
-In this case, it is important to add the panda framework as well because we will use this to store the csv file::
+In this case, it is important to add the panda framework as well because we will use this to store the CSV file::
import panda as pd
@@ -169,7 +171,7 @@ In this case, it is important to add the panda framework as well because we will
Inserting and storing of the data
*********************************
-At first, we will store the .csv file as a variable which we can then add to dataset object. To do this, we use the function read_csv() from the panda framework::
+At first, we will store the CSV file as a variable which we can then add to dataset object. To do this, we use the function read_csv() from the panda framework::
df = pd.read_csv("test_data.csv")
@@ -193,11 +195,11 @@ The output of this short project can be seen below:
.. start of the explanation of the recurring functionalities of the differen modules
=======================================
-Rcurring functionalities and attributes
+Recurring functionalities and attributes
=======================================
In PYKKN, you will find several functions that are avalaible in different modules. To achieve this, the library is based on object-oriented programming
-and several modules inherit functions from the storable class. The functions of this class will be explained below in more detail to avoid explaning again for each module.
+and several modules inherit functions from the storable class. The functions of this class will be explained below in more detail to avoid explaining again for each module.
For further information about the storable class, you can visit the API reference. (add link to API refrence) |br|
To give you a brief overview of the classtructure of PYKKN you can have a look at the UML diagram below (feel free to click on the graphic to zoom in):
@@ -209,12 +211,10 @@ The following modules inherit from the storage class (add links to the api refer
* dataset
* dataset_image
-* dataset_keyValue
+* dataset_keyvalue
* dataset_video
* instrument
* model
-* instrument
-* model
* parameter
* pipeline
* run
@@ -225,14 +225,14 @@ All the objects that are created from these classes can use the following functi
set_storage_path(path: str)
****************************
-Every object that is created from theses classes can export HDF5 file.
+Every object that is created from theses classes can export HDF5 files.
Before doing so, the storage path needs to be defined. Therefore, you add the storage path
to the function as a parameter. The storage path needs to be in quotation marks ("") and end on the name
of the HDF5 file plus the ending ".h5". Here, you can see an example::
data1.set_storage_path("C:/Users/Example/data1.h5")
-Be aware to use the slash symbol "/" instead of backslash "\".
+Be aware to use the slash symbol "/" instead of backslash "\\".
*******
store()
@@ -297,9 +297,9 @@ Dataset module
With the dataset module, you are able to store an array of numbers.
As PYKKN is made for scientific research, the dataset modle is typically used when
storing measured data from a test rig. Apart from the pure data, it is possible to
-store metadata such as samplerate and timestamp. |br|
+store metadata such as the samplerate and the timestamp. |br|
-To create a dataset object, the constructer is needed.
+To create a dataset object, the constructor is needed.
The parameter of the constructor determines the name of the dataset.
This is also the name shown in the HDF5 file in the end.
You can see an example here::
@@ -323,9 +323,9 @@ The samplerate is represented as a number in 1/s. The timestamp should have the
dataset1.attrs['timestamp'] = '2022-06-12 10:39:11'
If you want to create an HDF5 file from this dataset, it possible to do so.
-In PYKKN it is possible to create a HDF5 file from every single object that is created.
+In PYKKN it is possible to create an HDF5 file from every single object that is created.
Therefore, we first set up the storage path by writing it in the brackets of the set_storage_path() function.
-Keep in mind to use the slash symbol "/" in the path instead of backslash "\" and add the name plus ".h5" in the end of the path::
+Keep in mind to use the slash symbol "/" in the path instead of backslash "\\" and add the name plus ".h5" in the end of the path::
dataset1.set_storage_path('test/test_ut_ds.h5')
@@ -339,8 +339,8 @@ Dataset image
With this module, the user is enabled to store an image in the HDF5 file. If you are dealing with a video, please use dataset_video module
instead of trying to store it as an array of images with this module. There are two steps to implement an image.
-First, you create an object of the datasat_image class and give it a name when using the constructor in this case the name is "image_dataset_1.
-Afterwards, you add the path of the image where it stored to PYKKN can collect the data::
+First, you create an object of the datasat_image class and give it a name when using the constructor. In this case the name is "image_dataset_1.
+Afterwards, you add the path of the image where it is stored so PYKKN can collect the data::
datasetImage1 = Dataset_Image('image_dataset_1')
datasetImage1.data = "/test/test_rig_1.jpg"
@@ -356,7 +356,7 @@ Dataset video
**************
If you want to store a video in your HDF5 file, you can use this module. The usage is very similar to the image module.
-First, create an object that represents the video you want to store. Then,add the storage path. If you want, you can also
+First, create an object that represents the video you want to store. Then, add the storage path. If you want, you can also
add the timestamp as metadata::
datasetVideo1 = Dataset_Video('video_dataset_1')
diff --git a/test.py b/test.py
new file mode 100644
index 0000000000000000000000000000000000000000..cda449810295abc4c39f2bb938f9a951677ecd09
--- /dev/null
+++ b/test.py
@@ -0,0 +1 @@
+import components
\ No newline at end of file