Skip to content

Commit 67fa0be

Browse files
mdovgialomdovgialo
committed
#3 init polish help
1 parent a37a3ba commit 67fa0be

15 files changed

Lines changed: 813 additions & 0 deletions

‎svarog/src/main/resources/org/signalml/help/pl/artifact.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Artifact Help</title>
6+
</head>
7+
<body>
8+
9+
<p><a href="http://brain.fuw.edu.pl">(C) Department of Biomedical PhysicsInstitute of Experimental Physics, University of Warsaw</a></p>
10+
11+
<p><a href="http://www.cc.com.pl">Parts of this software were developed by: CC Otwarte Systemy Komputerowe</a></p>
12+
13+
<p><a href="contents.html">Contents</a></p>
14+
15+
</br><p><b><i>to edit this file search for signalml/src/org/signalml/help/artifact.html</i></b></p>
16+
17+
</body>
18+
</html>

‎svarog/src/main/resources/org/signalml/help/pl/bookReporter.html‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Stager Help</title>
6+
</head>
7+
<body>
8+
9+
<p><a href="http://brain.fuw.edu.pl">(C) Department of Biomedical PhysicsInstitute of Experimental Physics, University of Warsaw</a></p>
10+
11+
<p><a href="http://www.cc.com.pl">Parts of this software were developed by: CC Otwarte Systemy Komputerowe</a></p>
12+
13+
<p><a href="contents.html">Contents</a></p>
14+
15+
16+
<h2>Parameters</h2>
17+
18+
<p>
19+
<a name="rules">rules</a></br></br>
20+
<a name="deltaMinAmplitude">deltaMinAmplitude</a></br></br>
21+
<a name="alphaMinAmplitude">alphaMinAmplitude</a></br></br>
22+
<a name="spindleMinAmplitude">spindleMinAmplitude</a></br></br>
23+
<a name="primaryHypnogram">primaryHypnogram</a></br></br>
24+
<a name="parameters">parameters</a></br></br>
25+
<a name="emgToneThreshold">emgToneThreshold</a></br></br>
26+
<a name="mtEegThreshold">mtEegThreshold</a></br></br>
27+
<a name="mtEmgThreshold">mtEmgThreshold</a></br></br>
28+
<a name="mtToneEmgThreshold">mtToneEmgThreshold</a></br></br>
29+
<a name="remEogDeflectionThreshold">remEogDeflectionThreshold</a></br></br>
30+
<a name="semEogDeflectionThreshold">semEogDeflectionThreshold</a></br></br>
31+
</p>
32+
33+
</br><p><b><i>to edit this file search for signalml/src/org/signalml/help/stager.html</i></b></p>
34+
35+
36+
</body>
37+
</html>

‎svarog/src/main/resources/org/signalml/help/pl/contents.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>SVAROG VERSION</title>
6+
<style type="text/css">
7+
.red {
8+
color: #008;
9+
}
10+
</style>
11+
</head>
12+
<body><div>
13+
<h1><span class="red">SVAROG</span> VERSION</h1>
14+
<h2><span class="red">S</span>ignal <span class="red">V</span>iewer, <span class="red">A</span>nalyzer and <span class="red">R</span>ecorder <span class="red">O</span>n <span class="red">G</span>PL </h2>
15+
<h3>Project started at the <A HREF="http://www.uw.edu.pl">University of Warsaw</A>,
16+
<a href="http://www.fuw.edu.pl">Faculty of Physics</a>. <br>
17+
Since 2012 developed by <a href="http://braintech.pl">BrainTech</a> Sp. z o.o. [Ltd].</h3>
18+
19+
</div>
20+
<p>Svarog is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License v3 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a> for more details.</p>
21+
</body>
22+
</html>

‎svarog/src/main/resources/org/signalml/help/pl/decompMP5.html‎

Lines changed: 484 additions & 0 deletions
Large diffs are not rendered by default.

