Skip to content

Commit 246ed95

Browse files
gfoidlgfoidl
authored
Updated documentation (#65)
* SwingingDoor.md updated * Use GH-pages for project url in package * Updates to text
1 parent 44129c6 commit 246ed95

File tree

7 files changed

+28
-40
lines changed

7 files changed

+28
-40
lines changed

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
See `./demos` for code.
1515

16+
_Note_: the graphs in the documentation are created by the code from `./demos`, so you can see which config-values got used.
17+
1618
![](./api-doc/articles/images/demo_01.png)
1719

1820
![](./api-doc/articles/images/demo_02.png)

‎api-doc/articles/DeadBand.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Filtering noise caused by measure- or device-errors (i.e. instrument precision).
66

77
## Description
88

9-
Values that lie inbetween the dead band, defined by _ExDev_, get ommited because they are not meaningful.
9+
Values that lie inbetween the dead band, defined by _ExDev_, get ommited because they are not meaningful.
1010
Decisions should not be based on these value. They are just noise, therefore they can be filtered out.
1111

1212
![](./images/DeadBand_01.jpg)
@@ -17,9 +17,9 @@ When a value is outside of the dead band, that value and the previous value are
1717

1818
## Parameters
1919

20-
| Name | Description |
21-
| ---- | -- |
22-
| ExDev | (absolut) instrument precision |
20+
| Name | Description |
21+
| ---- | ------------------------------------------------------- |
22+
| ExDev | (absolut) instrument precision |
2323
| ExMax | length of x/time before for sure a value gets recoreded |
2424

2525
## Examples
@@ -36,13 +36,12 @@ When a value is outside of the dead band, that value and the previous value are
3636

3737
![](./images/dead-band_error.png)
3838

39-
| Data | # datapoints | average | sigma | skewness | kurtosis |
40-
| -- | -- | -- | -- | -- | -- |
41-
| raw | 1000 | 19.6584 | 0.1960 | -0.0330 | 2.3442 |
42-
| compressed | 490 | 19.6623 | 0.2007 | -0.1021 | 2.4672 |
39+
| Data | # datapoints | average | sigma | skewness | kurtosis |
40+
| ---------- | ------------ | ------- | ------ | -------- | -------- |
41+
| raw | 1000 | 19.6584 | 0.1960 | -0.0330 | 2.3442 |
42+
| compressed | 490 | 19.6623 | 0.2007 | -0.1021 | 2.4672 |
4343

44-
As can be seen statistics didn't change significantally, but the count of recorded datapoints was
45-
reduced -- by filtering noise -- by 51%.
44+
As can be seen statistics didn't change significantally, but the count of recorded datapoints was reduced -- by filtering noise -- by 51%.
4645

4746
## Literature
4847

‎api-doc/articles/SwingingDoor.md‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Swinging Door
22

3-
[TOC]
4-
53
## Purpose
64

75
Data reduction by using the swinging door algorithm.
@@ -10,21 +8,20 @@ Data reduction by using the swinging door algorithm.
108

119
![](./images/swinging-door_02.png)
1210

13-
Beginning at the last archived value (1) and the next snapshots (2, 3, ...) a _swinging door_ is constructed,
14-
that is only allowed to close and not to open. Green area in the figure below.
11+
Beginning at the last archived value (1) and the next snapshots (2, 3, ...) a _swinging door_ is constructed, that is only allowed to close and not to open. Green area in the figure below.
1512

1613
![](./images/swinging-door_01.png)
1714

18-
When an incoming value (6) lies outside the allowed aread, so the last snapshot and the new value get stored.
15+
When an incoming value (6) lies outside the allowed area, so the last snapshot (5) get stored, and beginning at this snapshot (5) a new _swinging door_ to the incoming (6) value gets opened.
1916
Therefore maintaining the trend in the data.
2017

2118
## Parameters
2219

23-
| Name | Description |
24-
| -- | -- |
25-
| CompDev | (absolut) compression deviation |
26-
| ExMax | length of x/time before for sure a value gets recoreded |
27-
| ExMin | length of x/time within no value gets recorded (after the last archived value) |
20+
| Name | Description |
21+
| ------- | ------------------------------------------------------------------------------ |
22+
| CompDev | (absolut) compression deviation |
23+
| ExMax | length of x/time before for sure a value gets recoreded |
24+
| ExMin | length of x/time within no value gets recorded (after the last archived value) |
2825

2926
## Examples
3027

@@ -40,13 +37,12 @@ Therefore maintaining the trend in the data.
4037

4138
![](./images/swinging-door_error.png)
4239

43-
| Data | # datapoints | average | sigma | skewness | kurtosis |
44-
| -- | -- | -- | -- | -- | -- |
45-
| raw | 1000 | 19.2854 | 1.2968 | -2.1689 | 7.0397 |
46-
| compressed | 418 | 19.2833 | 1.2984 | -2.1682 | 7.0428 |
40+
| Data | # datapoints | average | sigma | skewness | kurtosis |
41+
| ---------- | ------------ | ------- | ------ | -------- | -------- |
42+
| raw | 1000 | 19.2854 | 1.2968 | -2.1689 | 7.0397 |
43+
| compressed | 418 | 19.2833 | 1.2984 | -2.1682 | 7.0428 |
4744

48-
As can be seen statistics didn't change significantally, but the count of recorded datapoints was
49-
reduced -- by filtering noise -- by 58%.
45+
As can be seen statistics didn't change significantally, but the count of recorded datapoints was reduced -- by filtering noise -- by 58%.
5046

5147
## Literature
5248

‎api-doc/docfx.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
],
5454
"globalMetadata": {
5555
"_appTitle": "gfoidl.DataCompression",
56-
"_appFooter": "Copyright © Foidl Günther 2017-2020",
56+
"_appFooter": "Copyright © Foidl Günther 2017-2021",
5757
"_appLogoPath": "images/logo_32.png",
5858
"_appFaviconPath": "null"
5959
},

‎api-doc/index.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,10 @@
99

1010
See `./demos` for code.
1111

12+
_Note_: the graphs in the documentation are created by the code from `./demos`, so you can see which config-values got used.
13+
1214
![](./articles/images/demo_01.png)
1315

1416
![](./articles/images/demo_02.png)
1517

1618
![](./articles/images/demo_03.png)
17-
18-
## Development channel
19-
20-
To get packages from the development channel use a `nuget.config` similar to this one:
21-
```xml
22-
<?xml version="1.0" encoding="utf-8"?>
23-
<configuration>
24-
<packageSources>
25-
<add key="gfoidl-public" value="https://pkgs.dev.azure.com/gh-gfoidl/github-Projects/_packaging/gfoidl-public/nuget/v3/index.json" />
26-
</packageSources>
27-
</configuration>
28-
```

‎api-doc/toc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
- name: Algorithms
22
href: articles/
3+
34
- name: Api Documentation
45
href: api/
56
#homepage: api/index.md

‎source/Directory.Build.props‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</PropertyGroup>
99

1010
<PropertyGroup>
11-
<PackageProjectUrl>https://github.com/gfoidl/DataCompression</PackageProjectUrl>
11+
<PackageProjectUrl>https://gfoidl.github.io/DataCompression</PackageProjectUrl>
1212
<RepositoryUrl>https://github.com/gfoidl/DataCompression</RepositoryUrl>
1313
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1414
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>

0 commit comments

Comments
 (0)