‎svarog/src/main/resources/org/signalml/help/pl/editTimeDomainSampleFilterDialog.html‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Edit time domain sample filter dialog</title>
6+
</head>
7+
<body><div><h1>Edit time domain filter dialog</h1>
8+
9+
<h2>Przegląd</h2>
10+
11+
<p>This file describes how to create and edit time domain sample filters using
12+
Edit time domain sample filter dialog.</p>
13+
14+
<h2>Specifying filter parameters</h2>
15+
16+
<p>To create or edit a filter, you need to specify the following parameters:</p>
17+
18+
<ul>
19+
<li><b>Filter type</b> - describes what type of filter you want to design.<br/>
20+
Possible values:
21+
<ul>
22+
<li>low-pass</li>
23+
<li>high-pass</li>
24+
<li>band-pass</li>
25+
<li>band-stop</li>
26+
</ul>
27+
<li><b>Filter family</b> - is the type of approximation
28+
function which will be used to design this filter.<br/>
29+
Possible values:
30+
<ul>
31+
<li>Butterworth</li>
32+
<li>Chebyshev I</li>
33+
<li>Chebyshev II</li>
34+
<li>Elliptic</li>
35+
</ul>
36+
<li><b>Passband edge frequency 1</b> - is the passband boundary frequency
37+
which separates the passband from the transition band.
38+
<li><b>Passband edge frequency 2</b> - if the filter is a bandpass or a bandstop
39+
filter, then there are two transition bands. In that case passband edge
40+
frequency 1 separates the passband from the first transition band (and
41+
its frequency is lower), and the second passband edge frequency separates
42+
the passband from the second transition band.
43+
<li><b>Stopband edge frequency 1</b> - is the edge frequency which is the
44+
boundary between the stopband and the transition band in the filter's
45+
frequency response.
46+
<li><b>Stopband edge frequency 2</b> - if the filter is bandpass or bandstop,
47+
then there are two transition bands. In that case stopband edge frequency 1
48+
separates the stopband from the first transition band (and its frequency is
49+
lower), and the second passband edge frequency separates the passband from the
50+
second transition band.
51+
<li><b>Passband ripple</b> - is the maximum frequency response fluctuations
52+
which is allowed in the passband. For all frequencies in the passband, their
53+
attenuation must be less or equal than the value set by this control.
54+
<li><b>Stopband attenuation</b> - the minimum attenuation in the stopband.
55+
For all frequencies in the stopband, their frequency response magnitude must be
56+
attenuated at least by the value set by this control.
57+
</ul>
58+
59+
<p>The image below presents a frequency response of a Chebyshev I high-pass filter.
60+
The filter was designed using the following parameters:
61+
62+
<ul>
63+
<li><b>Filter type</b> = high-pass</li>
64+
<li><b>Filter family</b> = Chebyshev I</li>
65+
<li><b>Passband edge frequency 1</b> = 20 Hz</li>
66+
<li><b>Stopband edge frequency 1</b> = 16 Hz</li>
67+
<li><b>Passband ripple</b> = 3 dB</li>
68+
<li><b>Stopband attenuation</b> = 40 dB</li>
69+
</ul>
70+
71+
<p>Please note that the frequency response shown fulfills the requirements given.
72+
For example - the stopband ends at 16 Hz and all frequencies in the stopband are
73+
attenuated by at least 40 dB. The passband begins at 20 Hz and all frequencies in
74+
the passband are attenuated - at most - by 3 dB.</p>
75+
76+
<img src="images/highpassFilterFrequencyResponse.png" alt="High-pass Chebyshev I
77+
filter, passband edge frequency 1 = 16 Hz, stopband edge frequency 1 = 20 Hz,
78+
passband ripple = 3 dB, stopband attenuation = 40dB"/>
79+
80+
<p>An analogous frequency response graph for a band-stop filter would have two
81+
passbands (first: from 0 Hz to passband edge frequency 1, second: begins at passband
82+
edge frequency 2), one stopband (from stopband edge frequency 1 to stopband edge
83+
frequency 2), and two transition bands. A frequency response graph for a band-pass
84+
filter will have two stopbands, one passband, and two transition bands</p>
85+
86+
<p><b>Important - the maximum frequency that can be set using the frequency
87+
controls is the Nyquist frequency which is equal to the half of the
88+
signal's sampling frequency.</b></p>
89+
90+
<h2>Drawing filter frequency response</h2>
91+
92+
<p>A filter frequency response is a graph showing the filter's output spectrum,
93+
that is - how much is each frequency's magnitude attenuated in the signal
94+
which passes through the filter</p>
95+
96+
<p>To draw the frequency response of the filter designed using the controls
97+
in the Filter parameters panel, press the "Draw filter frequency response"
98+
button.</p>
99+
100+
<p>If the filter parameters are correct, the filter frequency response is drawn.
101+
Otherwise, a dialog containing error message is shown.</p>
102+
103+
<h2>Error messages</h2>
104+
105+
<p>The most common error message says that the designed filter order is too big.
106+
This happens, when the filter parameters are too strict. The more strict the
107+
parameters are, the harder for the designer is to design a filter fulfilling
108+
the specification given. For example - it is very hard for the designer to
109+
design a filter having very narrow transition bands (a transition band is
110+
narrow when a passband edge frequency is very close to the corresponding
111+
stopband edge frequency), a very small value of ripple in the passband and
112+
having all of the frequencies in the stopband strongly attenuated.</p>
113+
114+
<p>If such an error shows up, please make the parameters less strict.</p>
115+
116+
<p>Another solution for that error is changing the Filter family of the filter.
117+
Filters approximated using the Chebyshev approximation functions tend to have
118+
smaller filter order comparing
119+
to Buttorworth filters having similar filter parameters. What's more, filters
120+
approximated using the Elliptic functions have smaller filter order
121+
comparing to a Chebyshev filter having similar parameters.</p>
122+
123+
</div>
124+
</body>
125+
</html>

‎svarog/src/main/resources/org/signalml/help/pl/images/MP_Decomposition_configuration.png‎

51.9 KB
Loading

‎svarog/src/main/resources/org/signalml/help/pl/images/Svarog_MP_book_zoom_select.png‎

192 KB
Loading

‎svarog/src/main/resources/org/signalml/help/pl/images/Svarog_MP_progress.png‎

140 KB
Loading

‎svarog/src/main/resources/org/signalml/help/pl/images/Svarog_choose_MP_executor.png‎

36.5 KB
Loading

‎svarog/src/main/resources/org/signalml/help/pl/images/Svarog_signal_selection_MP.png‎

175 KB
Loading

0 commit comments

Comments
 (0)